Skip to main content
WEBHOOK
return.initiated
{
  "id": "<string>",
  "type": "return.initiated",
  "api_version": "<string>",
  "payload": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "return",
    "status": "pending",
    "deposit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "currency": "EUR",
    "failure": {
      "code": "account_closed",
      "message": "<string>",
      "retry": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "date": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

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.initiated
​
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.

​
date
string<date-time>
required

ISO 8601 UTC timestamp when the event was created.

Response

200

Event received successfully.