Skip to main content
POST
https://api.checkout.paayoor.com
/
api
/
v1
/
disbursement
curl --location --request POST 'https://api.checkout.paayoor.com/api/v1/disbursement' \
--header 'api-key: 75gJfowm010du0Nw2vwGZ150OoxhWJyz7vP0jM8Je6XFhtz0fk' \
--header 'secret-key: 7cJofndFd5I5jMtICp6FFOGiTudpQwn661OZVTT7w63npl7lJ1' \
--data '{
  "amount": "",
  "channel": "",
  "country": "",
  "customer": {
    "fullName": "",
    "phoneNumber": "",
    "email": ""
  },
  "merchantReference": "",
  "pendingUrl": "",
  "succeededUrl": "",
  "failedUrl": "",
  "canceledUrl": "",
  "errorUrl": "",
  "callbackUrl": ""
}'

{
  "success": true,
  "statusCode": 200,
  "message": "Disbursement !",
  "data": {
    "disbursement": {
      "operation": "disbursement",
      "token": "u0smo-xg3pq-ab4un-zjcjo-f0rlm",
      "status": "succeeded",
      "amount": 1000,
      "pricing": {
        "percentageFee": 1.8,
        "additionalFee": 100,
        "feesAmount": 120,
        "supportedByAccount": true
      },
      "cashAmount": 1000,
      "transactionAmount": 1120,
      "customer": {
        "fullName": "Mamadou GAYE",
        "phoneNumber": "778737478",
        "email": "[email protected]"
      },
      "merchantReference": "ifkjhiouefjeifjei",
      "initiationDate": "2023-09-20T17:30:38.000000Z"
    }
  }
}
​
api-key
string
required
​
secret-key
string
required

​
Body

​
amount
number
required
​
channel
string
required
​
country
string
required
​
customer
object
required
​
merchantReference
string
required
​
pendingUrl
string
​
succeededUrl
string
​
failedUrl
string
​
canceledUrl
string
​
errorUrl
string
​
callbackUrl
string
required

​
Response

​
success
boolean
​
statusCode
number
​
message
string
​
data
object
curl --location --request POST 'https://api.checkout.paayoor.com/api/v1/disbursement' \
--header 'api-key: 75gJfowm010du0Nw2vwGZ150OoxhWJyz7vP0jM8Je6XFhtz0fk' \
--header 'secret-key: 7cJofndFd5I5jMtICp6FFOGiTudpQwn661OZVTT7w63npl7lJ1' \
--data '{
  "amount": "",
  "channel": "",
  "country": "",
  "customer": {
    "fullName": "",
    "phoneNumber": "",
    "email": ""
  },
  "merchantReference": "",
  "pendingUrl": "",
  "succeededUrl": "",
  "failedUrl": "",
  "canceledUrl": "",
  "errorUrl": "",
  "callbackUrl": ""
}'

{
  "success": true,
  "statusCode": 200,
  "message": "Disbursement !",
  "data": {
    "disbursement": {
      "operation": "disbursement",
      "token": "u0smo-xg3pq-ab4un-zjcjo-f0rlm",
      "status": "succeeded",
      "amount": 1000,
      "pricing": {
        "percentageFee": 1.8,
        "additionalFee": 100,
        "feesAmount": 120,
        "supportedByAccount": true
      },
      "cashAmount": 1000,
      "transactionAmount": 1120,
      "customer": {
        "fullName": "Mamadou GAYE",
        "phoneNumber": "778737478",
        "email": "[email protected]"
      },
      "merchantReference": "ifkjhiouefjeifjei",
      "initiationDate": "2023-09-20T17:30:38.000000Z"
    }
  }
}