Payments
Call the Payments API to request payments via Bank Transfer or PIX.
POST /v1/payment
Request
Parameters details
Parameter | Type | Required | Description |
---|---|---|---|
|
| yes | The customer id stored on your platform for future identification. |
|
| no | When the merchant needs to keep track of its various offices / branch, this field must be fill. |
|
| yes | Name of the customer who started the transaction. |
|
| yes | Email of the customer who started the transaction. |
|
| yes | Brazilian document (CPF) of the customer who started the transaction.
- Must be a valid CPF document;
|
|
| yes | The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)
|
|
| no | The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion. This parameter is optional, if currency isn't provided it will auto-select USD. Default: USD |
|
| yes | The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned. |
|
| yes | The URL in you site that our API will notify when the payment changes the status, the HTTP supported method should be HTTP
|
| |||
|
| yes | The id of the transaction generated in you platform. |
| |||
|
| no | Lifetime of the charge, specified in seconds from the creation date, so that the charge payment can be made. If not informed, the duration is assumed to be 1800 seconds, which corresponds to 30 minutes. |
Response (PIX)
Response (Bank Transfer)
Response details
Parameter | Description |
---|---|
| The created payment by the request made a unique identificator. Can be used to verify the payment status in the GET /v1/payment/{id} endpoint |
| The current status of the payment. These are our statuses: |
| |
| The payment method chosen. |
| |
| The full value of the transaction, including service fees. Decimal separator it a dot |
| The value of the transaction, without service fees. Decimal separator it a dot |
| The exchange rate applied to the current transaction |
| The service fee value |
| |
| Name of the bank where the deposit is going to be made |
| Brazilian code of the bank to which the deposit is going to be directed |
| Agency number with verification digit to which the deposit is going to be directed |
| Account number with verification digit to which the deposit is going to be directed |
| Either it's a savings account or a current account. |
| Either the owner document or the company document for the account to which the deposit is going to be directed |
| Name of the owner of the account to which the deposit is going to be direct |
| |
| String that contains the information of the qrcode. It is necessary to use some programming resource to convert this text into an image. |
| String that contains the information of the copy and paste pix (pix copia e cola). |
| Name of the owner of the account to which the deposit is going to be direct |
GET /v1/payment/{id}
Request
Response
Response details
Parameter | Description |
---|---|
| The created payment by the request made unique identificator. |
| The customer id stored on your platform for future identification. |
| The id of the transaction generated in you platform. |
| The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma) |
| The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion. |
| The current status of the payment. These are our statuses: |
| The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned. |
| The date and time the transaction was created. |
| The date and time the transaction was updated with new status. |
GET /v1/payments
Request
Parameters detail
Parameter | Type | Description |
---|---|---|
|
| The number of items to return in the response. |
|
| The page number indicating which set of items will be returned in the response. So, the combination of |
|
| Sorts the items in the response by filter in ascending or descending order.
Eg.: |
|
| The start date and time for the range to show in the response, in Internet date and time format.
Eg.: |
|
| The end date and time for the range to show in the response, in Internet date and time format.
Eg.: |
|
| Sorts the items in the response by looking for the customer_id that was once provided by your system. |
|
| Sorts the items in the response by looking for the transaction_id that was once provided by your system.
To get multiple transaction_id, send each transaction_id separating by comma (,).
Eg.: |
Response
Response details
Parameter | Description |
---|---|
| The created payment by the request made unique identificator. |
| The customer id stored on your platform for future identification. |
| The id of the transaction generated in you platform. |
| The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma) |
| The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion. |
| The current status of the payment. These are our statuses: |
| The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned. |
| The date and time the transaction was created. |
| The date and time the transaction was updated with new status. |
Last updated