Skip to main content
POST
/
payments
Initialize a payment
curl --request POST \
  --url https://api.notchpay.co/payments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "currency": "XAF",
  "email": "[email protected]",
  "phone": 237600000000,
  "customer": "cus_123456789",
  "description": "Paiement pour commande",
  "reference": "order_123",
  "callback": "https://example.com/callback",
  "locked_currency": "XAF",
  "locked_channel": "cm.mtn",
  "locked_country": "CM",
  "items": [
    {}
  ],
  "shipping": {},
  "address": {},
  "customer_meta": {}
}
'
{
  "status": "Accepted",
  "message": "Payment initialized",
  "code": 201,
  "transaction": "<unknown>",
  "authorization_url": "https://pay.notchpay.co/pay_123456789"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
  • Option 1
  • Option 2
  • Option 3
​
amount
number
required
Example:

5000

​
currency
string
required
Example:

"XAF"

​
email
string
required
​
phone
string
Example:

237600000000

​
customer
Example:

"cus_123456789"

​
description
string
Example:

"Paiement pour commande"

​
reference
string
Example:

"order_123"

​
callback
string
Example:

"https://example.com/callback"

​
locked_currency
string
Example:

"XAF"

​
locked_channel
string
Example:

"cm.mtn"

​
locked_country
string
Example:

"CM"

​
items
object[]
​
shipping
object
​
address
object
​
customer_meta
object

Response

Payment initialized

​
status
string
required
Example:

"Accepted"

​
message
string
required
Example:

"Payment initialized"

​
code
integer
required
Example:

201

​
transaction
any
required
​
authorization_url
string
Example:

"https://pay.notchpay.co/pay_123456789"