GET /batches/{id}

Returns summary information for a batch (excludes individual payment details).

For a list of all payments associated to the batch, use GET /batches/{id}/payments

Request

Ensure the bearer token is included in the Header of the GET operation:

Header
Mandatory
Description

Authorization

Yes

Parameter
Mandatory
Description

id

Yes

The Batch ID to query

Response

If successful, the operation will return a standard Batch model:

{
  "id": "string($guid)",
  "name": "string",
  "statusCode": "string",
  "externalId": "string",
  "createdAt": "string($date-time)",
  "summary": {
    "paymentsAmount": decimal,
    "paymentsCount": int32,
    "referralsAmount": decimal,
    "settledAmount": decimal,
    "settledCount": int32,
    "cancelledAmount": decimal,
    "cancelledCount": int32
  }
}
Field
Response Type
Description

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

Field
Response Type
Description

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

Example Response
{
  "id": "26828622-cf47-4416-b9fa-3ba65d4d4d19",
  "name": "Test Batch X",
  "statusCode": "CLOSED",
  "createdAt": "2022-10-31T08:39:12.06",
  "summary": {
    "paymentsAmount": 30,
    "paymentsCount": 2,
    "referralsAmount": 0,
    "settledAmount": 10,
    "settledCount": 1,
    "cancelledAmount": 20,
    "cancelledCount": 1
  }
}

Last updated