Create PayLink

POST

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

Last modified:2025-04-19 09:05:16

Create 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

name

string

optional

Payment Name

Default:

Airtime

decription

string

optional

Payment Description

Default:

For Airtime Transactions

amount

integer <int32>

optional

The amount to pay

Default:

200

Example

{
    "name": "Airtime",
    "decription": "For Airtime Transactions",
    "amount": 200
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://devapi.collect.africa/payments/links' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Airtime",
    "decription": "For Airtime Transactions",
    "amount": 200
}'

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Pay Link Created

data

object

optional

integer

optional

Default:

Example:

475

short_code

string

optional

Example:

lsvpt8mdsg

currency

string

optional

Example:

NGN

type

string

optional

Example:

payment

name

string

optional

Example:

Blessing Makaraba

amount

integer

optional

Default:

Example:

77700

created_at

string

optional

Example:

2022-01-27T04:14:05.200Z

Example

{
  "message": "Pay Link Created",
  "data": {
    "id": 475,
    "short_code": "lsvpt8mdsg",
    "currency": "NGN",
    "type": "payment",
    "name": "Blessing Makaraba",
    "amount": 77700,
    "created_at": "2022-01-27T04:14:05.200Z"
  }
}

🟠400Bad Request

Get Payments

Charge