purchaseStatus

If the airtime provider does not support the reversal operation then the purchaseStatus operation should be used to determine the outcome of a prior purchase. This operation will, as far as possbile, return the same PurchaseResponse or ErrorDetail as would have been returned had the original purchase completed normally.

SecurityhttpBasic or oauth2

Request

query Parameters

provider	string The provider who processed the original purchase attempt. Conditionally required if purchaseRef is supplied.
purchaseReference	string The reference returned in the original purchase attempt. Conditionally required if the originalMsgId is not supplied.
originalMsgId	string The message ID of the original PurchaseRequest which failed. Conditionally required if the purchaseRef is not supplied.

Responses

200

400

Bad request

404

Not found

500

Internal server error

503

Service unavailable

504

Gateway timeout

get/purchases/status

Request samples

curl
Java
Node.js

Response samples

application/json

{"transactionLabels": [{"name": "string",
"value": "string"
}
],
"id": "string",
"time": "2019-08-24T14:15:22Z",
"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"client": {"id": "string",
"name": "string"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"thirdPartyIdentifiers": [{"institutionId": "string",
"transactionIdentifier": "string"
}
],
"slipData": {"messageLines": [{"barcode": {"data": "string",
"encoding": "string"
},
"text": "string",
"fontWidthScaleFactor": 0,
"fontHeightScaleFactor": 0,
"line": false,
"cut": false
}
],
"slipWidth": 0,
"issuerReference": "string"
},
"basketRef": "string",
"tranType": "GOODS_AND_SERVICES",
"srcAccType": "DEFAULT",
"destAccType": "DEFAULT",
"stan": "string",
"rrn": "string",
"amounts": {"requestAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"approvedAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"feeAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"balanceAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"additionalAmounts": {"property1": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"property2": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
}
}
},
"product": {"isDirectTopup": false,
"productId": "string",
"barcode": "string",
"name": "string",
"description": {"additionalDescriptions": {"property1": "string",
"property2": "string"
},
"primaryDescription": "string",
"shortDescription": "string"
},
"type": "AIRTIME_FIXED",
"wholesalePrice": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"recipientAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"productValues": [{"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
}
],
"validityPeriod": {"duration": 0,
"durationUnit": "NANOS"
},
"productContents": [{"amount": 0,
"unit": "KB"
}
],
"operator": {"id": "string",
"name": "string"
},
"channels": [{"channelName": "string",
"productDisplayName": "string",
"productDisplayCategory": "string",
"productDisplaySortOrder": 0,
"channelProductIdentifier": "string"
}
]
},
"msisdn": {"msisdn": "string",
"country": "st",
"operator": {"id": "string",
"name": "string"
}
},
"voucher": {"pin": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"serialNumber": "string",
"batchNumber": "string",
"redeemInstructions": ["string"
]
}
}