Skip to main content
GET
https://api.checkout.paayoor.com
/
api
/
v1
/
disbursement
curl --location --request GET 'https://api.checkout.paayoor.com/api/v1/disbursement' \
--header 'api-key: 75gJfowm010du0Nw2vwGZ150OoxhWJyz7vP0jM8Je6XFhtz0fk' \
--header 'secret-key: 7cJofndFd5I5jMtICp6FFOGiTudpQwn661OZVTT7w63npl7lJ1'
{
  "success": true,
  "statusCode": 200,
  "message": "Disbursement !",
  "data": {
    "disbursements": [
      {
        "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"
      },
      ...
    ]
  },
  "meta": {
    "pagination": {
      "total": 1,
      "perPage": 10,
      "currentPage": 1,
      "firstPage": 1,
      "firstPageUrl": "https://api.checkout.paayoor.com/api/v1/disbursement?page=1",
      "pages": {
          "1": "https://api.checkout.paayoor.com/api/v1/disbursement?page=1"
      },
      "lastPage": 1,
      "lastPageUrl": "https://api.checkout.paayoor.com/api/v1/disbursement?page=1"
    }
  }
}

Path

perPage
number
required
page
number
required

Headers

api-key
string
required
secret-key
string
required

Response

success
boolean
statusCode
number
message
string
data
object
meta
object
curl --location --request GET 'https://api.checkout.paayoor.com/api/v1/disbursement' \
--header 'api-key: 75gJfowm010du0Nw2vwGZ150OoxhWJyz7vP0jM8Je6XFhtz0fk' \
--header 'secret-key: 7cJofndFd5I5jMtICp6FFOGiTudpQwn661OZVTT7w63npl7lJ1'
{
  "success": true,
  "statusCode": 200,
  "message": "Disbursement !",
  "data": {
    "disbursements": [
      {
        "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"
      },
      ...
    ]
  },
  "meta": {
    "pagination": {
      "total": 1,
      "perPage": 10,
      "currentPage": 1,
      "firstPage": 1,
      "firstPageUrl": "https://api.checkout.paayoor.com/api/v1/disbursement?page=1",
      "pages": {
          "1": "https://api.checkout.paayoor.com/api/v1/disbursement?page=1"
      },
      "lastPage": 1,
      "lastPageUrl": "https://api.checkout.paayoor.com/api/v1/disbursement?page=1"
    }
  }
}