API Reference
Initiate a transfer
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
Initiate a transfer
POST
/
transfers
curl --request POST \
--url https://api.notchpay.co/transfers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 5000,
"currency": "XAF",
"channel": "cm.mtn",
"beneficiary": "ben_123456789",
"recipient": "ben_123456789",
"description": "Paiement de salaire",
"reference": "ref_123456789"
}'
{
"status": "Accepted",
"message": "Transfer initialized",
"code": 201,
"transfer": {
"id": "trf_123456789",
"reference": "ref_123456789",
"amount": 5000,
"currency": "XAF",
"status": "complete",
"beneficiary": "ben_123456789",
"created_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:05:00.000Z",
"payment_method": "pm.ndzAfIh555VCPML1"
}
}
Authorizations
Body
application/json
Response
201
application/json
Transfer initialized
The response is of type object
.
curl --request POST \
--url https://api.notchpay.co/transfers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 5000,
"currency": "XAF",
"channel": "cm.mtn",
"beneficiary": "ben_123456789",
"recipient": "ben_123456789",
"description": "Paiement de salaire",
"reference": "ref_123456789"
}'
{
"status": "Accepted",
"message": "Transfer initialized",
"code": 201,
"transfer": {
"id": "trf_123456789",
"reference": "ref_123456789",
"amount": 5000,
"currency": "XAF",
"status": "complete",
"beneficiary": "ben_123456789",
"created_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:05:00.000Z",
"payment_method": "pm.ndzAfIh555VCPML1"
}
}