List collections
Your account's collections, newest first, filterable by status and currency. Requires collection:read.
BearerAuthAuthorizationBearer <token>Secret API key: tp_test_. or tp_live_.. Server-side only.
limit?integer1 <= value <= 10025cursor?stringstatus?unknown"created""pending""processing""succeeded""failed""reversed""refunded"currency?string^[A-Z]{3}$Page of transactions
application/json- response
items*array<>next_cursor*string|nullcurl -X GET 'https://api.teepay.me/v1/collections'{ "items": [ { "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" } } ], "next_cursor": "string"}Get a collection GET
One collection by its public_reference. Poll this after creating a mobile money payment until status is succeeded or failed. Requires collection:read.
Create a checkout session POST
Creates a TeePay hosted checkout page for your account. Redirect the customer to checkout_url. A payment profile is optional: when given, or when your account has a default profile, its branding, return URL and webhook URL are used. Repeating the same Idempotency-Key and body returns the same session with the header Idempotent-Replayed: true. Requires checkout:create. 30 creations per account per minute.