Skip to content

Direct Deposit

Tip

  • All requests are Post requests, and the data format is json
  • API Documentation for Payment Collection via PIX

Brief Description

  • Payment collection method using PIX.

Request URL

  • /v1/vexora/checkout

Request Method

  • Method: POST
  • Content-Type: application/json
Header Required Type Description
merchantNo Yes String -

Body

Parameter Name Required Type Description
timestamp Yes String Timestamp (e.g., 1715941383720)
sign Yes String Generate the sign by sorting all body fields by their first letter into key1=value1key2=value2, then use the app secret as salt for MD5 encryption. The final sign should be in lowercase letters.
tradeNo Yes String Transaction number (should be unique, suggested format: YYYYMMDDHHMMSS + random number)
amount Yes String Amount
name Yes String Payer's name
idType Yes String Payer's ID type (CPF)
idCardNumber Yes String User's CPF information (11-digit number)
notifyUrl Yes String Asynchronous callback URL
returnUrl No String Cashier page redirect URL, remove escape characters “\”, reference format: https://www.abc.com/. If not provided, it will redirect to the system's default success page.
remark Yes String Remark

Request Parameter Example

{
  "timestamp": "1724142041682",
  "tradeNo": "test_00000007",
  "amount": "300",
  "name": "123",
  "idType": "CPF",
  "idCardNumber": "12345678909",
  "notifyUrl": "http://abc.com/notify",
  "returnUrl": "http://abc.com/callback_page",
  "remark": "000000",
  "sign": "2493ab46751eca380eb43a2b29137ad9"
}

Response Result

Parameter Name Required Type Description
msg Yes String Request result (Returning "success" only indicates the request was successful; it should not be used for merchant-side logic)
code Yes String Request response code (Returning "0000" only indicates the request was successful; it should not be used for merchant-side logic)
timestamp Yes Long Server timestamp in milliseconds
success Yes Boolean Whether the API request was processed successfully
data Yes Object Response object
data.platFormTradeNo Yes String vexora transaction number, unique
data.tradeNo Yes String Merchant transaction number
data.status Yes String Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table.
data.message Yes String Transaction status description
data.amount Yes String Payment amount
data.paymentLink Yes String Payment link, i.e., the cashier URL
data.payData Yes String Payment information (can be used to generate a payment QR code)

Successful Response Example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1719829837779,
    "success": true,
    "data": {
        "platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
        "tradeNo": "test_00000007",
        "status": "0015",
        "message": "CREDIT_INPROGRESS",
        "amount": "5000",
        "paymentLink": "https://casher-in.vexora.com/#/?orderNo=PI-0610163070368473667348485",
        "payData": "00020101021226910014br.gov.bcb.pix2569api.developer.btgpactual.com/v1/p/v2/5ef8ec7172034688909253ad3a17f8465204000053039865802BR5922Bellapay Negocios Ltda6009Sao Paulo61080120100562070503***6304FAF9"
    }
}