Skip to main content

Payout notification

The payout notification is used to notify the business partner independently of the result of the payout processing.

Possible values of the STATUS attribute are:

  • SUCCESS
  • FAILED

In case of technical errors, such as socket timeout, or application errors, such as an HTTP 500 response, the payout notification is resubmitted at regular intervals until one of the following criteria is fulfilled:

  • The payout notification is successfully delivered, meaning an HTTP 200 response is received from the server.
  • The maximum number of retry attempts has been reached. This is currently configured at 5 retries.
  • The payout notification is sent from one of the following IP addresses:
    • 3.64.155.76
    • 3.76.4.148
    • 3.127.123.143
    • 176.34.172.250
    • 54.228.173.185
    • 18.197.120.90
    • 18.158.237.76
    • 52.48.213.182
    • 18.200.202.144

Example payload​

{
  "timestamp": 1601916702012,
  "eventType": "PAYOUT_STATUS_CHANGE",
  "version": "1",
  "data": {
    "id": "out_1000037854_horvath8870-correlationId-5_MXN",
    "currency": "MXN",
    "status": "VALIDATION_SUCCESSFUL",
    "amount": 152.34,
    "payout_instrument": "SAFETYPAY",
    "country_code": "MX",
    "bank_account": {
      "type": "CLABE",
      "number": "HEGJ820506M10"
    }
  }
}