Payouts - List

Endpoint: GET /payouts/list

Overview: Retrieves a list of payouts.

Example cURL

curl

curl --request GET \
  --url https://sandbox.hyperswitch.io/payouts/list \
  --header 'api-key: <api-key>'

Example success response (200 application/json)

response.json

{
  "size": 1,
  "data": [
    {
      "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
      "merchant_id": "merchant_1668273825",
      "amount": 1000,
      "currency": "AED",
      "auto_fulfill": true,
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
      "return_url": "https://hyperswitch.io",
      "business_country": "AF",
      "entity_type": "Individual",
      "recurring": false,
      "status": "success",
      "profile_id": "<string>",
      "merchant_order_reference_id": "merchant_order_ref_123",
      "connector": "wise",
      "payout_type": "card",
      "payout_method_data": {
        "card": {
          "card_exp_month": "01",
          "card_exp_year": "2026",
          "card_holder_name": "John Doe",
          "card_issuer": "<string>",
          "card_network": "Visa",
          "card_type": "<string>",
          "card_issuing_country": "<string>",
          "bank_code": "<string>",
          "last4": "<string>",
          "card_isin": "<string>",
          "card_extended_bin": "<string>"
        }
      },
      "billing": {
        "address": {
          "city": "New York",
          "country": "AF",
          "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"
        },
        "email": "<string>"
      },
      "customer": {
        "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "9123456789",
        "phone_country_code": "+1"
      },
      "business_label": "food",
      "description": "It's my first payout request",
      "metadata": {},
      "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",
      "priority": "instant",
      "attempts": [
        {
          "attempt_id": "<string>",
          "status": "success",
          "amount": 6583,
          "currency": "AED",
          "connector": "<string>",
          "error_code": "<string>",
          "error_message": "<string>",
          "payment_method": "card",
          "payout_method_type": "ach",
          "connector_transaction_id": "<string>",
          "cancellation_reason": "<string>",
          "unified_code": "UE_000",
          "unified_message": "Invalid card details"
        }
      ],
      "payout_link": {
        "payout_link_id": "<string>",
        "link": "<string>"
      },
      "email": "[email protected]",
      "name": "John Test",
      "phone": "9123456789",
      "phone_country_code": "+1",
      "unified_code": "UE_000",
      "unified_message": "Invalid card details",
      "payout_method_id": "<string>"
    }
  ],
  "total_count": 123
}

Authorizations

api-key (string, header, required) Use the API key created under your merchant account from the HyperSwitch dashboard. The API key authenticates API requests from your merchant server only. Do not expose this key on a website or embed it in a mobile application.

Query Parameters

customer_id (string, required) The identifier for customer.
starting_after (string, required) A cursor for use in pagination: fetch the next list after some object.
ending_before (string, required) A cursor for use in pagination: fetch the previous list before some object.
limit (string, required) Limit on the number of objects to return.
created (string, required) The time at which payout is created.
time_range (string, required) The time range for which objects are needed. TimeRange has two fields start_time and end_time for filtering objects (e.g., created_at, time less than, greater than, etc).

Response (200 application/json)

size (integer, required) The number of payouts included in the list. Required range: x >= 0.
data (object[], required) The list of payout response objects (see example response for object structure).
total_count (integer | null) The total number of available payouts for given constraints.

Good afternoon