List payouts

Lists ordered payouts for the merchant account.

Query Parameters

• start_date date required

  Start date (in ISO8601 format).

• end_date date required

  End date (in ISO8601 format).

• format string

  Possible values: [json, csv]

• limit integer
• order string

  Possible values: [desc, asc]

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema array

• amount float
• currency string
• date date
• fee float
• id integer
• reference string
• status string

  Possible values: [SUCCESSFUL, FAILED]

• transaction_code string
• type string

  Possible values: [PAYOUT, CHARGE_BACK_DEDUCTION, REFUND_DEDUCTION, DD_RETURN_DEDUCTION, BALANCE_DEDUCTION]

[
  {
    "amount": 0,
    "currency": "string",
    "date": "2023-05-24",
    "fee": 0,
    "id": 0,
    "reference": "string",
    "status": "SUCCESSFUL",
    "transaction_code": "string",
    "type": "PAYOUT"
  }
]

Unauthorized

application/json

• Schema
• Example (from schema)
• Invalid_ Token
• Not_ Authorized_ Token
• Missing_ Token

---

Schema

• message string

  Short description of the error.

• error_code string

  Platform code for the error.

{
  "message": "string",
  "error_code": "string"
}

{
  "error_message": "invalid access token",
  "error_code": "NOT_AUTHORIZED"
}

{
  "error_message": "NOT_AUTHORIZED",
  "error_code": "NOT_AUTHORIZED"
}

{
  "message": "access token required",
  "error_code": "NOT_AUTHORIZED"
}