PicPay
Call the PicPay API to request payments via PicPay.
POST /v2/payin
Request
Parameters details
Parameter | Type | Required | Description |
---|---|---|---|
|
| yes | Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer |
|
| yes | The full name of the customer making the payment. It should match the name on the customer's identification documents |
|
| yes | The email address of the customer. This will be used for sending payment confirmations and notifications |
|
| no | The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. https://www.twilio.com/docs/glossary/what-e164 |
|
| no | The birthdate of the customer, provided in the format |
|
| yes | The official identification number of the customer. This is typically a national ID, or other government-issued document |
|
| yes | The type of document provided by the customer. Common types include national ID, or driver's license. List of documents allowed. Default: CPF |
|
| no | The primary street address of the customer |
|
| no | Additional address information, such as apartment number or suite |
|
| no | The city in which the customer resides |
|
| no | The ISO 3166-1 alpha-3 country code for the customer's address. List of country codes. |
|
| no | The neighborhood or district of the customer's address |
|
| no | The street number of the address |
|
| no | The postal or ZIP code for the customer's address |
|
| no | The state or region of the customer's address |
|
| yes | A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process |
|
| yes | The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). List of currency codes Default: BRL |
|
| yes | The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)
|
|
| no | The time in seconds until the transaction expires and is no longer valid |
|
| no | The specific branch or location identifier where the transaction is being processed, if applicable |
|
| yes | The country code where the transaction is taking place. The format is |
|
| yes | The method of payment being used for the transaction, such as bank transfer, credit card... |
|
| yes | The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format |
Response
Important
This payment method is different from the PIX
PicPay does not have copy and paste
Need the PicPay app installed
Use
payment > url
to open PicPay checkout
Response details following the link: overview
Last updated