Get the most recent payouts list

GET https://api.leapa.co/v2/payouts

This endpoint needs your API key

Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.

Request

curl -X GET "https://api.leapa.co/v2/payouts?payoutPageFilter=<payoutPageFilter>" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

{
  "object": "string",
  "page": 0,
  "size": 0,
  "live": false,
  "total_elements": 0,
  "total_pages": 0,
  "data": [
    {
      "id": "obj_5f21c8a40b",
      "object": "string",
      "amount": 45000,
      "currency": "BIF",
      "description": "Room 204, two nights",
      "reversal": "string",
      "status": "paid",
      "type": "bank",
      "automatic": false,
      "liveMode": false,
      "arrival_date": 0,
      "created_date": 0,
      "account_id": "acc_62f3a8d15b",
      "failure_code": "account_closed",
      "failure_message": "string",
      "live": false,
      "modified_date": 0,
      "processing_id": "string"
    }
  ]
}

Query parameters

Appended to the URL after a `?`.

payoutPageFilterPageFilterPayoutrequired

Response

application/json

objectstring
Array
pageinteger<int32>
The current page returned
sizeinteger<int32>
The total size in a page
liveboolean
Flag to indicate whether this is live mode or not
total_elementsinteger<int32>
The total elements
total_pagesinteger<int32>
The total pages
dataarray of PayoutResponserequired
List of Payouts
- idstringrequired
  Id of the Payout
- objectstringrequired
  Type of object returned - Payout
- amountinteger<int64>required
  Amount collected to be deposited
- currencystringrequired
  Three-Letter ISO currency code
  Allowed values:BIFUSDKESXAF
- descriptionstringrequired
  Description of the payout.
- reversalstring
  ID of the reversal transfer for a deposit. Only valid for bank and card type.
- statusstring
  Status of the payout. Either paid, pending, in_transit, canceled or failed. Only valid for bank and card type.
  Allowed values:paidpendingin_transitcanceledfailed
- typestring
  Bank, card or reversal
  Allowed values:bankcardmobile
- automaticboolean
  Whether the Payout was done by automate payout schedule or was requested manually. (Only valid for Bank and card type).
- liveModeboolean
- arrival_dateinteger<int64>
  UTC UNIX Epoch Timestamp in millisecond at which the payout is expected to arrive in the bank. Factors in weekends and bank holidays.
- created_dateinteger<int64>required
  UTC UNIX Epoch Timestamp in millisecond at which the record was created.
- account_idstringrequired
  ID of the bank account the payout was sent to
- failure_codestringrequired
  Different failed code: account_closed, account_frozen, account_restricted, could_not_process, declined, invalid_account_info, invalid_currency, unsupported_card
  Allowed values:account_closedaccount_frozenaccount_restrictedcould_not_processdeclinedinvalid_account_infoinvalid_currencyunsupported_card
- failure_messagestringrequired
  Message explaining reason for charge failure
- liveboolean
  Whether the object exist in live or test mode.
- modified_dateinteger<int64>
  UTC UNIX Epoch Timestamp in millisecond at which the object was modified.
- processing_idstring
  The Bank reference number of the deposit.

Status codes

200OK
400Bad request
401Unauthorized
402Payment required
403Forbidden
404Not found
428Precondition required
500Server error

Response

{
  "object": "string",
  "page": 0,
  "size": 0,
  "live": false,
  "total_elements": 0,
  "total_pages": 0,
  "data": [
    {
      "id": "obj_5f21c8a40b",
      "object": "string",
      "amount": 45000,
      "currency": "BIF",
      "description": "Room 204, two nights",
      "reversal": "string",
      "status": "paid",
      "type": "bank",
      "automatic": false,
      "liveMode": false,
      "arrival_date": 0,
      "created_date": 0,
      "account_id": "acc_62f3a8d15b",
      "failure_code": "account_closed",
      "failure_message": "string",
      "live": false,
      "modified_date": 0,
      "processing_id": "string"
    }
  ]
}