GET /payments/{id}
This operation will allow you to get details on a specific Payment by its ID.
Request
Ensure the bearer token is included in the Header of the GET operation:
id
Yes
The unique payment ID to fetch.
Response
A 404 Not Found HTTP response will be returned if the paymentId
does not exist.
If the Payment exists, the following model will be returned:
id
string($guid)
Unique ID for the Payment.
batchId
string($guid)
The Batch ID that the Payment is part of. Batch details can be fetched using GET /batches/{id}
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.
firstname
string
Firstname of the user.
lastname
string
Lastname of the user.
externalId
string
Payment identifier supplied by external system for tracing purposes.
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.
Last updated