Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Transactions

List Transactions

Retrieve an ordered and paginated list of Transactions. Note: created_before and created_after range can not be greater than 31 days

get/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.

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.

user_idstring

User ID.

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)

Response

OK

Example response

{
  "transactions": [
    {
      "id": "7a138862-f821-412d-a91e-367ed7391fe7",
      "reference_id": "7190770-1-2908",
      "description": "Debit of $250.00 from Credit Card for Credit of $250.00 to Item",
      "payee_name": "Test payee",
      "type": "payment",
      "type_method": "credit_card",
      "state": "successful",
      "user_id": "064d6800-fff3-11e5-86aa-5e5517507c66",
      "user_name": "First1556505750 LastName",
      "item_name": "Item 7190985-1-9382",
      "account_id": "930a7f78-6bf6-4f33-8cfc-b82c787b5f83",
      "account_type": "card_account",
      "currency": "AUD",
      "debit_credit": "debit",
      "related": {
        "transactions": [
          {
            "id": "6b68f5dc-b8a8-44cf-a7e8-80f350178152",
            "account_id": "100fd4a0-0538-11e6-b512-3e1d05defe78",
            "account_type": "item",
            "user_id": "064d6800-fff3-11e5-86aa-5e5517507c66"
          }
        ]
      },
      "payee_details": {
        "debtor_name": "Test debtor name",
        "debtor_legal_name": "Test debtor legal name",
        "clearing_system_transaction_id": "INGBAU2SXXXN20181213009149405094650",
        "pay_id": "npp@assemblypayments.com",
        "pay_id_type": "/EMAL",
        "end_to_end_id": "NOTPROVIDED",
        "npp_payin_internal_id": "3a768370-8ebd-11ea-a8ab-af8225e7132d"
      },
      "links": {
        "self": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b",
        "users": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/users",
        "fees": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/fees",
        "wallet_accounts": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/wallet_accounts",
        "card_accounts": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/card_accounts",
        "paypal_accounts": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/paypal_accounts",
        "bank_accounts": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bank_accounts",
        "items": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/items",
        "marketplaces": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/marketplaces",
        "supplementary_data": "/transactions/ea36e48a-4638-4d1a-a345-e1a0a584df8b/supplementary_data"
      }
    }
  ]
}