v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Payouts

Payouts - List using filters

post/payouts/list

Request body

start_timestring date-time required

The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed

end_timestring date-time nullable

The end time to filter payments list or to get list of filters. If not passed the default time is now

payout_idstring nullable

The identifier for payout

merchant_order_reference_idstring nullable

The merchant order reference ID for payout

profile_idstring nullable

The identifier for business profile

customer_idstring nullable

The identifier for customer

limitinteger

The limit on the number of objects. The default limit is 10 and max limit is 20

offsetinteger nullable

The starting point within a list of objects

connectorPayoutConnectors[] nullable

The list of connectors to filter payouts list

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

statusPayoutStatus[] nullable

The list of payout status to filter payouts list

payout_methodPayoutType[] nullable

The list of payout methods to filter payouts list

Type of entity to whom the payout is being carried out to, select from the given list of options

Example request

{
  "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
  "merchant_order_reference_id": "merchant_order_ref_123",
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "connector": [
    "wise",
    "adyen"
  ],
  "status": [
    "pending",
    "failed"
  ],
  "payout_method": [
    "bank",
    "card"
  ]
}

Response

Payouts filtered

sizeinteger required

The number of payouts included in the list

total_countinteger nullable

The total number of available payouts for given constraints

Example response

{
  "data": [
    {
      "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
      "merchant_id": "merchant_1668273825",
      "merchant_order_reference_id": "merchant_order_ref_123",
      "amount": 1000,
      "connector": "wise",
      "payout_method_data": {
        "card": {
          "card_exp_month": "01",
          "card_exp_year": "2026",
          "card_holder_name": "John Doe"
        }
      },
      "source_bank_data": {
        "card": {
          "card_exp_month": "01",
          "card_exp_year": "2026",
          "card_holder_name": "John Doe"
        }
      },
      "billing": {
        "address": {
          "city": "New York",
          "line1": "123, King Street",
          "line2": "Powelson Avenue",
          "line3": "Bridgewater",
          "zip": "08807",
          "state": "New York",
          "first_name": "John",
          "last_name": "Doe",
          "origin_zip": "08807"
        },
        "phone": {
          "number": "9123456789",
          "country_code": "+1"
        }
      },
      "auto_fulfill": true,
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "customer": {
        "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
        "name": "John Doe",
        "email": "johntest@test.com",
        "phone": "9123456789",
        "phone_country_code": "+1",
        "customer_document_details": {
          "document_number": "12345678911"
        }
      },
      "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
      "return_url": "https://hyperswitch.io",
      "business_label": "food",
      "description": "It's my first payout request",
      "merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
      "error_message": "Failed while verifying the card",
      "error_code": "E0001",
      "created": "2022-09-10T10:11:12Z",
      "connector_transaction_id": "S3FC9G9M2MVFDXT5",
      "attempts": [
        {
          "amount": 6583,
          "unified_code": "UE_000",
          "unified_message": "Invalid card details"
        }
      ],
      "email": "johntest@test.com",
      "name": "John Test",
      "phone": "9123456789",
      "phone_country_code": "+1",
      "unified_code": "UE_000",
      "unified_message": "Invalid card details"
    }
  ]
}