Event
List events
Returns a cursor-paginated list of your events.
<p class="notice"><strong>Important</strong>: This endpoint will no longer return events older than 18 months, including when filtering by resource. This takes effect no sooner than 1 August 2026 in sandbox environments, and no sooner than 1 October 2026 in live environments.</p>get/events
Request
- Base URLhttps://api.gocardless.com
- AuthHTTP bearer
Query parameters
beforestring nullable
Cursor pointing to the end of the desired set.
afterstring nullable
Cursor pointing to the start of the desired set.
Number of records to return.
billing_requeststring
Example:BRQ123
ID of a billing request. If specified, this endpoint will return all events for the given billing request.
creditorstring
Example:CR123
ID of an creditor. If specified, this endpoint will return all events for the given creditor.
exportstring
Example:EX123
ID of an export. If specified, this endpoint will return all events for the given export.
instalment_schedulestring
Example:IS123
ID of an instalment schedule. If specified, this endpoint will return all events for the given instalment schedule.
mandatestring
Example:MD123
ID of a mandate. If specified, this endpoint will return all events for the given mandate.
outbound_paymentstring
Example:OUT123
ID of an outbound_payment. If specified, this endpoint will return all events for the given payment.
payer_authorisationstring
Example:PAU123
ID of a payer authorisation.
paymentstring
Example:PM123
ID of a payment. If specified, this endpoint will return all events for the given payment.
payment_account_transactionstring
Example:PATR123
ID of a payment account transaction. If specified, this endpoint will return all events for the given transaction.
payoutstring
Example:PO123
ID of a payout. If specified, this endpoint will return all events for the given payout.
refundstring
Example:RF123
ID of a refund. If specified, this endpoint will return all events for the given refund.
subscriptionstring
Example:SB123
ID of a subscription. If specified, this endpoint will return all events for the given subscription.
scheme_identifierstring
Example:SB123
ID of a scheme identifier. If specified, this endpoint will return all events for the given scheme identifier.
parent_eventstring
Example:EV123
ID of an event. If specified, this endpoint will return all events whose parent_event is the given event ID.
actionstring
Limit to events with a given action.
resource_type'billing_requests' | 'creditors' | 'customers' | 'exports' | 'instalment_schedules' | 'mandates' | 'organisations' | 'outbound_payments' | 'payer_authorisations' | 'payments' | 'payment_account_transactions' | 'payouts' | 'refunds' | 'scheme_identifiers' | 'subscriptions'
Type of resource that you'd like to get all events for. Cannot be used together with the billing_request, creditor, export,instalment_schedule, mandate, payer_authorisation, payment, payout, refund, scheme_identifier, subscription, outbound_payment or payment_account_transaction parameters.
Example:mandates
include'billing_request' | 'creditor' | 'customer' | 'instalment_schedule' | 'mandate' | 'outbound_payment' | 'payer_authorisation' | 'payment' | 'payment_account_transaction' | 'payout' | 'refund' | 'scheme_identifier' | 'subscription'
The resource type of a linked resource that can be requested via the include query parameter.
Includes linked resources in the response. Must be used with the resource_type parameter specified.
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"
}
}
],
"meta": {
"limit": 50
},
"linked": {
"billing_requests": [
{
"id": "BRQ123",
"created_at": "2015-01-01T12:00:00.000Z",
"status": "pending",
"account_information_request": {
"country_code": "GB"
},
"mandate_request": {
"description": "Top-up Payment",
"currency": "GBP",
"scheme": "bacs"
},
"payment_request": {
"description": "Top-up Payment",
"currency": "GBP",
"scheme": "faster_payments",
"amount": 1000,
"app_fee": 100,
"reference": "some-custom-ref"
},
"subscription_request": {
"amount": 1000,
"currency": "USD",
"interval_unit": "monthly",
"interval": 1,
"app_fee": 100,
"count": 5,
"day_of_month": 28,
"month": "january",
"name": "12 month subscription",
"payment_reference": "GOLDPLAN",
"start_date": "2014-10-21"
},
"instalment_schedule_request": {
"name": "Invoice 4404",
"currency": "USD",
"total_amount": 1000,
"payment_reference": "GOLDPLAN",
"app_fee": 100,
"instalments_with_dates": [
{
"amount": 250,
"charge_date": "2020-11-03"
}
],
"instalments_with_schedule": {
"start_date": "2014-10-21",
"interval": 1,
"interval_unit": "monthly",
"amounts": [
1000
]
}
},
"actions": [
{
"type": "collect_bank_account",
"status": "pending",
"required": true,
"completes_actions": [
"collect_bank_account"
],
"requires_actions": [
"collect_bank_account"
],
"available_currencies": [
"GBP"
],
"available_country_codes": [
"GB"
],
"institution_guess_status": "pending"
}
],
"resources": {
"customer": {
"id": "CU123",
"created_at": "2014-01-01T12:00:00.000Z",
"email": "user@example.com",
"given_name": "Frank",
"family_name": "Osborne",
"company_name": "Hamilton Trading Ltd.",
"language": "en",
"phone_number": "+64 4 817 9999"
},
"customer_billing_detail": {
"id": "CU123",
"created_at": "2014-01-01T12:00:00.000Z",
"address_line1": "221B Baker Street",
"address_line2": "Marylebone",
"address_line3": "City of Westminster",
"city": "London",
"region": "Greater London",
"postal_code": "NW1 6XE",
"country_code": "GB",
"swedish_identity_number": "556564-5404",
"danish_identity_number": "2205506218",
"ip_address": "127.0.0.1"
},
"customer_bank_account": {
"id": "BA123",
"created_at": "2014-01-01T12:00:00.000Z",
"account_holder_name": "Billie Jean",
"account_number_ending": "1234",
"account_type": "savings",
"country_code": "GB",
"currency": "EUR",
"bank_name": "BARCLAYS BANK PLC",
"enabled": true,
"bank_account_token": "bat_f975ab3c-ecee-47a1-9590-5bb1d56fa113",
"payer_name_verification_result": "full"
}
},
"links": {
"customer": "CU123",
"creditor": "CR123",
"organisation": "OR123",
"customer_bank_account": "BA123",
"account_information_request": "AIR123",
"payment_request": "PRQ123",
"payment_request_payment": "PM123",
"mandate_request": "MRQ123",
"mandate_request_mandate": "MD123",
"subscription_request": "SBR123",
"subscription_request_subscription": "SB123",
"instalment_schedule_request": "ISR123",
"instalment_schedule_request_instalment_schedule": "IS123",
"payment_provider": "PP123"
}
}
],
"creditors": [
{
"id": "CR123",
"created_at": "2014-01-01T12:00:00.000Z",
"name": "Acme",
"address_line1": "338-346 Goswell Road",
"address_line2": "Islington",
"city": "London",
"postal_code": "EC1V 7LQ",
"country_code": "GB",
"bank_reference_prefix": "ACME",
"links": {
"default_aud_payout_account": "BA234",
"default_gbp_payout_account": "BA123",
"default_eur_payout_account": "BA456",
"default_sek_payout_account": "BA789",
"default_dkk_payout_account": "BA790",
"default_nzd_payout_account": "BA791",
"default_cad_payout_account": "BA792",
"default_usd_payout_account": "BA792"
},
"scheme_identifiers": [
{
"id": "SU123",
"created_at": "2014-01-01T12:00:00.000Z",
"scheme": "bacs",
"status": "pending",
"minimum_advance_notice": 3,
"address_line1": "221B Baker Street",
"address_line2": "Marylebone",
"address_line3": "City of Westminster",
"city": "London",
"region": "Greater London",
"postal_code": "NW1 6XE",
"country_code": "GB",
"email": "user@example.com",
"phone_number": "+44 20 1234 1234",
"currency": "EUR"
}
],
"logo_url": "https://uploads.gocardless.com/logo.png",
"verification_status": "action_required",
"merchant_responsible_for_notifications": true,
"mandate_imports_enabled": true,
"custom_payment_pages_enabled": true,
"fx_payout_currency": "EUR",
"creditor_type": "company"
}
],
"instalment_schedules": [
{
"id": "IS123",
"created_at": "2014-01-01T12:00:00.000Z",
"total_amount": 1000,
"name": "Invoice 4404",
"currency": "EUR",
"status": "active",
"payment_errors": {
"0": [
{
"field": "charge_date",
"message": "must be on or after mandate's next_possible_customer_charge_date"
}
]
},
"links": {
"mandate": "MD123",
"customer": "CU123",
"payments": [
"PM123",
"PM456"
]
}
}
],
"mandates": [
{
"id": "MD123",
"created_at": "2014-01-01T12:00:00.000Z",
"reference": "REF-123",
"status": "pending_submission",
"scheme": "bacs",
"mandate_type": "bank_debit",
"next_possible_charge_date": "2014-10-27",
"next_possible_standard_ach_charge_date": "2014-10-27",
"verified_at": "2021-01-01T12:00:00.000Z",
"links": {
"customer_bank_account": "BA123",
"creditor": "CR123",
"new_mandate": "MD123",
"customer": "CU123"
}
}
],
"outbound_payments": [
{
"id": "OUT123",
"created_at": "2024-01-01T12:00:00.001Z",
"status": "cancelled",
"amount": 1000,
"scheme": "faster_payments",
"currency": "GBP",
"execution_date": "2024-08-31",
"description": "Reward Payment (August 2024)",
"reference": "GC-QC2FI7GBEW7VCXL",
"is_withdrawal": true,
"links": {
"creditor": "CR123",
"customer": "CU123",
"recipient_bank_account": "BA123",
"outbound_payment_import": "IM123"
},
"verifications": {
"recipient_bank_account_holder_verification": {
"type": "confirmation_of_payee",
"result": "partial_match",
"actual_account_name": "Jo Doe"
}
}
}
],
"payer_authorisations": [
{
"id": "PA123",
"created_at": "2020-01-01T12:00:00.000Z",
"customer": {
"email": "user@example.com",
"given_name": "Frank",
"family_name": "Osborne",
"company_name": "Hamilton Trading Ltd.",
"address_line1": "221B Baker Street",
"address_line2": "Marylebone",
"address_line3": "City of Westminster",
"city": "London",
"region": "Greater London",
"postal_code": "NW1 6XE",
"country_code": "GB",
"locale": "en-GB",
"swedish_identity_number": "556564-5404",
"danish_identity_number": "2205506218"
},
"bank_account": {
"account_holder_name": "Billie Jean",
"account_number": "55779911",
"account_number_ending": "1234",
"account_number_suffix": "00",
"branch_code": "20-00-00",
"iban": "GB60BARC20000055779911",
"country_code": "GB",
"currency": "EUR",
"account_type": "savings",
"bank_name": "BARCLAYS BANK PLC"
},
"mandate": {
"reference": "REF-123",
"scheme": "bacs",
"payer_ip_address": "127.0.0.1"
},
"links": {
"customer": "CU123",
"bank_account": "BA123",
"mandate": "MD123"
},
"status": "created"
}
],
"payment_account_transactions": [
{
"id": "PATR1234",
"value_date": "2014-01-01",
"reference": "GC-058408d9",
"description": "Reward Payment (August 2024)",
"counterparty_name": "Acme Ltd",
"links": {
"payout": "PO123",
"outbound_payment": "OUT123",
"payment_bank_account": "BA123"
},
"direction": "credit",
"amount": 1000,
"balance_after_transaction": 1000
}
],
"payments": [
{
"id": "PM123",
"created_at": "2014-01-01T12:00:00.000Z",
"amount": 1000,
"amount_refunded": 150,
"currency": "EUR",
"description": "One-off upgrade fee",
"charge_date": "2014-05-21",
"reference": "WINEBOX001",
"status": "submitted",
"app_fee": 100,
"links": {
"mandate": "MD123",
"creditor": "CR123",
"payout": "PO123",
"subscription": "SU123",
"instalment_schedule": "IS123"
},
"fx": {
"exchange_rate": "1.1234567890",
"estimated_exchange_rate": "1.1234567890",
"fx_currency": "EUR"
},
"scheme": "bacs"
}
],
"payouts": [
{
"id": "PO123",
"created_at": "2014-01-01T12:00:00.000Z",
"amount": 1000,
"deducted_fees": 20,
"currency": "EUR",
"reference": "ref-1",
"status": "pending",
"payout_type": "merchant",
"arrival_date": "2014-01-01",
"links": {
"creditor": "CR123",
"creditor_bank_account": "BA123"
},
"fx": {
"exchange_rate": "1.1234567890",
"estimated_exchange_rate": "1.1234567890",
"fx_currency": "EUR"
},
"tax_currency": "EUR",
"metadata": {
"salesforce_id": "ABCD1234"
}
}
],
"refunds": [
{
"id": "RF123",
"created_at": "2014-01-01T12:00:00.000Z",
"amount": 150,
"currency": "EUR",
"status": "submitted",
"reference": "WINEBOX001",
"links": {
"payment": "PM123",
"mandate": "MD123"
},
"fx": {
"exchange_rate": "1.1234567890",
"estimated_exchange_rate": "1.1234567890",
"fx_currency": "EUR"
}
}
],
"subscriptions": [
{
"id": "SB123",
"created_at": "2014-01-01T12:00:00.000Z",
"amount": 1000,
"name": "12 month subscription",
"start_date": "2014-10-21",
"end_date": "2015-10-21",
"interval": 1,
"interval_unit": "monthly",
"day_of_month": 28,
"currency": "EUR",
"month": "january",
"count": 5,
"payment_reference": "GOLDPLAN",
"status": "active",
"upcoming_payments": [
{
"amount": 2500,
"charge_date": "2014-11-03"
}
],
"app_fee": 100,
"links": {
"mandate": "MD123"
},
"earliest_charge_date_after_resume": "2014-11-03"
}
],
"scheme_identifiers": [
{
"id": "SU123",
"created_at": "2014-01-01T12:00:00.000Z",
"scheme": "bacs",
"status": "pending",
"minimum_advance_notice": 3,
"currency": "EUR",
"address_line1": "221B Baker Street",
"address_line2": "Marylebone",
"address_line3": "City of Westminster",
"city": "London",
"region": "Greater London",
"postal_code": "NW1 6XE",
"country_code": "GB",
"email": "user@example.com",
"phone_number": "+44 20 1234 1234"
}
],
"customers": [
{
"id": "CU123",
"created_at": "2014-01-01T12:00:00.000Z",
"email": "user@example.com",
"given_name": "Frank",
"family_name": "Osborne",
"company_name": "Hamilton Trading Ltd.",
"address_line1": "221B Baker Street",
"address_line2": "Marylebone",
"address_line3": "City of Westminster",
"city": "London",
"region": "Greater London",
"postal_code": "NW1 6XE",
"country_code": "GB",
"language": "en",
"phone_number": "+64 4 817 9999",
"swedish_identity_number": "556564-5404",
"danish_identity_number": "2205506218"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.