Sign in
BatchPayment

Retrieves a BatchPayment resource.

Retrieves a BatchPayment resource.

get/batch_payments/{id}

Path parameters

idstring required

Resource identifier

Response

BatchPayment resource

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"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.