1. Home
  2. Remittance
  3. Status
Status & Callbacks
Overview

Poll remittances by reference or UUID, list recent transfers, and receive a merchant webhook when the payout provider posts a final status.

Get one remittance
HTTP MethodGET
Endpoint URL/api/v2/remit/{reference}
Base URLhttps://base-url-here.com
Description{reference} is your order reference or the remittance UUID.
curl --location --request GET 'https://base-url-here.com/api/v2/remit/INV-1001' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'X-Business-Id: 9'
{
    "success": true,
    "message": "Success",
    "data": {
        "id": "22222222-2222-2222-2222-222222222222",
        "reference": "INV-1001",
        "status": "successful",
        "status_desc": "Paid",
        "rail": "mobile_money",
        "purpose": "Supplier payment",
        "recipient": {
            "other_names": "Asha",
            "surname": "Juma",
            "phone": "256712000000"
        },
        "quote": {
            "quote_id": "11111111-1111-1111-1111-111111111111",
            "currency_pair": "KES - UGX",
            "send_amount": "1000.00",
            "receive_amount": "28023.25",
            "debit_amount": "1000.00",
            "rail": "mobile_money"
        },
        "provider_reference": "TXN-889900"
    }
}
List remittances
HTTP MethodGET
Endpoint URL/api/v2/remit
Base URLhttps://base-url-here.com
DescriptionLatest 50 remittances for the business, newest first.
curl --location --request GET 'https://base-url-here.com/api/v2/remit' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'X-Business-Id: 9'

The response data array uses the same object as show.

Merchant webhook

When you pass result_url on create, the platform POSTs the same remittance object after the payout provider callback is applied.

{
    "id": "22222222-2222-2222-2222-222222222222",
    "reference": "INV-1001",
    "status": "successful",
    "status_desc": "Paid",
    "rail": "mobile_money",
    "purpose": "Supplier payment",
    "recipient": {
        "other_names": "Asha",
        "surname": "Juma",
        "phone": "256712000000"
    },
    "quote": {
        "quote_id": "11111111-1111-1111-1111-111111111111",
        "currency_pair": "KES - UGX",
        "debit_amount": "1000.00",
        "receive_amount": "28023.25"
    },
    "provider_reference": "TXN-889900"
}
Respond with HTTP 2xx quickly. Treat the webhook as a notification and confirm the latest status with GET show. This payload is not the C2B/B2C payment callback documented under Utilities.
Provider callback

POST /api/v2/remit/callback is the inbound URL for the payout provider. Merchants do not call this endpoint. The platform acknowledges receipt even if the remittance cannot be matched, so the provider can retry safely.

Terms of Use & Legal

By using this API, you agree to our Terms of Service and Privacy Policy. Do not share sensitive data or credentials.

V2.2.0