Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
BatchPayment

Retrieves the collection of BatchPayment resources.

Retrieves the collection of BatchPayment resources.

get/batch_payments

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

BatchPayment collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for each batch payment

accountIdstring

ID of the account used to make the payment

datestring

Date the payment is being made

paymentIdstring nullable

The ID of the payment

paymentAmountinteger nullable

The amount being paid for

typestring nullable

The type of batch payment e.g. "PAYBATCH" e.g. "RECBATCH"

statusstring

Status of the batch payment e.g. "authorised" e.g. "deleted"

totalAmountinteger

Total of the payments that make up the batch

modifiedstring nullable

The date and time the batch payment was last modified

isReconciledboolean nullable

Whether the batch payment has been reconciled

Example response

[
  {
    "integration": "quickbooks"
  }
]