Skip to main content

PaymentStatusResponse

client_idinteger

Account ID you obtained from PagaSul when integrating

Example: 123
client_payment_idstring

Payment ID unique within your system

Example: payment_35
payment_iduint64

Payment ID the PagaSul payment platform assigned to the payment

Example: 246001234
statusstring

Status the payment is currently in

Possible values: [new, redirect, processing, success, decline, failed]

Example: success
payment_methodstring

Payment method's code

Possible values: [BR.PIX, AR.BT, AR.QR, CO.BT, CO.PSE, CO.NEQUI, CO.BC, CO.TF, CO.EF, CO.TP, CO.BREB, BO.BT, BO.QR, EC.BT, EC.CASH, EC.MOBILE, VE.BT, VE.PAGOMOVIL]

Example: BR.PIX
payment_typestring

Payment method's type

Example: pay-in
currencystring

Code of the payment currency in the ISO-4217 alpha-3 format

Possible values: [BRL, ARS, COP, BOB, USD, VES]

Example: BRL
amountnumber

Payment amount in major currency units

Example: 12.34
checkout_data object

Data you should use to redirect the customer

urlstring

URL to redirect the customer to

Example: https://example.com/redirect
methodstring

HTTP method for retrieving the checkout page

Example: GET
result_codestring

Internal result code of request processing

Possible values: [OK, BAD REQUEST, NOT FOUND, NOT CREATED]

Example: OK
result_messagestring

Description of the result code

Example: unauthorized
PaymentStatusResponse
{
  "client_id": 123,
  "client_payment_id": "payment_35",
  "payment_id": 246001234,
  "status": "success",
  "payment_method": "BR.PIX",
  "payment_type": "pay-in",
  "currency": "BRL",
  "amount": 12.34,
  "checkout_data": {
    "url": "https://example.com/redirect",
    "method": "GET"
  },
  "result_code": "OK",
  "result_message": "unauthorized"
}