PicPay
Introduction
PicPay is a digital wallet that offers a user-friendly way to make transactions, pay bills, and transfer money right from your phone. It operates everyday, offering a secure platform for sending money, making payments, receiving funds, businesses, and for services.
Getting Started
Generate Order
Creating a PicPay REDIRECT order:
POST /api/v1/checkout/form
Host: latamgateway.com
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"
{
"order":{
"code":"123", # Order reference in your system (required)
"notification_url":"https://yoursystem.com/postback/", # Where we'll notify when status changes (required)
"redirect_url":"https://yoursystem.com/finish_checkout?auto_redirect=true", # If filled, at the end of checkout we'll automatic redirect to that page (optional)
"value":50.00, # (required)
"additional_info":"A description of your order, as a string", # (required)
"payment_method":"picpay" # (required)
}
}
The response will be:
{
"form_id": "dbcedec8-f587-4203-8aa4-a74da83fb32a", # Order reference in our system. You should save that.
"url": "https://latamgateway.com/checkout/payment/dbcedec8-f587-4203-8aa4-a74da83fb32a" # Form URL, redirect your customer to here
}
Reverse Order
To reverse the order:
POST /api/v1/order/{order_id}/reverse
Host: latamgateway.com
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"
If your request is successful, you will receive a response to the following:
{
"message": "message": "Refund requested. Waiting for confirmation from the bank."
}
Business errors are returned with a 400 status code. The response will be:
{
"message": "Only PIX and PicPay transactions can be refunded."
}