PIX
Call the Payments API to request payments via PIX.
POST /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;
|
|
| no | Allowed document types: CPF, CNPJ. |
|
| 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 pix is provided, we will return pix information for deposit. |
|
| 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
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 /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 |
| |
| 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 |
Last updated