Overblik
Overblik
API Base fokuserer på den vigtigste betalingsstrøm: autentificering, kunder, kort / coverization og transaktioner. Sellers og Split har deres egne overflader, fordi de betjener platform og distribution operationer.
Genanvendelig identitet.
Opret køberen én gang og genbruge sammenhængen på nye betalingsforløb.
Opret og spore betalinger.
Pix, kort og boleto indtaster den samme transaktionscyklus som API.
Mindre eksponering.
Tilknyt betalingsinstrumenter med customer til tilbagevendende betalingsforløb og tilbagekøb.
Autentificering
Autentificering
Send en gyldig token til header Authorization og bruge JSON i integration nyttelast.
Eksempel på godkendelse
curl --request GET \ --url https://api.iopay.com.br/api/v1/customer/get/:customerId \ --header 'Authorization: Bearer seu_token' \ --header 'Content-Type: application/json'
Ambientes. Separat udviklings- / test- og produktionsidentitet. Vis ikke tokens i frontend, lager eller offentlige logfiler.
Hurtig start
Basisstrøm
Vælg miljøet og send Bearer token.
Du får et genanvendeligt ID til turen.
Opret Pix, kort eller boleto tilknyttet customer.
Brug ID og webhooks til at holde trit med ændringer.
Oprettelse af en customer
POST /api/v1/customer/new
curl --request POST \
--url https://api.iopay.com.br/api/customer/new \
--header 'Authorization: Bearer seu_token' \
--header 'Content-Type: application/json' \
--data '{
"name": "Maria Oliveira",
"email": "[email protected]",
"document": "12345678909",
"phone_number": "+5511999999999"
}'Oprettelse af Pix-transaktion
POST /api/v1/transaction/new/:CustomerID
curl --request POST \
--url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
--header 'Authorization: Bearer seu_token' \
--header 'Content-Type: application/json' \
--data '{
"amount": 12990,
"payment_method": "pix",
"reference_id": "order_102938"
}'Eksempler på integration. Hold ruter, felter og eksempler i synkronisering med den aktuelle implementering, før du posterer ændringer.
Kort over ressourcer
Funktioner
| Område | Anvendelse | Næste reference |
|---|---|---|
| Kunder | Registrer, tjek og identitet for betaleren. | Basis-API |
| Kort / liste | Instrumenter forbundet med customer og buy back. | Basis-API |
| Transaktioner | Skabelse, konsultation, indfangning og annullering. | Basis-API |
| Pix | Angrib, identifikation og statussporing. | Den grundlæggende API + webhooks |
| Boleto | Skabelse og cyklus af bankindsamling. | Den grundlæggende API + webhooks |
| Sellers | Platform / markedsplads deltagere. | Sellers API → |
| Split | Distribution mellem deltagere. | Split API |