List Payouts

This endpoint lists all customer payouts sorted by created date descendingly. This endpoint is paginated (20 records per page) and supports multiple query parameters that can be combined.

Method

GET

URL

{{BASE_URL}}/v1/payouts/list/

Headers

KeyDescription
X-API-KEYCustomer’s API Key

Payload Parameters

BASE_URL

Description

The base API URL, To be provided to the customer by Munify.

Type

URL

Required

YES

page

Description

Optional page number.

Type

Decimal

Required

NO

Example

?page=3

page_size

Description

Optional page size. (Defaults to 20, Max is 100)

Type

Decimal

Required

NO

Example

?page_size=50

bank__code

Description

Optional bank_code query.

Type

Enum Bank Codes

Required

NO

Example

?bank__code=CIB

bank__code__in

Description

Optional bank_code list query. Comma-separated bank names.

Type

List Enum Bank Codes

Required

NO

Example

?bank__code__in=CIB, MISR

amount

Description

Optional amount query.

Type

Decimal

Required

NO

Example

?amount=3897.10

amount__lte

Description

Optional amount less than or equal query.

Type

Decimal

Required

NO

Example

?amount__lte=3897.10

amount__gte

Description

Optional amount greater than or equal to query.

Type

Decimal

Required

NO

Example

?amount__gte=3897.10

status

Description

Optional status query.

Type

Enum Payout Statuses

Required

NO

Example

?status=SETTLED

status__in

Description

Optional status list query. Comma-separated payout statuses.

Type

List Enum Payout Statuses

Required

NO

Example

?status__in=SETTLED, REFUNDED

payout_type

Description

Optional type query.

Type

Enum Payout Types

Required

NO

Example

?payout_type=WALLET

payout_type__in

Description

Optional type list query. Comma-separated payout types.

Type

Enum Payout Types

Required

NO

Example

?payout_type__in=WALLET, BANK_ACCOUNT

date

Description

Optional date query.

Type

Date (Iso Format)

Required

NO

Example

?date=2024-08-26

date__lte

Description

Optional date less than or equal query.

Type

Date (Iso Format)

Required

NO

Example

date__lte=2024-08-26

date__gte

Description

Optional date greater than or equal query.

Type

Date (Iso Format)

Required

NO

Example

date__gte=2024-08-26

initiated_from

Description

Optional initiated from query.

Type

Enum Initiated From

Required

NO

Example

initiated_from=API

initiated_from__in

Description

Optional initiated from query.

Type

List Enum Initiated From

Required

NO

Example

initiated_from__in=API, PORTAL

Description

Searches by exact/contains on id and customer reference fields.

Type

String

Required

NO

Example

search=c23ed0-500

Response Fields

count

Description

Total count of payouts.

Type

Decimal

next

Description

URL of the next page.

Type

URL

previous

Description

URL of the previous page.

Type

URL

results

Description

Fetched results.

Type

Result JSON object

results.payouts

Description

List of the fetched Payouts.

Type

List (Payout JSON)

results.payout

Description

Payout details.

Type

List (Payout JSON)

JSON response

Status Code 201

{
  "count": 156,
  "next": "{{BASE_URL}}/v1/customers/payouts/page=8",
  "previous": "{{BASE_URL}}/v1/customers/payouts/page=6",
  "results": {
    "payouts": [
      {
        "id": "37c23ed0-5001-11ef-9454-0242ac120002",
        "customer_reference": "123456",
        "created": "2024-08-03T12:07:22.714321Z",
        "bank": {
          "name": "Commercial International Bank - Egypt S.A.E",
          "code": "CIB"
        },
        "receiver_name": "Ali Ahmed Mohamed Ahmed",
        "receiver_phone": "+201XXXXXXXXX",
        "receiver_identifier": "12345678901234",
        "amount": 1576.85,
        "fixed_fee": 10,
        "variable_fee": 15.77,
        "total_amount": 1551.08,
        "currency": "EGP",
        "status": "SETTLED",
        "payout_type": "BANK_ACCOUNT",
        "description": "August Salary",
        "timeline": [
          {
            "on": "2024-08-05T12:39:24.940517Z",
            "status": "INITIATED"
          },
          {
            "on": "2024-08-07T16:25:32.495071Z",
            "status": "SETTLED"
          }
        ],
        "failure_reason": null,
        "initiated_from": "PORTAL"
      },
      {
        "id": "37c23ed0-5001-11ef-9454-0242ac120003",
        "customer_reference": "123457",
        "created": "2024-08-03T12:07:22.714321Z",
        "bank": {
          "name": "MEEZA Digital",
          "code": "MIDG"
        },
        "receiver_name": "Wael Sameh Mohamed Sakr",
        "receiver_phone": "+201XXXXXXXXX",
        "receiver_identifier": "01XXXXXXXXX",
        "amount": 9600.0,
        "fixed_fee": 10,
        "variable_fee": 90.0,
        "total_amount": 9700.0,
        "currency": "EGP",
        "status": "INITIATED",
        "payout_type": "WALLET",
        "description": "August Settlement",
        "timeline": [
          {
            "on": "2024-08-05T12:39:24.940517Z",
            "status": "INITIATED"
          }
        ],
        "failure_reason": "Unregistered receiver wallet",
        "initiated_from": "API"
      }
    ]
  }
}

Check List payouts: errors