Przegląd
Sellers API jest przeznaczone dla autoryzowanych partnerów, którzy muszą rejestrować i zarządzać sellerami-klientami w IOPAY. Integracja pozwala tworzyć sellerów będących osobami fizycznymi lub prawnymi i używać zwróconego io_seller_id w pozostałych operacjach API.
IO Seller ID.
Każdy seller otrzymuje io_seller_id, który należy zapisać i używać w kolejnych operacjach.
Osoba fizyczna lub prawna.
Istnieją osobne przepływy rejestracji sellerów indywidualnych i firm.
Powiązany rachunek bankowy.
Aby otrzymywać wypłaty, seller musi mieć powiązany rachunek bankowy tego samego właściciela.
Przepływ sellera
Wyślij dane osoby fizycznej lub prawnej do Sellers API.
Zapisz io_seller_id zwrócony przez IOPAY.
Zarejestruj rachunek bankowy tego samego właściciela i powiąż token z sellerem.
Seller może wtedy uczestniczyć w zgodnych przepływach platformy.
Rejestracja
| Metoda | Endpoint | Zastosowanie |
|---|---|---|
POST | /v1/sellers/create/individuals | Utwórz sellera (osoba fizyczna). |
POST | /v1/sellers/create/businesses | Utwórz sellera (osoba prawna). |
PATCH | /v1/sellers/update/individuals/:IO_SELLER_ID | Zaktualizuj sellera (osoba fizyczna). |
PATCH | /v1/sellers/update/businesses/:IO_SELLER_ID | Zaktualizuj sellera (osoba prawna). |
GET | /v1/sellers/mcc_list | Pobierz dostępne MCC. |
Utwórz sellera · Osoba fizyczna
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 zwrócony przez IOPAY. Identyfikuje on sellera w późniejszych operacjach.Utwórz sellera · Osoba prawna
{
"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"
}
}Włączanie wpływów
Aby umożliwić wypłaty dla sellera, najpierw tokenizuj rachunek bankowy, a następnie powiąż zwrócony token z sellerem. Rachunek bankowy musi należeć do tego samego właściciela co seller.
Wyślij bank, oddział, rachunek, właściciela i typ rachunku.
IOPAY zamienia dane bankowe w bezpieczny token.
Powiąż uzyskany token z io_seller_id.
Powiązany rachunek może być używany w zgodnych przepływach przelewów.
Tokenizuj rachunek bankowy
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"
}'Pole type przyjmuje checking dla rachunku bieżącego lub savings dla oszczędnościowego.
Powiąż token z sellerem
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>"
}'Zasady operacyjne
- Sellers API musi być udostępnione i autoryzowane przez IOPAY dla integracji.
- Używaj uwierzytelniania Bearer w chronionych operacjach.
- Zapisz
io_seller_idzwrócony przy rejestracji. - Zweryfikuj typ sellera przed użyciem endpointów specyficznych dla osoby fizycznej lub prawnej.
- Powiąż rachunek bankowy tego samego właściciela, zanim zaczniesz polegać na wypłatach.
Oficjalna kolekcja
Skorzystaj z pełnej kolekcji Sellers API w Postmanie, aby uzyskać dostęp do wszystkich endpointów, przykładów żądań i dostępnych odpowiedzi.
Otwórz kolekcję w Postmanie ↗