GET
/
payouts
/
list
curl --request GET \
  --url https://sandbox.hyperswitch.io/payouts/list \
  --header 'api-key: <api-key>'
{
  "size": 1,
  "data": [
    {
      "payout_id": "payout_mbabizu24mvu3mela5njyhpit4",
      "merchant_id": "merchant_1668273825",
      "amount": 1000,
      "currency": "AED",
      "connector": "wise",
      "payout_type": "card",
      "billing": {},
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "auto_fulfill": true,
      "email": "johntest@test.com",
      "name": "John Test",
      "phone": "3141592653",
      "phone_country_code": "+1",
      "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
      "return_url": "https://hyperswitch.io",
      "business_country": "AF",
      "business_label": "food",
      "description": "It's my first payout request",
      "entity_type": "Individual",
      "recurring": true,
      "metadata": {},
      "status": "success",
      "error_message": "Failed while verifying the card",
      "error_code": "E0001",
      "profile_id": "<string>",
      "created": "2022-09-10T10:11:12Z",
      "attempts": [
        {
          "attempt_id": "<string>",
          "status": "success",
          "amount": 123,
          "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": "<string>",
          "unified_message": "<string>"
        }
      ]
    }
  ]
}

Authorizations

api-key
string
headerrequired

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Response

200 - application/json
size
integer
required

The number of payouts included in the list

data
object[]
required