Dokumentation
Entwickler-HubAPI-StatusUnterstützung

Transfers-API v2024-06-01 — Anwendungsfallleitfaden

So rufen Sie Zahlungsmethoden ab und initiieren Auszahlungen mithilfe der Transfers-API.

API-Version: v2020-07-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.

Was ist die Transfers-API?

Verkäufer können die verwenden Überträgt API v2024-06-01 um Informationen über die einem Verkäufer zugewiesenen Zahlungsmethoden abzurufen und Auszahlungen an die hinterlegte Einzahlungsmethode des Verkäufers zu veranlassen.

Tutorial 1: Informationen zur Zahlungsmethode abrufen, die einem Verkäufer zugeordnet sind

Dieses Tutorial zeigt, wie Sie die Liste der Zahlungsmethoden abrufen, die der Verkäufer für eine bestimmte Marketplace-Site hinzugefügt hat.

Voraussetzungen

Um dieses Tutorial erfolgreich abzuschließen, benötigen Sie:

Schritt 1. Rufen Sie Einzelheiten zu den Zahlungsmethoden ab, die einem Verkäufer auf einem bestimmten Marktplatz zugeordnet sind

Rufen Sie den Vorgang getPaymentMethods mit den folgenden Parametern auf:

Parameter abfragen

NameBeschreibungSchemaErforderlich
marketplaceIdDie ID der Marketplace-Site, von der Sie die Zahlungsmethoden abrufen möchten. Die ID für Ihre Marketplace-Site finden Sie unter Marktplatz-IDs.stringJa
paymentMethodTypesEine durch Kommas getrennte Liste der Zahlungsmethoden, die Sie in die Antwort aufnehmen möchten.< Schnur > ReiheNein
Beispiele für Anfragen
GET /finances/transfers/2024-06-01/paymentMethods?marketplaceId=ATVPDKIKX0DER GET /finances/transfers/2024-06-01/paymentMethods?marketplaceId=ATVPDKIKX0DER?paymentMethodTypes=BANK_ACCOUNT,CARD
Antwort
NameBeschreibungSchema
accountHolderNameDer Name des Kontoinhabers, der für die Zahlungsmethode registriert ist.string
paymentMethodIdDie Kennung der Zahlungsmethode.string
paymentMethodTypeDie Art der Zahlungsmethode.PaymentMethodType
tailDie letzten drei oder vier Ziffern der Zahlungsmethode.string
assignmentTypeDie Standardart der Zahlungsmethode. Dieses Feld entspricht DEFAULT_DEPOSIT_METHOD wenn die Zahlungsmethode Ihre Standard-Einzahlungsmethode ist.AssignmentType
countryCodeDie zweibuchstabige Landesvorwahl in ISO 3166-1 Alpha-2 formatieren. Für Zahlungsmethoden in der CARD Kategorie, der Code bezieht sich auf das Land, in dem die Karte ausgestellt wurde. Für Zahlungsmethoden in der BANK_ACCOUNT Kategorie, der Code ist für das Land, in dem sich das Konto befindet.string
expiryDateDas Ablaufdatum einer Karte, die für Auszahlungen verwendet wird.ExpiryDate
Beispiel für eine Antwort
{ "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" } ] }

Tutorial 2: Eine Auszahlung einleiten

Dieses Tutorial zeigt, wie Sie eine Auszahlung über die Einzahlungsmethode des Verkäufers veranlassen. Innerhalb von 24 Stunden kann für jede Marketplace-Site und jeden Kontotyp nur eine On-Demand-Auszahlung veranlasst werden.

Voraussetzungen

Um dieses Tutorial erfolgreich abzuschließen, benötigen Sie:

Schritt 1. Initiieren Sie eine Auszahlung

Rufen Sie den initiatePayout Betrieb. Die Anfrage ist vom Typ InitiatePayoutRequest und beinhaltet die folgenden Parameter:

Textparameter

NameBeschreibungSchemaErforderlich
marketplaceIdEine Marktplatz-ID. Wird nur auf den folgenden Marktplätzen unterstützt: ES, FR, BE, NL, DE, IT, SE, PL (siehe Marktplatz-IDs).stringJa
accountTypeDer Kontotyp auf dem ausgewählten Marktplatz, für den eine Auszahlung veranlasst werden muss. Für die unterstützten EU-Marktplätze ist der einzige Kontotyp Standard Orders.stringJa

Beispiel anfordern

POST finances/transfers/2024-06-01/payouts/ { "marketplaceId": "A1PA6795UKMFR9", "accountType": "Standard Orders" }

Antwort

Eine erfolgreiche Antwort umfasst Folgendes:

NameBeschreibungSchema
payoutReferenceIdEin erfolgreiches Ergebnis der Auszahlungsinitiierung beinhaltet eine payoutReferenceId das kann von Vertriebspartnern verwendet werden, um Auszahlungsinformationen zu verfolgen. Es handelt sich um die Gruppen-ID für ein Finanzereignis, das für eine initiierte Auszahlung verwendet wird.string

Beispiel für eine Antwort

{ "payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3XXXXxx" }

Fehlermeldung

Eine erfolglose Antwort enthält eine Liste von Fehlern, in denen die Gründe beschrieben werden, warum eine Auszahlung nicht initiiert wird.

FehlerBeschreibungSchema
code
required
Ein Fehlercode, der die Art des aufgetretenen Fehlers identifiziert.
Beispiel: "InvalidInput"
string
message
required
Eine Meldung, die den Fehlerzustand in einer für Menschen lesbaren Form beschreibt.
Beispiel: "The input request had one or more invalid input parameters."
string
details
optional
Zusätzliche Informationen, die dem Anrufer helfen können, das Problem zu verstehen oder zu beheben.
Beispiel: "The following input parameters are invalid : [marketplaceId]."
string

Beispiel für eine Fehlerantwort:

{ "errors": [ { "code": "NoDepositMethod", "message": "Deposit method is missing, invalid or not assigned." }, { "code": "InsufficientPayoutAmount", "message": "Available balance is below the minimum allowed payout amount." } ] }

Hat Ihnen diese Seite weitergeholfen?