search

codePayout & Payin

Payout and Payin functions work the same way as off-ramp and on-ramp transactions. They use the same request body structure, except transaction_hash & chain are not included in payout/payin requests. See the On-Ramp / Off-Ramp section for more details.

hashtag
Disbursement

This endpoint calls the Pretium payment protocol to verify that the payment has been made and releases the equivalent fiat amount.

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

hashtag
Collection

This endpoint calls the Pretium payment protocol to initiate cash collection from the user, confirm receipt via mobile money or bank transfer.

hashtag
Supported Banks

Get a list of all supported banks supported by Pretium APIs.

hashtag
Bank Transfer

This endpoint calls the Pretium payment protocol to verify that the payment has been made and settles the payment to the recipient's bank account.

hashtag
Validation

This endpoint validates a phone number and returns the registered individual's name as provided by Mobile Network Operators (MNOs).

Note: Reliability varies by country, so avoid heavy dependence on this endpoint for phone number validation.

hashtag
Status

Fetch a transaction using its transaction code.

PreviousOnrampNextFee

Last updated