Skip to main content

PicPay

  POST https://api-sandbox.letpay.io/picpay/simple

Overview​

PicPay is a widely-used digital wallet and payment ecosystem in Brazil that allows customers to pay for online and in-store purchases through its app. The e-commerce transaction flow typically involves selecting PicPay at checkout, which generates a QR code on the screen. The customer then uses the "Scan QR Code" function in their PicPay app to scan the code and confirm the payment, using their account balance or a registered credit card. For merchants, offering PicPay means gaining access to millions of active users and benefiting from instant payment confirmation. Transactions are secure and, once approved, are settled directly into the merchant's account, simplifying cash flow and reconciliation.

Reference Checkout UI PicPay

Reference UI - PicPay - Part 1Reference UI - PicPay - Part 1

PicPay Generated​

Reference UI - PicPay - Part 2Reference UI - PicPay - Part 2

Minimum and Maximum Amounts​

CountryMinimumMaximumCurrency
Brazil0.0110,000BRL

PicPay Flow​

Request Description​

This HTTP POST request is used to create a PicPay payment using the provided payload in the raw request body. The request payload includes the following fields:

  • contract_id (required/string): Merchant's contract id.
  • reference_id (required/string/max 45 chars): External code created by the merchant to reference this payment (e.g. order number).
  • notification_url (required/string): URL to post callbacks to this payment.
  • ip_address (optional/string): Remote IP Address(IPv4/IPv6).
  • payment (required/object): The payment data:
    • amount (required/float): Total amount of the payment. Value must have a maximum of two decimal places.
    • asset (optional/string): Reference code for asset for the sale's amount. Default: BRL.
    • delay_capture (optional/boolean): true to pre-authorize payment for later capture. Default: false. Pre-auth capture/cancelation has a TTL of 5 days.
    • currency (required/string): Currency code in ISO-4217. Valid option: BRL.
    • country (required/string): Country code in ISO 3166-2. Valid option: BR.
    • picpay (optional/object): The PicPay data:
      • expiration_date (optional/date/YYYY-MM-DD): Expiration date (if not informed system will assume 2 days of current date).
  • person (optional/object): The person data:
    • full_name (optional/string): Person’s full name.
    • email (optional/string): Person’s email provided to the merchant.
    • tax_id (required/string): Unique identifier for this person in country tax system (e.g. in Brazil: CPF).
    • birth_date (optional/date/YYYY-MM-DD): Person’s date of birth.

Authorization​

AUTHORIZATIONAPI Key
KeyX-Auth-Token
ValueMY_ACCESS_TOKEN

Body Raw(json)​

json
{
    "contract_id": "MY_CONTRACT_ID",
    "reference_id": "MY_REFERENCE_ID",
    "notification_url": "https://my.notification.url/callback/",
    "ip_address": "0.0.0.0",
    "payment": {
        "amount": 123.45,
        "asset": "BRL",
        "delay_capture": false,
        "currency": "BRL",
        "country": "BR",
        "picpay": {
            "expiration_date": "2024-12-31"
        }
    },
    "person": {
        "full_name": "Alice Sonnentag",
        "email": "[email protected]",
        "tax_id": "39784045087"
    },
    "extra_data": {
        "my-conciliation-number": "xxxxxx"
    }
}

Example Request​

Example Request​

200 - Success
    curl --location 'https://api-sandbox.letpay.io/picpay/simple' \
    --header 'X-Auth-Token: MY_ACCESS_TOKEN' \
    --data-raw '{
        "contract_id": "MY_CONTRACT_ID",
        "reference_id": "MY_REFERENCE_ID",
        "notification_url": "https://my.notification.url/callback/",
        "ip_address": "0.0.0.0",
        "payment": {
            "amount": 123.45,
            "asset": "BRL",
            "delay_capture": false,
            "currency": "BRL",
            "country": "BR",
            "picpay": {
                "expiration_date": "2024-12-31"
            }
        },
        "person": {
            "full_name": "Alice Sonnentag",
            "email": "[email protected]",
            "tax_id": "39784045087"
        },
        "extra_data": {
            "my-conciliation-number": "xxxxxx"
        }
    }'

Example Response​

Header
  Content-Type: application/json
Body
    {
      "transaction_status": "PROCESSING",
      "payment_token": "0196e128-c6c7-4249-9f20-21a4c2eb1506",
      "reference_id": "MY_REFERENCE_ID",
      "qr_code": "BASE64_ZIPPED_PNG",
      "amount": "123.45",
      "expiration_date": "2024-11-28",
      "refresh_token": "MY_ACCESS_TOKEN",
      "totals": {
        "amount": 123.45,
        "original_amount": 123.45,
        "original_asset": "BRL",
        "customer_fees": 0,
        "customer_amount": 123.45,
        "asset": "BRL"
      },
      "customer_fees": {}
    }