Get all transfers.

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

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/transfers?pageFilterTransfer=<pageFilterTransfer>" \
  -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",
      "type": "deposit",
      "created_date": 0,
      "merchant_id": "mer_1b47d0e9ca",
      "merchant_name": "Jeanne Ndayishimiye",
      "live": false,
      "modified_date": 0,
      "reversal_id": "string"
    }
  ]
}

Query parameters

Appended to the URL after a `?`.

pageFilterTransferPageFilterTransferrequired

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 TransferResponse
List of transfers
- idstring
  Id of the transfer
- objectstring
  object to be returned
- amountinteger<int64>
  Amount to be transferred.
- currencystring
  Three-Letter ISO currency code
  Allowed values:BIFUSDKESXAF
- descriptionstring
  Description of the payout.
- typestring
  Type of the transfer. Either deposit or reversal
  Allowed values:depositreversal
- created_dateinteger<int64>
  UTC UNIX Epoch Timestamp in millisecond at which the record was created.
- merchant_idstring
  ID of the merchant receiving the fund
- merchant_namestring
  Name of the merchant receiving the fund
- 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.
- reversal_idstring
  ID of the reversal transfer for a deposit. Only valid for bank and card type.

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",
      "type": "deposit",
      "created_date": 0,
      "merchant_id": "mer_1b47d0e9ca",
      "merchant_name": "Jeanne Ndayishimiye",
      "live": false,
      "modified_date": 0,
      "reversal_id": "string"
    }
  ]
}