return.failed

Sent when a deposit return has failed.

WEBHOOK return.failed

Example

{
  "id": "<string>",
  "api_version": "<string>",
  "payload": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deposit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "failure": {
      "message": "<string>",
      "retry": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "date": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer token for authentication with Augustus Banking API

Body

application/json

id · string · required

Unique identifier for the event. Stable across retries.

type · enum<string> · required

Event type in resource.action format.

Available options: return.failed

api_version · string · required

API version the payload was rendered at. Stable across retries and redeliveries.

payload · object · required

Full resource snapshot at the time of the event.

Show child attributes

date · string<date-time> · required

ISO 8601 UTC timestamp when the event was created.

Response

200

Event received successfully.