GET /batches
Gets a list of payment batches based on supplied filter criteria defined below.
Results will be limited to 1000 items if skip/take is not supplied. Results are returned ordered by CreatedAt descending.
A list of valid statusCode's can be obtained by calling GET /batch/statusCodes.
Request
Ensure the bearer token is included in the Header of the GET operation:
Authorization
Yes
statusCode
string
No
externalId
string
No
Filter Batches by External ID
skip
int
No
Items to skip when searching
take
int
No
Items to take when searching
Response
An empty result set will be returned if no matches are found for supplied search criteria.
An array of Batches will be returned, with a Summary for each Batch:
id
string($guid)
Unique ID for the Batch. Used for subsequent calls to other Batch operations.
name
string
Name of the Batch as supplied in the request.
externalId
string
External ID of the Batch as supplied in the request.
statusCode
string
Status of the Batch. A new Batch will always have a DRAFT status code.
createdAt
string($date-time)
Date and time when the Batch was created.
summary
Standard Batch Summary response model.
BatchSummary
paymentsAmount
decimal
Total value of payments to be made.
paymentsCount
int32
Total count of payments to be made.
referralsAmount
decimal
Total value of referral payments to be made.
settledAmount
decimal
Total value of payments that have been settled to users (i.e. paid to their accounts). The balance (paymentsAmount less settledAmount) is the value of payments pending to non-6DOT50 members (i.e. still to join)
settledCount
int32
Total count of Payments settled
cancelledAmount
decimal
Total amount of Payments cancelled in the batch (e.g. by using cancel operation)
cancelledCount
int32
Total count of Payments cancelled
Last updated