API Reference
API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 200
Defaults to 10

Number of records to retrieve. Up to 200.

integer
≥ 0
Defaults to 0

Number of records to offset. Required for pagination.

string

Bank, Card or Wallet Account ID.

string

Batch ID. This appears on a bank reference.

string

Item ID

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:
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:
string
enum

Direction of the transaction. Options are debit, credit

Allowed:
string

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

string

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

string

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

string

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

Response

Updated 9 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 9 days ago