GOgocardless
Payment Account Transaction

List payment account transactions

List transactions for a given payment account.

get/payment_accounts/{payment_account_transaction_id}/transactions

Request

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

Path parameters

payment_account_transaction_idstring required

The payment account transaction id

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

value_date_fromstring required
Example:2024-01-01

The beginning of query period

value_date_tostring required
Example:2024-01-02

The end of query period

direction'credit' | 'debit'

The direction of the transaction. Debits mean money leaving the account (e.g. outbound payment), while credits signify money coming in (e.g. manual top-up).

Example:credit

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "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
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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