Überblick
Die Sellers API richtet sich an autorisierte Partner, die Kunden-Seller in IOPAY registrieren und verwalten müssen. Die Integration ermöglicht es, Seller als natürliche oder juristische Person anzulegen und die zurückgegebene io_seller_id in den übrigen API-Vorgängen zu verwenden.
IO Seller ID.
Jeder Seller erhält eine io_seller_id, die gespeichert und in den nächsten Vorgängen verwendet werden muss.
Natürliche oder juristische Person.
Es gibt spezifische Abläufe für die Registrierung von Einzel-Sellern und Unternehmen.
Verknüpftes Bankkonto.
Um Payouts zu erhalten, muss der Seller ein verknüpftes Bankkonto desselben Inhabers haben.
Seller-Ablauf
Senden Sie die Daten der natürlichen oder juristischen Person an die Sellers API.
Speichern Sie die von IOPAY zurückgegebene io_seller_id.
Registrieren Sie ein Bankkonto desselben Inhabers und ordnen Sie das Token dem Seller zu.
Der Seller kann dann an den kompatiblen Abläufen der Plattform teilnehmen.
Registrierung
| Methode | Endpunkt | Verwendung |
|---|---|---|
POST | /v1/sellers/create/individuals | Seller (natürliche Person) anlegen. |
POST | /v1/sellers/create/businesses | Seller (juristische Person) anlegen. |
PATCH | /v1/sellers/update/individuals/:IO_SELLER_ID | Seller (natürliche Person) aktualisieren. |
PATCH | /v1/sellers/update/businesses/:IO_SELLER_ID | Seller (juristische Person) aktualisieren. |
GET | /v1/sellers/mcc_list | Verfügbare MCCs abfragen. |
Seller anlegen · Natürliche Person
curl --request POST \
--url https://api.iopay.com.br/api/v1/sellers/create/individuals \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"send_welcome_email": true,
"mcc": 5499,
"first_name": "André",
"last_name": "Silva",
"email": "[email protected]",
"revenue": 4500,
"phone_number": "(11)999999999",
"cpf": "12345678909",
"birthdate": "2000-01-01",
"statement_descriptor": "LOJA ANDRE",
"address": {
"line1": "Av Paulista",
"line2": "1000",
"line3": "Sala 10",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zip_code": "01310100",
"country_code": "BR"
}
}'io_seller_id. Sie identifiziert den Seller in späteren Vorgängen.Seller anlegen · Juristische Person
{
"mcc": 5499,
"statement_descriptor": "LOJA EXEMPLO",
"revenue": 250000,
"business": {
"name": "Empresa Exemplo LTDA",
"email": "[email protected]",
"phone_number": "(11)999999999",
"cnpj": "12345678000190",
"opening_date": "2020-01-01",
"website": "https://exemplo.com.br"
},
"owner": {
"first_name": "André",
"last_name": "Silva",
"email": "[email protected]",
"phone_number": "(11)999999999",
"cpf": "12345678909",
"birthdate": "1990-01-01"
},
"business_address": {
"line1": "Av Paulista",
"line2": "1000",
"line3": "Sala 10",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zip_code": "01310-100",
"country_code": "BR"
},
"owner_address": {
"line1": "Rua Exemplo",
"line2": "100",
"line3": "Apto 10",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"zip_code": "01000-000",
"country_code": "BR"
}
}Zahlungseingänge aktivieren
Um Payouts an den Seller zu ermöglichen, tokenisieren Sie zuerst ein Bankkonto und ordnen dann das zurückgegebene Token dem Seller zu. Das Bankkonto muss demselben Inhaber gehören wie der Seller.
Senden Sie Bank, Filiale, Konto, Inhaber und Kontotyp.
IOPAY wandelt die Bankdaten in ein sicheres Token um.
Ordnen Sie das erhaltene Token der io_seller_id zu.
Das verknüpfte Konto kann in kompatiblen Überweisungsabläufen genutzt werden.
Bankkonto tokenisieren
curl --request POST \
--url https://api.iopay.com.br/api/v1/sellers/bank_accounts/tokenize/:IO_SELLER_ID/:ID_DEV \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"holder_name": "ANDRE SILVA",
"bank_code": "341",
"routing_number": "0700",
"account_number": "81929922",
"ein": null,
"taxpayer_id": "12345678909",
"type": "checking"
}'Das Feld type akzeptiert checking für Girokonto oder savings für Sparkonto.
Token mit dem Seller verknüpfen
curl --request POST \
--url https://api.iopay.com.br/api/v1/sellers/bank_accounts/associate_bank_account/:ID_DEV \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"io_seller_id": "<IO_SELLER_ID>",
"token": "<BANK_ACCOUNT_TOKEN>"
}'Betriebsregeln
- Die Sellers API muss von IOPAY für die Integration freigegeben und autorisiert sein.
- Verwenden Sie Bearer-Authentifizierung bei geschützten Vorgängen.
- Speichern Sie die bei der Registrierung zurückgegebene
io_seller_id. - Prüfen Sie den Seller-Typ, bevor Sie spezifische Endpunkte für natürliche oder juristische Personen verwenden.
- Verknüpfen Sie ein Bankkonto desselben Inhabers, bevor Sie auf Payouts angewiesen sind.
Offizielle Collection
Nutzen Sie die vollständige Sellers-API-Collection in Postman, um auf alle Endpunkte, Request-Beispiele und verfügbaren Antworten zuzugreifen.
Collection in Postman öffnen ↗