Bills Init

POST

/payments/bill-init/

Last modified:2023-04-21 13:31:22

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

debit_bank

string

required

debit_account

string

required

amount

integer

required

description

string

required

merchant_description

string

required

merchant_reference

string

required

redirect_uri

string | null

required

The uri where the client will be redirected if he decides to return to the merchant's website

payment_product_id

null

required

pin_code

string

required

Example

{
    "debit_bank": "MF1-0001",
    "debit_account": "0000000016-01",
    "amount": 600,
    "description": "Payment merchant",
    "merchant_description": "Payment from client 001 752000",
    "merchant_reference": "752001",
    "redirect_uri": "https://myredirecturi.com/payments",
    "payment_product_id": null,
    "pin_code": "1234"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1:8081/api/v2/payments/bill-init/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "debit_bank": "MF1-0001",
    "debit_account": "0000000016-01",
    "amount": 600,
    "description": "Payment merchant",
    "merchant_description": "Payment from client 001 752000",
    "merchant_reference": "752001",
    "redirect_uri": "https://myredirecturi.com/payments",
    "payment_product_id": null,
    "pin_code": "1234"
}'

Responses

🟢200OK

application/json

Body

response_code

string

required

response_data

object

required

code

string

required

reference

null

required

response_message

string

required

success

boolean

required

Example

{
    "response_code": "00",
    "response_data": {
        "code": "CODE-20230321-9E29QH1",
        "reference": null
    },
    "response_message": "Payment bill successfully created. The client has to validate it to complete the payment. Code : CODE-20230321-9E29QH1",
    "success": true
}

Modified at 2023-04-21 13:31:22

Bills operations flow

Bill Status Check