転送API v2024-06-01ユースケースガイド
TransfersAPIを使用して支払い方法を取得し、支払いを開始する方法。
APIバージョン:2022-04-01
This guide describes how to use the Transfers API v2024-06-01 to retrieve the seller's payment methods and request a payout of an available balance for the given marketplace and account type.
転送 API とは何ですか?
Sellers can use the Transfers API v2024-06-01 to retrieve information about the payment methods associated with a seller and initiate payouts to a seller's deposit method on file.
チュートリアル 1: 出品者に関連する支払い方法の詳細を取得する
このチュートリアルでは、特定のマーケットプレイスに出品者が追加した支払い方法のリストを取得する方法を示します。
前提条件
このチュートリアルを正常に完了するには、次のものが必要です。
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
- Approval for the Finance and Accounting role in your developer profile.
- The Finance and Accounting role selected in the app registration page for your application.
ステップ 1:特定のマーケットプレイスの出品者に関連する支払い方法の詳細を取得する
Call the getPaymentMethods
operation with the following parameters:
クエリーパラメーター
名前 | 説明 | Schema | 必須 |
---|---|---|---|
marketplaceId | The identifier of the marketplace from which you want to retrieve payment methods. To find the ID for your marketplace, refer to Marketplace IDs. | string | はい |
paymentMethodTypes | レスポンスに含めたい支払い方法のタイプをコンマで区切ったリスト。 | < 文字列 >配列 | いいえ |
リクエストの例
GET /finances/transfers/2024-06-01/paymentMethods?marketplaceId=ATVPDKIKX0DER
GET /finances/transfers/2024-06-01/paymentMethods?marketplaceId=ATVPDKIKX0DER?paymentMethodTypes=BANK_ACCOUNT,CARD
レスポンス
名前 | 説明 | Schema |
---|---|---|
accountHolderName | 支払い方法に登録されている口座名義人の名前。 | string |
paymentMethodId | 支払い方法の識別子。 | string |
paymentMethodType | 支払い方法のタイプ。 | PaymentMethodType |
tail | 支払い方法の最後の3桁または4桁。 | string |
assignmentType | デフォルトの支払い方法タイプ。このフィールドは以下と同じです。 DEFAULT_DEPOSIT_METHOD 支払い方法がデフォルトの入金方法の場合。 | AssignmentType |
countryCode | The two-letter country code in ISO 3166-1 alpha-2 format. For payment methods in the CARD category, the code is for the country where the card was issued. For payment methods in the BANK_ACCOUNT category, the code is for the country where the account is located. | string |
expiryDate | 支払いに使用されたカードの有効期限。 | ExpiryDate |
レスポンスの例
{
"paymentMethods": [
{
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677",
"assignmentType": "DEFAULT_DEPOSIT_METHOD",
"countryCode": "UK"
},
{
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677",
"countryCode": "DE"
}
]
}
チュートリアル 2: 支払いを開始する
このチュートリアルでは、売り手の入金方法への支払いを開始する方法を示します。24 時間以内に開始できるオンデマンド支払いは、マーケットプレイスとアカウントタイプごとに 1 回だけです。
前提条件
このチュートリアルを正常に完了するには、次のものが必要です。
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
- Approval for the Finance and Accounting role in your developer profile.
- The Finance and Accounting role selected in the app registration page for your application.
ステップ 1:支払いを開始する
Call the initiatePayout
operation. The request is of type InitiatePayoutRequest
and includes the following parameters:
ボディのパラメーター
名前 | 説明 | Schema | 必須 |
---|---|---|---|
marketplaceId | A marketplace identifier. Only supported in the following marketplaces: ES, FR, BE, NL, DE, IT, SE, PL (refer to Marketplace IDs). | string | はい |
accountType | 選択したマーケットプレイスで支払いを開始する必要があるアカウントの種類。サポートされているEUマーケットプレイスでは、唯一の口座タイプはです。 Standard Orders 。 | string | はい |
リクエストの例
POST finances/transfers/2024-06-01/payouts/
{
"marketplaceId": "A1PA6795UKMFR9",
"accountType": "Standard Orders"
}
レスポンス
成功レスポンスには、以下が含まれます。
名前 | 説明 | Schema |
---|---|---|
payoutReferenceId | 支払い開始が成功すると、以下が含まれます。 payoutReferenceId 販売パートナーが支払い情報を追跡するために使用できます。これは、開始された支払いの金融イベントグループ ID です。 | string |
レスポンスの例
{
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3XXXXxx"
}
エラーレスポンス
失敗した応答には、支払いが開始されなかった理由を説明するエラーのリストが含まれます。
Error | 説明 | Schema |
---|---|---|
code required | 発生したエラーの種類を識別するエラーコード。 例: "InvalidInput" | string |
message required | エラー状態を人間が読める形式で説明するメッセージ。 例: "The input request had one or more invalid input parameters." | string |
details optional | 発信者が問題を理解または解決するのに役立つ追加情報。 例: "The following input parameters are invalid : [marketplaceId]." | string |
エラーレスポンスの例:
{
"errors": [
{
"code": "NoDepositMethod",
"message": "Deposit method is missing, invalid or not assigned."
},
{
"code": "InsufficientPayoutAmount",
"message": "Available balance is below the minimum allowed payout amount."
}
]
}
2か月前に更新されました