Process PicPay Payments
https://api-sandbox.letpay.io/payment/MY_PAYMENT_TOKEN/sendPayment
Processes a PicPay payment order that were already created using the Create Payment Order
method.
Request Fields
method
(required/string): Payment method. Valid option:PICPAY
.expiration_date
(optional/date/YYYY-MM-DD): Expiration date (if not informed system will assume 2 days of current date).delay_capture
(optional/boolean):true
to pre-authorize payment for later capture. Default: false. Pre-auth capture/cancelation has a TTL of 5 days.
Response Fields
payment_token
(string): Token to identify this payment.refresh_token
(string): Updated access token for next calls.transaction_status
(string): Status of this payment.picpay_amount
(string): Amount of this payment.picpay_qr_code
(string): Base64 zipped PNG image representation of PicPay QR code.picpay_duedate
(string/date/YYYY-MM-DD): Expiration date of the payment.
AUTHORIZATION | API Key |
---|---|
Key | X-Auth-Token |
Value | MY_ACCESS_TOKEN |
Body Raw(json)
json
{
"method": "PICPAY",
"expiration_date": "2024-12-31",
"delay_capture": false
}
Example Request
- 200 - Success
- 401 - Unauthorized
- 502 - Bad Gateway
Example Request
200 - Success
curl --location 'https://api-sandbox.letpay.io/payment/MY_PAYMENT_TOKEN/sendPayment' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN' \
--data '{
"method": "PICPAY",
"expiration_date": "2024-12-31",
"delay_capture": false
}'
Example Response
Header
Content-Type: application/json
Body
{
"transaction_status": "PROCESSING",
"payment_token": "633de157-9a42-4d30-bbad-bd9fb883e058",
"picpay_qr_code": "BASE64_ZIPPED_PNG",
"picpay_duedate": "2024-12-31",
"picpay_amount": "1.00",
"refresh_token": "MY_ACCESS_TOKEN"
}
Example Request
401 - Unauthorized
curl --location 'https://api-sandbox.letpay.io/payment/MY_PAYMENT_TOKEN/sendPayment' \
--header 'X-Auth-Token: INVALID_ACCESS_TOKEN' \
--data '{
"method": "PICPAY",
"expiration_date": "2024-12-31",
"delay_capture": false
}'
Example Response
Header
Content-Type: application/json
Body
{
"timestamp": "2024-01-16T15:35:10.131+0000",
"status": 401,
"error": "Unauthorized",
"message": "Access Denied",
"path": "/payment/c6b2ff38-b53d-42dc-b11a-bce5cc05c253/sendPayment"
}
Example Request
502 - Bad Gateway
curl --location 'https://api-sandbox.letpay.io/payment/MY_PAYMENT_TOKEN/sendPayment' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN' \
--data '{
"method": "PICPAY",
"expiration_date": "2024-12-31",
"delay_capture": false
}'
Example Response
Header
Content-Type: application/json
Body
{
"timestamp": "2024-01-16T20:12:28.156+0000",
"status": 502,
"error": "Bad Gateway",
"message": "There was an issue when contacting an external API, please contact support",
"path": "/payment/2f1c0103-b6fe-4e99-864c-d20c68b97a85/sendPayment",
"errors": [
{
"code": "00.03.0001",
"description": "There was an issue when contacting an external API, please contact support"
}
],
"refresh_token": "MY_ACCESS_TOKEN"
}