New Optional Feature SPEI: Payer Details Information in Callback

New Optional Feature: Payer Details Information in Callback

Effective Date: 08/11/2024
Status: Optional

Overview

We are pleased to announce a new optional feature for all SPEI Payment Methods, now available to merchants. This feature allows merchants to receive detailed payer information in the callback when a transaction reaches either an Approved or Cancelled status. With this enhancement, merchants can handle transactions more effectively, improving both transaction management and record-keeping.

How It Works

Once activated, this feature will include the following payer details in the callback data for both Approved and Cancelled transactions:

  • payerName: The full name of the payer.
  • personalId: The payer’s personal identification number (e.g., CURP in Mexico).
  • accountused: The account number used for the transaction.
  • bankTrackingID: A unique identifier for the bank transaction.

This information will only be provided for transactions that have reached either the Approved or Cancelled status, ensuring that merchants receive the relevant details for both successful and canceled transactions.

New Additional Information in Callback:

json
Copy code
"payer": {
"payerName": "Test",
"personalId": "TEST123456HVZYLS09",
"accountused": "120123000007514182",
"bankTrackingID": "202000001011043080000000026004"
}

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.

Callback Response Example

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

{
 "uid": "212338c8e-bed1-4c0d-aa20-1c6e9332323b7",
 "type": "payment",
 "status": "APPROVED",
 "message": null,
 "trackingId": "1002412111",
 "amount":100,
 "currency": "MXN",
 "description": "test",
 "createdAt": "2024-11-07T09:40:03.2915489Z",
 "updatedAt": "2024-11-07T09:46:53.4166865Z",
 "pspTransactionId": "a2353463tgfgrertyer",
 "isValidPaymentMethod": null,
 "pspCouponAmount": "1",
 "customer": {
  "firstName": "test",
  "lastName": "test",
  "middleName": "",
  "country": "MX",
  "city": "mexico df",
  "zip": "",
  "address": null,
  "phone": "12345678987",
  "deviceId": "",
  "ip": null,
  "personalId": "12345678",
  "uniqueCustomerIdentifier": null,
  "accountCreationDate": null,
  "accountCreationCountry": null,
  "email": "[email protected]"
 },
 "form": null,
 "paymentMethod": {
  "id": "ad1234b-a221-2010-8249-bf5123e456e2",
  "name": "SPEI",
  "type": "ONLINE",
  "paymentMethodTag": "SPEI"
 },
 "billing": {
  "currency": "MXN",
  "amount": 100
 },
 "conversionInfo": null,
 "payer": {  
  "payerName": "Test",  
  "personalId": "TEST123456HVZYLS09",  
  "accountused": "120123000007514182",  
  "bankTrackingID": "202000001011043080000000026004"  
}
 }
}

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