Payment Initialize

POST

https://devapi.collect.africa/payments/initialize

Last modified:2025-04-19 10:07:15

initialize a payment link.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

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

callback_url

string

optional

callback url to redirect customer

first_name

string

optional

Customer first name

Default:

Musa

middle_name

string

optional

Customer last name

Default:

Amarachi

last_name

string

optional

Customer last name

Default:

Ade

phone_number

string

optional

Customer phone number

Default:

08000000000

payment_link_code

string

optional

Payment link code

plan_code

string

optional

Payment plan code

Example

{
    "email": "test@gmail.com",
    "amount": 15000,
    "reference": "12345",
    "callback_url": "string",
    "first_name": "Musa",
    "middle_name": "Amarachi",
    "last_name": "Ade",
    "phone_number": "08000000000",
    "payment_link_code": "string",
    "plan_code": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://devapi.collect.africa/payments/initialize' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "test@gmail.com",
    "amount": 15000,
    "reference": "12345",
    "callback_url": "string",
    "first_name": "Musa",
    "middle_name": "Amarachi",
    "last_name": "Ade",
    "phone_number": "08000000000",
    "payment_link_code": "string",
    "plan_code": "string"
}'

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Checkout Initialized

data

object

optional

reference

string

optional

Example:

ref111

short_code

string

optional

Example:

SC_cksacmabu000001p27jj2e93u

checkout_url

string

optional

Example:

https://staging-checkout.collect.africa?short_code=SC_cksacmabu000001p27jj2e93u

Example

{
  "message": "Checkout Initialized",
  "data": {
    "reference": "ref111",
    "short_code": "SC_cksacmabu000001p27jj2e93u",
    "checkout_url": "https://staging-checkout.collect.africa?short_code=SC_cksacmabu000001p27jj2e93u"
  }
}

🟠400Bad Request

Charge

Initialize Crypto Payment