Announcements
Support
Start typing to search…
Back to All

New Optional Feature PIX: Payer Account Number Information in Callback

10 months ago by PayRetailers

New Optional Feature: Payer Account Number Information in Callback

Effective Date: 13/11/2024
Status: Optional

Overview
Starting today, we’re excited to introduce an optional feature for all PIX Payment Methods. This feature allows merchants to receive the Payer's AccountNumber in the callback when a transaction reaches an Approved status. This enhancement provides merchants with more detailed information, making transaction handling and record-keeping even smoother.

How It Works

Once activated, this feature enables the AccountNumber information of the payer to be included in the callback data. The data will be included only after a transaction has reached the Approved status, ensuring merchants receive this information only for successful transactions.

New Additional Information in Callback:

"payer": {
"name": "John",
"lastName": "Doe",
"personalId": "1234567890",
"bankName": "001",
"accountAgencyNumber": "0001",
"accountNumber": "12345678",
"payoutAccountTypeCode": "0001"
}

Activation

To enable this feature for your shop, please reach out to our Integrations Team at [email protected]. Our team will assist you in activating this feature and answer any questions you may have.

Key Points

  • Optional Feature: This is an opt-in feature that will only be enabled upon merchant request.
  • Data Availability: AccountNumber data is included in the callback response only for Approved transactions.
  • Contact for Activation: Merchants interested in this feature should email [email protected] to activate it in their shop. Bear in mind to keep your ShopID handy to speed up the activation.

Callback Response Example

Once activated, the callback response for an approved transaction will include an additional field as shown below:

{
"uid": "xxxxxx1e-2f77-488a-ab98-fc7a8axxxxxx",
"type": "payment",
"status": "APPROVED",
"message": null,
"trackingId": null,
"amount": 1100,
"currency": "BRL",
"description": "xxx",
"createdAt": "2024-11-05T16:10:54.4297015Z",
"updatedAt": "2024-11-06T09:09:45.7163609Z",
"pspTransactionId": "xxxxxxe2f77488aab98fc7a8axxxxxx",
"isValidPaymentMethod": null,
"pspCouponAmount": "11",
"customer": {
"firstName": "xxx",
"lastName": "xxx",
"middleName": "",
"email": "[email protected]",
"country": "BR",
"city": "xxx",
"zip": "",
"address": "xxx",
"phone": "xxx",
"deviceId": "",
"ip": "xx.00.00.xx",
"personalId": "xxx",
"uniqueCustomerIdentifier": null,
"accountCreationDate": null,
"accountCreationCountry": null
},
"form": null,
"paymentMethod": {
"id": "xxxxc3b2-f091-4b87-903c-f7b9c265xxxx",
"name": "xxx",
"type": "xxx",
"paymentMethodTag": ""
},
"billing": {
"currency": "BRL",
"amount": 11
},
"conversionInfo": null,
"payer": {
"name": "JOHN DOE",
"lastName": null,
"personalId": "1234567890",
"payoutAccountTypeCode": "0001",
"accountAgencyNumber": "0001",
"accountNumber": "12345678",
"bankName": "001"
}
}

This feature aims to enhance data transparency for merchants, giving you greater control and access to important transaction details.

For further questions, feel free to reach out to our team