POST
/
payouts
/
{payout_id}
/
fulfill
curl --request POST \
  --url https://sandbox.hyperswitch.io/payouts/{payout_id}/fulfill \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "payout_id": "payout_mbabizu24mvu3mela5njyhpit4"
}'
{
  "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": "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": true,
  "metadata": {},
  "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": "<string>",
      "unified_message": "<string>"
    }
  ],
  "payout_link": {
    "payout_link_id": "<string>",
    "link": "<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.

Path Parameters

payout_id
string
required

The identifier for payout

Body

application/json
payout_id
string
required

Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response.

Response

200 - application/json
payout_id
string
required

Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response.

merchant_id
string
required

This is an identifier for the merchant account. This is inferred from the API key provided during the request

amount
integer
required

The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,

currency
enum<string>
required

The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

Available options:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
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,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
connector
string | null

The connector used for the payout

payout_type
enum<string>
Available options:
card,
bank,
wallet
billing
object | null

The billing address for the payout

customer_id
string
required

The identifier for the customer object. If not provided the customer ID will be autogenerated.

auto_fulfill
boolean
default: falserequired

Set to true to confirm the payout without review, no further action required

email
string | null

description: The customer's email address

name
string | null

description: The customer's name

phone
string | null

The customer's phone number

phone_country_code
string | null

The country code for the customer phone number

client_secret
string
required

It's a token used for client side verification.

return_url
string
required

The URL to redirect after the completion of the operation

business_country
enum<string>
required
Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW,
US
business_label
string | null

Business label of the merchant for this payout

description
string
required

A description of the payout

entity_type
enum<string>
required
Available options:
Individual,
Company,
NonProfit,
PublicSector,
NaturalPerson,
lowercase,
Personal
recurring
boolean | null
default: false

Specifies whether or not the payout request is recurring

metadata
object | null

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

status
enum<string>
required
Available options:
success,
failed,
cancelled,
initiated,
expired,
reversed,
pending,
ineligible,
requires_creation,
requires_confirmation,
requires_payout_method_data,
requires_fulfillment,
requires_vendor_account_creation
error_message
string
required

If there was an error while calling the connector the error message is received here

error_code
string
required

If there was an error while calling the connectors the code is received here

profile_id
string
required

The business profile that is associated with this payout

created
string | null

Time when the payout was created

connector_transaction_id
string | null

Underlying processor's payout resource ID

priority
enum<string>
Available options:
instant,
fast,
regular,
wire,
cross_border,
internal
attempts
object[] | null

List of attempts

payout_link
object