API Reference
Initialize a payment
Introduction
Core Resources
Additional Resources
API Specification
- API Reference
- GETList all payments
- POSTInitialize a payment
- GETRetrieve a payment
- PUTProcess a payment
- POSTProcess a payment
- DELCancel a payment
- GETList all transfers
- POSTInitiate a transfer
- GETRetrieve a transfer
- GETList all beneficiaries
- POSTCreate a beneficiary
- GETRetrieve a beneficiary
- DELDelete a beneficiary
- GETList all customers
- POSTCreate a customer
- GETRetrieve a customer
- POSTUpdate a customer
- DELDelete a customer
- GETList customer's payment methods
- GETList customer's payments
- POSTBlock a customer
- POSTUnblock a customer
- GETList all webhooks
- POSTCreate a webhook
- GETRetrieve a webhook
- PUTUpdate a webhook
- DELDelete a webhook
- GETRetrieve account balance
- GETList all payment channels
- GETList all countries
- GETList all currencies
- GET
API Reference
Initialize a payment
POST
/
payments
curl --request POST \
--url https://api.notchpay.co/payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 5000,
"currency": "XAF",
"email": "john@example.com",
"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": {
"id": "pay_123456789",
"reference": "ref_123456789",
"amount": 5000,
"currency": "XAF",
"status": "complete",
"customer": "cus_123456789",
"created_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:05:00.000Z",
"payment_method": "pm.ndzAfIh555VCPML1"
},
"authorization_url": "https://pay.notchpay.co/pay_123456789"
}
Authorizations
Body
application/json
Response
201
application/json
Payment initialized
The response is of type object
.
curl --request POST \
--url https://api.notchpay.co/payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 5000,
"currency": "XAF",
"email": "john@example.com",
"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": {
"id": "pay_123456789",
"reference": "ref_123456789",
"amount": 5000,
"currency": "XAF",
"status": "complete",
"customer": "cus_123456789",
"created_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:05:00.000Z",
"payment_method": "pm.ndzAfIh555VCPML1"
},
"authorization_url": "https://pay.notchpay.co/pay_123456789"
}