Skip to content

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 TRANSPARENT order:

POST /api/v1/order
Host: sulpayments.ch
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

{
  "customer": {
    "name": "Customer’s full name",
    "document": "111.222.333-44", # (required)
    "email": "[email protected]", # (required)
    "phone": "11999999999", # (required)
    "birth": "1996-03-09" # (required)
  },
  "order":{
    "code": "123", # Order reference in your system (required)
    "notification_url": "your_payback_notification_url.com", # Where we'll notify when status changes (required)
    "value": 50.00, # (required)
    "additional_info": "Some description of your order as String", # (required)
    "payment_method": "picpay" # (required)
  }
}

The response will be:

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "code": "order_id_in_your_system",
  "confirmation_url": "https://sulpayments.ch/7c0b8129-f556-4357-bb6e-8189c2943024", # Redirect customer to see and pay the boleto.
  "qrcode_link": "https://sulpayments.ch/qrcode/7c0b8129-f556-4357-bb6e-8189c2943024" # Link to the qrcode
}

Business errors are returned with a 403 status code. The response will contain the following parameters:

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "message": "kyc message table below",
  "code": "kyc code table below"
}

KYC RESPONSE CODES DESCRIPTIONS

Code Message
KYC110 Invalid CPF, please verify your date of birth and CPF number.
KYC111 Invalid CNPJ, please verify your CNPJ number.
KYC112 Different name from the federal revenue register of natural persons.

Get QR code and Image

To get QR Code info and image after generating the order:

GET /api/v1/qrcode/{latam_id} 
Host: sulpayments.ch
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

The response will be:

{
  "qrcode_app_link": "https://app.picpay.com/checkout/NjZjZG",
  "qrcode_image": "data:image/png;base64"
}

Reverse Order

To reverse the order:

POST /api/v1/order/{order_id}/reverse
Host: sulpayments.ch
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."
}