PicPay
Call the PicPay API to request payments via PicPay Pix.
POST /v1/picpay
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 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. |
Response
Important
This payment method is different from the PIX
PicPay does not have copy and paste
Need the PicPay app installed
Use
picpay > url
to open PicPay checkout
Response details
Parameter | Description |
---|---|
| The created payment by the request made 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: |
| |
| picpay |
| |
| 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 |
| Limit date to receive the payment |
| |
| String to open PicPay checkout. |
Last updated