Zum Hauptinhalt springen
Verwenden Sie ein Kundenkonto, wenn dem Kunden der Endpunkt gehört. Verwenden Sie einen Empfänger und ein Ziel, wenn eine andere Person oder ein anderes Unternehmen die Gelder empfängt. Der Empfänger dokumentiert, wer Gelder empfängt. Das Ziel dokumentiert, wo sie sie empfangen.

1. Empfänger anlegen

Legen Sie eine Einzelperson oder ein Unternehmen mit POST /v3/customers/{customerId}/recipients an. Senden Sie diese Header:
Request headers
Request body
relationship beschreibt die Beziehung des Empfängers zu Ihrem Kunden. Wählen Sie einen Wert aus dem Request-Schema für POST /v3/customers/{customerId}/recipients. Senden Sie bei other kein zusätzliches Freitextfeld. Swipelux ignoriert Felder, die das Request-Schema nicht definiert, daher würde der Text nicht gespeichert. Fügen Sie die Adresse hinzu, bevor Sie ein Fiat-Ziel anlegen. Speichern Sie die zurückgegebene Empfänger-data.id als RECIPIENT_ID und behalten Sie ihren aktuellen Status.

2. Ein Ziel hinzufügen

Legen Sie den Endpunkt mit POST /v3/customers/{customerId}/recipients/{recipientId}/destinations an. Verwenden Sie einen neuen Schlüssel für dieses beabsichtigte Ziel:
Request headers
Pix- und Pix Safe-Ziele empfangen BRL und benötigen die bereite Pix-Fähigkeit des Kunden (pix_pooled). Ein Pix-Ziel zahlt an einen Pix-Schlüssel: eine CPF oder CNPJ nur aus Ziffern, eine Telefonnummer als +55 gefolgt von 10 oder 11 Ziffern, eine E-Mail-Adresse oder einen zufälligen Schlüssel. Ein Pix Safe-Ziel zahlt an ein brasilianisches Bankkonto, das über die CPF oder CNPJ des Inhabers in taxId, den 8-stelligen ISPB-Code der Bank in bankCode, die Filiale und die Kontonummer mit ihrer Prüfziffer identifiziert wird. Antworten und Webhooks geben taxId bis auf die letzten vier Ziffern maskiert zurück. Swipelux validiert Bankkennungen wie IBANs, BICs, ABA-Routing-Nummern sowie CPF- oder CNPJ-Nummern einschließlich Prüfsummen, wenn Sie ein Bankziel anlegen. Fehlerhafte Werte geben 400 validation_error zurück. Diese Prüfungen bestätigen nur das Format, nicht, dass das Konto existiert oder wem es gehört. Verwenden Sie self_custodied nur, wenn der Empfänger die Wallet kontrolliert. Folgen Sie der aktuellen API-Referenz-Variante, wenn die Wallet von einem anderen Verwahrer gehalten wird. Speichern Sie die zurückgegebene Ziel-data.id als DESTINATION_ID und behalten Sie ihren aktuellen Status.

3. Auf Zielbereitschaft warten

Lesen Sie GET /v3/customers/{customerId}/recipients/{recipientId}/destinations/{destinationId}, bevor Sie ein Quote erstellen. Fahren Sie nur fort, wenn der aktuelle Zielstatus den Payout erlaubt und seine Währung, Methode und Netzwerk mit der beabsichtigten Bewegung übereinstimmen. Empfänger- und Zielstatus sind unabhängig voneinander. Verwenden Sie die dst_-Ziel-ID im Payout-Quote. Die rcp_-Empfänger-ID identifiziert den Eigentümer-Datensatz und ist keine Quote-Ziel. Nehmen Sie als Nächstes das bereite Ziel zu Gelder senden.