Event

Get a single event

Retrieves the details of a single event.

get/events/{event_id}

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

event_idstring required

The event id

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "events": {
    "id": "EV123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "resource_type": "mandates",
    "action": "cancelled",
    "customer_notifications": [
      {
        "id": "EV1D18JEXAMPLE"
      }
    ],
    "details": {
      "origin": "bank",
      "cause": "bank_account_disabled",
      "description": "Customer's bank account closed",
      "scheme": "bacs",
      "reason_code": "ADDACS-B",
      "will_attempt_retry": true,
      "not_retried_reason": "failure_filter_applied",
      "bank_account_id": "BA123",
      "currency": "GBP",
      "property": "fx_payout_currency",
      "item_count": 10
    },
    "source": {
      "name": "Joe Bloggs"
    },
    "links": {
      "billing_request": "BRQ123",
      "billing_request_flow": "BRF123",
      "bank_authorisation": "BAU123",
      "payment_request_payment": "PM123",
      "mandate_request": "MRQ123",
      "mandate_request_mandate": "MD123",
      "customer": "CU123",
      "customer_bank_account": "BA123",
      "payment": "PM123",
      "mandate": "MD123",
      "payer_authorisation": "PAU123",
      "payout": "PO123",
      "refund": "RF123",
      "subscription": "SB123",
      "instalment_schedule": "IS123",
      "creditor": "CR123",
      "parent_event": "EV123",
      "previous_customer_bank_account": "BA123",
      "new_customer_bank_account": "BA123",
      "new_mandate": "MD123",
      "organisation": "OR123",
      "outbound_payment": "OUT123",
      "payment_account_transaction": "PATR123",
      "scheme_identifier": "SU123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.