Webhook Response - Order Status
When the webhook is triggered to notify the status of an order in the API Platform, this will be the structure of the response you will receive to know the order status:
{
"appliedCeiling": 4000000,
"appliedFloor": 10,
"beneficiaryDocumentId": "18184460",
"beneficiaryDocumentType": "V",
"beneficiaryLastNames": "test",
"beneficiaryNames": "test",
"calculatedFlatFee": 0,
"calculatedPercentageFee": 0,
"createdTime": "2024-10-03T18:42:48.000Z",
"currency": "VES",
"externalId": "prueba0",
"financialEntity": "a0g6s000001VdxtAAC",
"id": 17154,
"paymentInstructions": "{\"bank_name\":\"BANCO_PLAZA_VE\",\"phone_number\":\"+58-4244445566\"}",
"payoutType": "a0h6s000001CtPNAA0",
"providerAmount": 289.5,
"providerReferenceId": "000000526337",
"providerExternalId": null,
"status": "PROCESSED",
"subStatus": null,
"sumFee": 0,
"taxFee": 0,
"totalFee": 0,
"updatedTime": "2024-10-03T18:42:54.000Z",
"payoutOrderBackendId": "609dc71d-f536-497c-9613-f2f0ccc3fe28",
"payoutTypeBackendId": "893885fd-80b1-44a7-8b04-58bfe3d43c53",
"entityBackendId": "9e37eee2-c6fb-455b-87b2-433bdba568d0",
"beneficiaryFirstName": null,
"beneficiaryMiddleName": null,
"beneficiaryLastName": null,
"beneficiarySecondLastName": null,
"beneficiaryDocumentIdCountry": null,
"beneficiaryNationality": null,
"beneficiaryCountryOfBirth": null,
"beneficiaryGender": null,
"beneficiaryAddress": null,
"beneficiaryZipCode": null,
"beneficiaryCity": null,
"beneficiaryLocality": null,
"beneficiaryCountry": null,
"beneficiaryEmail": null,
"beneficiaryState": null,
"beneficiaryOccupation": null,
"senderNames": "Alice",
"senderLastNames": "Brown",
"senderDocumentId": "123456789",
"senderDocumentType": "V",
"senderPhone": "+573167100932",
"senderAddress": null,
"senderCountry": "CO",
"senderState": null,
"senderCity": null,
"senderEmail": "alicebrown@example.com",
"senderBirthDate": null,
"sfid": "a0jRt000004DS7RIAW",
"isEmpty": false,
"internalReferenceId": "17154::13972",
"sourceCountry": null,
"b2bClientBackendId": "4b577b92-57e2-42f9-b2b4-820cb66fde20",
"quotationBackendId": "ac00a11b-dbb7-437d-9bc4-3f6be7f76e1c",
"purpose": "FAMILY_SUPPORT",
"rate": 0
}
This response includes relevant information about the order, such as the beneficiary ID, processed amount, the status
of the order, payment instructions, and other important data.