Get a collection
One collection by its public_reference. Poll this after creating a mobile money payment until status is succeeded or failed. Requires collection:read.
BearerAuthAuthorizationBearer <token>Secret API key: tp_test_. or tp_live_.. Server-side only.
reference*string^[A-Za-z0-9_-]{1,128}$Transaction
application/json- response
id*stringpublic_reference?stringoperation*unknown"charge""payout"status*unknown"created""pending""processing""succeeded""failed""reversed""refunded"status_detail?stringmoney*created_at*stringdate-timeupdated_at*stringdate-timecustomer_name?stringcustomer_phone?stringmethod?stringchannel?stringsource?stringfee?net?curl -X GET 'https://api.teepay.me/v1/collections/TP8K2M4QZ1'{ "id": "string", "public_reference": "string", "operation": "charge", "status": "created", "status_detail": "string", "money": { "amount_minor": 0, "currency": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "customer_name": "string", "customer_phone": "string", "method": "string", "channel": "string", "source": "string", "fee": { "amount_minor": 0, "currency": "string" }, "net": { "amount_minor": 0, "currency": "string" }}Create a mobile money payment POST
Sends a USSD payment prompt to the customer's phone. The customer approves it with their mobile money PIN. A 202 response means the request was accepted, not that the customer paid: read the collection or wait for the payment.completed webhook. customer.country and money.currency must be a pair your key can use (see Get capabilities); otherwise the error is unsupported_market. Requires collection:create and mobile money push enabled for your account.
List collections GET
Your account's collections, newest first, filterable by status and currency. Requires collection:read.