TAtap

List All Payouts

This endpoint returns a list of all previous payouts, with the most recent payouts appearing first.

post/list

Request

  • Base URL
    https://api.tap.company/v2/payouts
  • URL
    https://api.tap.company/v2/payouts/list
  • Auth
    API key in header Authorization

Request body

merchantsstring[]

List of merchant IDs for which the payouts are being queried

order_bystring

Applying the sorting based on

limitinteger

The maximum number of payouts to return in a single call. Default: 25; Maximum: 50.

Response

200

objectstring
live_modeboolean
api_versionstring
countinteger
has_moreboolean

Example response

{
  "object": "list",
  "api_version": "V2",
  "count": 1,
  "payouts": [
    {
      "id": "payout_xxxx",
      "status": "PAID_OUT",
      "date": 1722781680000,
      "amount": 300,
      "currency": "AED",
      "merchant_id": "599242",
      "wallet": {
        "id": "xxxx",
        "legacy_id": "xxxx",
        "country": "QA",
        "bank": {
          "id": "xx",
          "country": "xx",
          "name": "xxxx",
          "swift": "xxxx",
          "beneficiary": {
            "name": "xxxx",
            "iban": "xxxx"
          }
        }
      },
      "settlements_available": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.