支払ステータス更新（ABS）

OpenAPI説明

当該OpenAPIは、支払ステータスを更新する際に利用します。

OpenAPI権限

当該OpenAPIはB2B専用のトークン権限が必要です。

リクエストURI

/api/openapi/btob/abs/payment/batch/status

リクエスト形式

PUT

リクエスト例

{
  "tenantId": "1214732595705114600",
  "resolveType": 1,
  "transactionList": [
    {
      "transactionId": "4561232798100",
      "paymentStatus": "02",
      "transactionStatusCode": "010401",
      "transactionStatusName": "確定エラー",
      "transactionErrorInfo": [
        {
          "errorCode": "1001",
          "errorMessage": "エラーメッセージ1"
        },
        {
          "errorCode": "1002",
          "errorMessage": "エラーメッセージ2"
        }
      ],
      "paymentBatchList": [
        {
          "paymentBatchNumber": "20240613011680858022123830661",
          "transferCommission": 330,
          "commissionByOtherParty": 500,
          "detailErrorInfo": [
            {
              "errorCode": "1001100",
              "errorMessage": "エラーメッセージ3"
            },
            {
              "errorCode": "1001101",
              "errorMessage": "エラーメッセージ4"
            }
          ]
        },
        {
          "paymentBatchNumber": "20240103081680858022123815462",
          "transferCommission": 330,
          "commissionByOtherParty": 0,
          "detailErrorInfo": [
            {
              "errorCode": "1001102",
              "errorMessage": "エラーメッセージ5"
            }
          ]
        }

      ]
    },
    {
      "transactionId": "4561232798101",
      "paymentStatus": "02",
      "transactionStatusCode": "010401",
      "transactionStatusName": "確定エラー",
      "transactionErrorInfo": [
        {
          "errorCode": "1001",
          "errorMessage": "エラーメッセージ1"
        },
        {
          "errorCode": "1002",
          "errorMessage": "エラーメッセージ2"
        }
      ],
      "paymentBatchList": [
        {
          "paymentBatchNumber": "20240613011680858022123830663",
          "transferCommission": 330,
          "commissionByOtherParty": 0,
          "detailErrorInfo": [
            {
              "errorCode": "1001100",
              "errorMessage": "エラーメッセージ3"
            },
            {
              "errorCode": "1001101",
              "errorMessage": "エラーメッセージ4"
            }
          ]
        },
        {
          "paymentBatchNumber": "20240103081680858022123815464",
          "transferCommission": 330,
          "commissionByOtherParty": 0,
          "detailErrorInfo": [
            {
              "errorCode": "1001102",
              "errorMessage": "エラーメッセージ5"
            }
          ]
        }
      ]
    }
  ]
}

リクエスト項目

項目	タイプ	必須	キー	制限	説明
tenantId	String	◯		最大19文字	テナントID
resolveType	int	◯			処理区分 1:依頼データ登録 2:依頼データ照会
transactionList	transactionDTO[]	◯			取引データ情報

transactionDTO

項目	タイプ	必須	キー	制限	説明
transactionId	String			最大22文字	取引ID
paymentStatus	String	◯			支払結果 01:受付成功 02:受付失敗 03:支払成功 04:支払失敗 05:キャンセル完了 06:支払承認待ち 07:支払承認完了 08:照会不可 09:トークン無効
transactionStatusCode	String			最大6文字	取引状態 ABSで管理している取引状態コード
transactionStatusName	String			最大20文字	取引状態名称 ABSで管理している取引状態名称
transactionErrorInfo	errorInfo[]				取引エラー内容
paymentBatchList	paymentBatchDTO[]	◯			支払一括処理番号リスト

paymentBatchDTO

項目	タイプ	必須	キー	制限	説明
paymentBatchNumber	String	◯		最大33文字	支払一括処理番号
transferCommission	Number			最大5桁	自社手数料
commissionByOtherParty	Number			最大5桁	他社手数料
detailErrorInfo	errorInfo[]				明細エラー内容

errorInfo

項目	タイプ	必須	キー	制限	説明
errorCode	String			最大10文字	エラーコード
errorMessage	String			最大2048文字	エラー内容

OpenAPIリターン例

成功例

{
  "message": "成功",
  "errorCode": "0000"
}

失敗例

{
  "message": "パラメータ:tenantIdは指定必須の項目です",
  "errorCode": "120003"
}

項目説明

項目	タイプ	説明
message	String	エラーメッセージ
errorCode	String	エラーコード

エラーコード説明

errorCode	message	説明
120003	パラメータ:{0}は指定必須の項目です
0013	パラメータ:{0}は{1}文字以内で指定してください
spd.32874.001	{0}:{1} は存在しません
spd.32874.002	更新対象の支払データのステータスは操作不可です
spd.32874.003	{0}を100,000未満にしてください