Charge

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

email

string

required

Customer's email address

Default:

test@gmail.com

amount

integer <int32>

required

Amount in Kobo

Default:

15000

reference

string

required

A unique key for the payment from the merchant/business

Default:

12345

public_key

string

required

type

enum<string>

optional

Allowed values:

ng_bank_transferng_opay_wallet

Default:

ng_bank_transfer

Example

{
    "email": "test@gmail.com",
    "amount": 15000,
    "reference": "12345",
    "public_key": "string",
    "type": "ng_bank_transfer"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://devapi.collect.africa/payments/charge' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "test@gmail.com",
    "amount": 15000,
    "reference": "12345",
    "public_key": "string",
    "type": "ng_bank_transfer"
}'

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Checkout Initialized

data

object

optional

id

integer

optional

Default:

0

Example:

8729

amount

integer

optional

Default:

0

Example:

10000

code

string

optional

Example:

SC_ckyahqvds000x01qg8eeg5nhe

customer_id

integer

optional

Default:

0

Example:

7

first_name

string

optional

Example:

peter

middle_name

optional

last_name

string

optional

Example:

parker

email

string

optional

Example:

peterparker@gmail.com

business_id

integer

optional

Default:

0

Example:

1

business_name

string

optional

Example:

Prod Company

currency

string

optional

Example:

NGN

country

string

optional

Example:

NG

reference

string

optional

Example:

1641928346571

callback_url

optional

pass_fee

boolean

optional

Default:

true

Example:

false

payment_methods

array [object {3}]

optional

Example

{
    "message": "Checkout Initialized",
    "data": {
        "id": 8729,
        "amount": 10000,
        "code": "SC_ckyahqvds000x01qg8eeg5nhe",
        "customer_id": 7,
        "first_name": "peter",
        "middle_name": null,
        "last_name": "parker",
        "email": "peterparker@gmail.com",
        "business_id": 1,
        "business_name": "Prod Company",
        "currency": "NGN",
        "country": "NG",
        "reference": "1641928346571",
        "callback_url": null,
        "pass_fee": false,
        "payment_methods": [
            {
                "name": "ng_bank_transfer",
                "charge_percentage": 1,
                "charge_cap": 50000
            },
            {
                "name": "ng_card",
                "charge_percentage": 1.5,
                "charge_cap": 200000
            },
            {
                "name": "ng_opay_wallet",
                "charge_percentage": 1,
                "charge_cap": 50000
            },
            {
                "name": "ng_barter",
                "charge_percentage": 1.4,
                "charge_cap": 200000
            }
        ]
    }
}

🟠400Bad Request