POST
/
payouts
/
{payout_id}
curl --request POST \
  --url https://sandbox.hyperswitch.io/payouts/{payout_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "amount": 1000,
  "currency": "AED",
  "routing": {
    "type": "single",
    "data": {
      "connector": "adyenplatform",
      "merchant_connector_id": "<string>"
    }
  },
  "connector": [
    "wise",
    "adyen"
  ],
  "confirm": true,
  "payout_type": "card",
  "payout_method_data": {
    "card": {
      "card_number": "4242424242424242",
      "expiry_month": "<string>",
      "expiry_year": "<string>",
      "card_holder_name": "John Doe"
    }
  },
  "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"
    },
    "phone": {
      "number": "9123456789",
      "country_code": "+1"
    },
    "email": "<string>"
  },
  "auto_fulfill": true,
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "John Doe",
    "email": "johntest@test.com",
    "phone": "9123456789",
    "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": false,
  "metadata": {},
  "payout_token": "187282ab-40ef-47a9-9206-5099ba31e432",
  "profile_id": "<string>",
  "priority": "instant",
  "payout_link": true,
  "payout_link_config": {
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "payout_link_id": "pm_collect_link_2bdacf398vwzq5n422S1",
    "enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\"]}]",
    "form_layout": "tabs",
    "test_mode": false
  },
  "session_expiry": 900,
  "email": "johntest@test.com",
  "name": "John Test",
  "phone": "9123456789",
  "phone_country_code": "+1",
  "payout_method_id": "<string>"
}'
{
  "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
  "merchant_id": "merchant_1668273825",
  "amount": 1000,
  "currency": "AED",
  "connector": "wise",
  "payout_type": "card",
  "payout_method_data": {
    "card": {
      "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>",
      "card_exp_month": "01",
      "card_exp_year": "2026",
      "card_holder_name": "John Doe"
    }
  },
  "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"
    },
    "phone": {
      "number": "9123456789",
      "country_code": "+1"
    },
    "email": "<string>"
  },
  "auto_fulfill": true,
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "John Doe",
    "email": "johntest@test.com",
    "phone": "9123456789",
    "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": false,
  "metadata": {},
  "merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
  "status": "success",
  "error_message": "Failed while verifying the card",
  "error_code": "E0001",
  "profile_id": "<string>",
  "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": "johntest@test.com",
  "name": "John Test",
  "phone": "9123456789",
  "phone_country_code": "+1",
  "unified_code": "UE_000",
  "unified_message": "Invalid card details",
  "payout_method_id": "<string>"
}

Authorizations

​
api-key
string
header
required

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.

Path Parameters

​
payout_id
string
required

The identifier for payout

Body

application/json

Response

200
application/json

Payout updated

The response is of type object.