Create Payment
POSTDescription: Endpoint that processes a payment./v1/payments
Request
Header Parameters
The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
Possible values: [pt-BR
, en-US
]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.
- application/json
Body
required
Possible values: [DEBIT
, CREDIT
]
Payment method used.
Payment amount in cents.
Possible values: [BRL
, USD
]
Three-letter code of the payment currency.
Buyer name.
Buyer email address.
Buyer phone number.
Buyer document.
Possible values: [CPF
, CNPJ
]
Buyer document type.
Number of installments for the payment.
payment_card object
buyer_address object
Responses
- 200
- 400
- 401
- 422
Payment created successfully.
- application/json
- Schema
- Example (from schema)
Schema
Payment ID.
Possible values: [PENDING
, AUTHORIZED
, REVERTED
, CANCELLED
, SETTLED
]
Payment status.
Payment creation date.
Payment update date.
{
"id": "b28163ec-3d28-4786-a154-7a28ab3600a6",
"status": "AUTHORIZED",
"created_at": "2025-06-09T21:03:58.071Z",
"updated_at": "2025-06-09T21:03:58.071Z"
}
If any required params are missing or has invalid format or type.
User authentication failed.
If any required params are missing or has invalid format or type.
Authorization: http
name: bearertype: httpscheme: bearerbearerFormat: JWT
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X POST 'https://docs.zrobank.io/v1/payments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"payment_method": "CREDIT",
"amount_total": 10000,
"currency_tag": "BRL",
"buyer_name": "John Doe",
"buyer_email": "john.doe@zrobank.com",
"buyer_phone": "+5511999999999",
"buyer_document": "12345678901",
"buyer_document_type": "CPF",
"installments": 1,
"payment_card": {
"card_number": "1234567890123456",
"card_cvv": "123",
"card_name": "John Doe",
"card_expiry_date": "04-2025"
},
"buyer_address": {
"zip_code": "0975858",
"street": "Alameda",
"number": 10,
"neighborhood": "Alphaville",
"city": "São Paulo",
"federative_unit": "SP",
"country": "Brasil",
"complement": "flat 1201"
}
}'