Skip to main content
POST
https://your.endpoint.to.update
Callback Charge
curl --request POST \
  --url https://your.endpoint.to.update/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "28018",
  "key": "e1ebf9d914174902a76a5af436f091d09cca0b1e9ad8984b5dcdfeead67ce6b8",
  "clientId": 1,
  "clientName": "Your company",
  "senderName": null,
  "senderHelpdesk": null,
  "buyerName": "Maria da Silva",
  "buyerDocument": "34960826312",
  "buyerEmail": "[email protected]",
  "customNumber": "YOUR-CODE1234",
  "ourNumber": 17530,
  "digitableLine": "pix.example.com/qr/2353c790eefb11eaadc10242ac120002",
  "barCodeNumber": null,
  "status": {
    "id": 1,
    "name": "Created"
  },
  "sender": {
    "name": null,
    "document": null,
    "helpdesk": null
  },
  "typePayin": "pix",
  "instructions": "Esse Pix é referente ao pedido 123 na loja abcd",
  "amountCents": 8652,
  "paidAmountCents": null,
  "paidAt": null,
  "expiresAt": "2024-12-31 23:59:59",
  "createdAt": "2024-02-21T19:15:00.000000Z",
  "fine": null,
  "discount": null,
  "splits": [],
  "statusHistory": {
    "status": {
      "id": 1,
      "name": "Created"
    },
    "id": 48859,
    "updatedAt": "2024-02-21T19:15:04.000000Z"
  },
  "refundMode": "FULL_REFUND_CLIENT",
  "refundAmountCents": 0,
  "payinRefunds": [],
  "payin_substatus": null,
  "kyc": null
}

​
Callbacks

You can check the payin using one of it’s identifications parameters. Every transaction will generate a unique id code, key code, with this codes you will find the charge.

​
Path Parameters

​
key
integer
required
Value corresponding to the key being entered.
​
keyType
string
required
Enum: "id", "key", "ourNumber"Example: keyType of key that will be used when querying a charge.

​
Response

​
id
string
Charge ID
​
key
string
Unique key for payment page access
​
clientId
integer
Client ID
​
clientName
string
Client name
​
senderName
string or null
Sender name
​
senderHelpdesk
string or null
Sender helpdesk
​
buyerName
string
Buyer name
​
buyerDocument
string
Buyer document
​
buyerEmail
string
Buyer email
​
customNumber
string
Your custom number
​
ourNumber
integer or null
Our internal number
​
digitableLine
string or null
Digitable line or PIX QR code URL
​
barCodeNumber
string or null
Bar code number
​
status
object
Current status
​
sender
object
Sender information
​
typePayin
string
Type of payment (e.g., “pix”, “credit-card”)
​
instructions
string
Payment instructions
​
amountCents
integer
Amount in cents
​
paidAmountCents
integer or null
Paid amount in cents
​
paidAt
string or null
Payment date
​
expiresAt
string
Expiration date
​
createdAt
string
Creation date
​
fine
object or null
Fine information
​
discount
object or null
Discount information
​
splits
array
Splits information
​
statusHistory
object or array
Status change history
​
refundMode
string
Refund mode
​
refundAmountCents
integer
Refunded amount in cents
​
payinRefunds
array
Refund records
​
payin_substatus
string or null
Sub-status
​
kyc
object or null
KYC information
{
  "id": "28018",
  "key": "e1ebf9d914174902a76a5af436f091d09cca0b1e9ad8984b5dcdfeead67ce6b8",
  "clientId": 1,
  "clientName": "Your company",
  "senderName": null,
  "senderHelpdesk": null,
  "buyerName": "Maria da Silva",
  "buyerDocument": "34960826312",
  "buyerEmail": "[email protected]",
  "customNumber": "YOUR-CODE1234",
  "ourNumber": 17530,
  "digitableLine": "pix.example.com/qr/2353c790eefb11eaadc10242ac120002",
  "barCodeNumber": null,
  "status": {
    "id": 1,
    "name": "Created"
  },
  "sender": {
    "name": null,
    "document": null,
    "helpdesk": null
  },
  "typePayin": "pix",
  "instructions": "Esse Pix é referente ao pedido 123 na loja abcd",
  "amountCents": 8652,
  "paidAmountCents": null,
  "paidAt": null,
  "expiresAt": "2024-12-31 23:59:59",
  "createdAt": "2024-02-21T19:15:00.000000Z",
  "fine": null,
  "discount": null,
  "splits": [],
  "statusHistory": {
    "status": {
      "id": 1,
      "name": "Created"
    },
    "id": 48859,
    "updatedAt": "2024-02-21T19:15:04.000000Z"
  },
  "refundMode": "FULL_REFUND_CLIENT",
  "refundAmountCents": 0,
  "payinRefunds": [],
  "payin_substatus": null,
  "kyc": null
}