Payout & Payin

Payout and Payin functions similarly to off-ramp and on-ramp transactions. They share the same request body structure, except that the transaction_hash and chain is not included for payout and payin requests. For additional details, please refer to the On-Ramp / Off-Ramp section.

Disbursement

Name

Type

Description

type

String

Type of payment, MOBILE, BUY_GOODS & PAYBILL

shortcode

String

Recipient mobile number, till number or paybill number

account_number

String

Required if type is PAYBILL

amount

Integer

Amount to disburse

mobile_network

String

Supported mobile network ie Safaricom

callback_url

URL

URL to receive payment notification

POST {{url}}/{{currencyCode}}/disburse

{
    "amount": "50",
    "shortcode": "0700123456",
    "type": "MOBILE",
    "mobile_network": "Safaricom", // Airtel (required only when type is MOBILE)
    "callback_url": "https://pretium.africa/b2c/log-test"
}

Collection

POST {{url}}/{{currencyCode}}/collect

{
    "type": "BANK_TRANSFER",
    "account_number": "001918181",
    "bank_code": "247247",
    "amount": "500",
    "fee": "10",
    "callback_url": "https://pretium.africa/callback"
}

Bank Transfer

POST {{uri}}/v1/pay/{{currencyCode}}

{
    "amount": "50",
    "shortcode": "0700123456",
    "mobile_network": "Safaricom", // Airtel
    "callback_url": "https://pretium.africa/b2c/log-test"
}

Validation

POST {{url}}/{{currencyCode}}/validation

{
    "shortcode": "0700123456",
     "type": "MOBILE",
     "network": "Safaricom"
}

Status

POST {{url}}/{{currencyCode}}/status

{
    "transaction_code": "fg464gggshshkkk"
}

{
    "code": 200,
    "message": "Transaction",
    "data": {
        "id": 51215,
        "transaction_code": "045c1753-4e5b-4fa8-997b-ee52b78a96fa",
        "status": "COMPLETE",
        "amount": "20",
        "type": "MOBILE",
        "shortcode": "0700123456",
        "account_number": null,
        "public_name": "JOHN DOE",
        "receipt_number": "TIMCW5AK69",
        "category": "DISBURSEMENT",
        "message": "Transaction processed successfully.",
        "currency_code": "KES",
        "created_at": "2025-09-22T08:08:18.000000Z"
    }
}

PreviousOnramp NextFee

Last updated 2 days ago

hashtagDisbursement

hashtagCollection

hashtagBank Transfer

hashtagValidation

hashtagStatus

Disbursement

Collection

Bank Transfer

Validation

Status