If a valid notificationUrl is previously sent in the request, the system will send notifications to this url when the payout status is changed.
Key2Pay makes POST request to notificationUrl parameter which includes your shop credentials (ApiKey and SecretKey) in Authorization Header Base64 encoded and a JSON body that contains information about the payout.
To avoid receiving wrong notifications we recommend that you always check the credentials received.
Payout Notification Example
{
"uid": "po_PWOT2KDU1kCkfu3BEMnuQg",
"status": "PENDING",
"currency": "USD",
"amount": 10,
"sourceAmount": 10,
"sourceCurrency: 10,
"arrivalAmount": 166,
"arrivalCurrency": "MXN",
"method": "spei",
"message": "Payout Created",
"createdAt": "2023-11-23T16:09:53.130323Z",
"referenceCode": "01234",
"reason": "Payout Request",
"beneficiary": {
"account": "12345678",
"accountDigit": "4",
"accountType": "CHECKING",
"bankCode": "001",
"branch": "1234",
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"phone": "331232324",
"documentNumber": "21532652313",
"documentType": "RFC",
"country": "MX",
"region": null
}
}