Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Batch Transactions

List Batch Transactions

Retrieve an ordered and paginated list of existing Batch Transactions. The list can be filtered by Account, Batch ID, Item, and Transaction Type.

get/batch_transactions

Query parameters

limitinteger

Number of records to retrieve. Up to 200.

offsetinteger

Number of records to offset. Required for pagination.

account_idstring

Bank, Card or Wallet Account ID.

batch_idstring

Batch ID. This appears on a bank reference.

item_idstring

Item ID

transaction_type'payment' | 'refund' | 'disbursement' | 'fee' | 'deposit' | 'withdrawal'

The type of transaction. Options for querying are: payment, refund, disbursement, fee, deposit, withdrawal. For returned values please refer here: Enumeration Values for the full list

transaction_type_method'credit_card' | 'npp' | 'bpay' | 'wallet_account_transfer' | 'wire_transfer' | 'misc'

The method the transaction was carried out with. Options for querying are: credit_card, npp, bpay, wire_transfer, wallet_account_transfer, misc. For returned values please refer here: Enumeration Values for the full list

direction'debit' | 'credit'

Direction of the transaction. Options are debit, credit

created_beforestring

Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)

created_afterstring

Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)

disbursement_bankstring

The bank used for disbursing the payment. Please use a default value of any

processing_bankstring

The bank used for processing the payment. Please use a default value of any

Response

OK

Example response

{
  "batch_transactions": [
    {
      "disbursement_bank": "Bank A",
      "processing_bank": "Bank A",
      "account_external": {
        "currency": {
          "code": "AUD"
        }
      },
      "first_name": "first name",
      "last_name": "last name",
      "user_email": "email@email.com",
      "user_external_id": "buyer-71391895",
      "legal_entity_id": "49fac28b-5628-4cec-854f-58a9b87dd58d",
      "type": "disbursement",
      "type_method": "direct_credit",
      "batch_id": 302,
      "state": "batched",
      "user_id": "064d6800-fff3-11e5-86aa-5e5517507c66",
      "account_id": "e57120ea-053d-11e6-b512-3e1d05defe78",
      "account_type": "item",
      "from_user_name": "payer",
      "from_user_id": "064d6800-fff3-11e5-86aa-5e5517507c66",
      "amount": 9800,
      "currency": "AUD",
      "company": "ABC Pty Ltd",
      "address_line1": "Courtland Ave.",
      "address_line2": "Building 1",
      "address_city": "Melbourne",
      "address_state": "VIC",
      "country": "AUD",
      "debit_credit": "credit",
      "description": "Credit of $98.00 to Item by Debit of $98.00 from Wallet Account",
      "deposit_reference": "AUD",
      "related": {
        "account_to": {
          "id": "385b50bb-237a-42cb-9382-22953e191ae6",
          "account_type": "wallet_account",
          "user_id": "5830def0-ffe8-11e5-86aa-5e5517507c66"
        }
      }
    }
  ]
}