List Batch Transactions

get

https://test.api.promisepay.com/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.

Query Params

limit

integer

1 to 200

Defaults to 10

Number of records to retrieve. Up to 200.

offset

integer

≥ 0

Defaults to 0

Number of records to offset. Required for pagination.

account_id

string

Bank, Card or Wallet Account ID.

batch_id

string

Batch ID. This appears on a bank reference.

item_id

string

Item ID

transaction_type

string

enum

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

Allowed:

transaction_type_method

string

enum

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

Allowed:

direction

string

enum

Direction of the transaction. Options are debit, credit

Allowed:

created_before

string

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

created_after

string

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

disbursement_bank

string

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

processing_bank

string

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

Response

Language

Credentials

URL

Response

Choose an example:

application/json

200OK