Create Bill Payment

post

https://sandbox-api.yangaplugbusiness.com/api/v1/bill-payments/pay

Initiate your bill payments.

Body Params

request_id

string

required

Defaults to kA2KvQVKtdTRobgmAcOQjzhY

This is a unique reference with which you can use to identify and query the status of a given transaction after the transaction has been executed.

biller_code

string

required

Defaults to mtn_data

The code property gotten for the Get Billers endpoint

product_code

string

Defaults to 6295

The code property gotten for the Get Products endpoint. You can ignore this field if has_products attribute of the biller is false

recipient

string

required

Defaults to 07040296395

The customer's unique identifier, which may include the IUC Number, Smartcard number, meter number, or phone number.... For Sandbox, use 07040296395 as value for airtime, and data. Use 1212121212 for any other.

amount

double

Defaults to 200

The amount to be paid for the bill. If the product have a fixed amount, the product amount will be used

phone

string

The customer's phone number. This is required only when requires_phone_no attribute of the biller is true

sync

boolean

required

Defaults to false

Sometimes, request may take longer time to process from the service providers. With this attribute you'll be able to specify if you want the process to be synchronous or asynchronous. Either ways, you will be notified via webhook if you configured it. Recommended: true

ported

boolean

Defaults to false

This is only for airtime and data. It is used to specify if the phone number is ported to the current network provider.

Responses

200200

400400

422422