GET /batches/{id}/payments

This operation returns a list of Payments for a specific Batch.

Request

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

Header	Mandatory	Description
Authorization	Yes	Bearer token from /authentication/getToken

Parameter	Mandatory	Description
id	Yes	The Batch ID to query

Response

If successful, the operation will return with a standard Payment model:

[
  {
    "id": "string($guid)",
    "batchId": "string($guid)",
    "msisdn": "string",
    "amount": decimal,
    "firstname": "string",
    "lastname": "string",
    "externalId": "string",
    "statusCode": "string",
    "settledAt": "string($date-time)",
    "isMember": boolean,
    "referralAmount": decimal,
    "referralMsisdn": "string",
    "createdAt": "string($date-time)"
  }
]

Field	Response Type	Description
id	string($guid)	Unique ID for the Payment. Can be used to perform payment specific operations using /payments
batchId	string($guid)	The Batch ID that the Payment is part of.
msisdn	string	The mobile number that will be/has been paid, formatted in international dialing format. e.g. 27821231234.
amount	decimal	The amount that will be/has been paid for the Payment.
firstname	string	Firstname of the user.
lastname	string	Lastname of the user.
externalId	string	Payment identifier supplied by external system for tracing purposes.
statusCode	string	Status code for the Payment. See Payment Status Codes for a valid list.
settledAt	string($date-time)	The date at which the Payment was paid into the user's account.
isMember	boolean	true = the user is a member of 6DOT50, false = the user is not a member of 6DOT50.
referralAmount	decimal	The Amount to allocate as a referral. Only applicable if Referral capability has been enabled for the Organisation.
referralMsisdn	string	The MSISDN of the referral. Only applicable if Referral capability has been enabled for the Organisation.
createdAt	string($date-time)	The date and time when the Payment was created.