Payouts

POST

payouts

list

curl --request POST \
  --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": "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.

Response

200 - application/json

size

integer

required

The number of payouts included in the list

data

object[]

required

data.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.

data.merchant_id

string

required

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

data.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.,

data.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

data.connector

string | null

The connector used for the payout

data.payout_type

enum<string>

Available options:

card,

bank,

wallet

data.billing

object | null

The billing address for the payout

data.customer_id

string

required

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

data.auto_fulfill

boolean

default: falserequired

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

data.email

string | null

description: The customer's email address

data.name

string | null

description: The customer's name

data.phone

string | null

The customer's phone number

data.phone_country_code

string | null

The country code for the customer phone number

data.client_secret

string

required

It's a token used for client side verification.

data.return_url

string

required

The URL to redirect after the completion of the operation

data.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

data.business_label

string | null

Business label of the merchant for this payout

data.description

string

required

A description of the payout

data.entity_type

enum<string>

required

Available options:

Individual,

Company,

NonProfit,

PublicSector,

NaturalPerson,

lowercase,

Personal

data.recurring

boolean | null

default: false

Specifies whether or not the payout request is recurring

data.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.

data.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

data.error_message

string

required

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

data.error_code

string

required

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

data.profile_id

string

required

The business profile that is associated with this payout

data.created

string | null

Time when the payout was created

data.connector_transaction_id

string | null

Underlying processor's payout resource ID

data.priority

enum<string>

Available options:

instant,

fast,

regular,

wire,

cross_border,

internal

data.attempts

object[] | null

List of attempts

data.attempts.attempt_id

string

required

Unique identifier for the attempt

data.attempts.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

data.attempts.amount

integer

required

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

data.attempts.currency

enum<string>

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

data.attempts.connector

string | null

The connector used for the payout

data.attempts.error_code

string | null

Connector's error code in case of failures

data.attempts.error_message

string | null

Connector's error message in case of failures

data.attempts.payment_method

enum<string>

Available options:

card,

bank,

wallet

data.attempts.payout_method_type

enum<string>

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Available options:

ach,

affirm,

afterpay_clearpay,

alfamart,

ali_pay,

ali_pay_hk,

alma,

apple_pay,

atome,

bacs,

bancontact_card,

becs,

benefit,

bizum,

blik,

boleto,

bca_bank_transfer,

bni_va,

bri_va,

card_redirect,

cimb_va,

classic,

credit,

crypto_currency,

cashapp,

dana,

danamon_va,

debit,

duit_now,

efecty,

eps,

fps,

evoucher,

giropay,

givex,

google_pay,

go_pay,

gcash,

ideal,

interac,

indomaret,

klarna,

kakao_pay,

local_bank_redirect,

mandiri_va,

knet,

mb_way,

mobile_pay,

momo,

momo_atm,

multibanco,

online_banking_thailand,

online_banking_czech_republic,

online_banking_finland,

online_banking_fpx,

online_banking_poland,

online_banking_slovakia,

oxxo,

pago_efectivo,

permata_bank_transfer,

open_banking_uk,

pay_bright,

paypal,

pix,

pay_safe_card,

przelewy24,

prompt_pay,

pse,

red_compra,

red_pagos,

samsung_pay,

sepa,

sofort,

swish,

touch_n_go,

trustly,

twint,

upi_collect,

upi_intent,

vipps,

viet_qr,

venmo,

walley,

we_chat_pay,

seven_eleven,

lawson,

mini_stop,

family_mart,

seicomart,

pay_easy,

local_bank_transfer,

mifinity

data.attempts.connector_transaction_id

string | null

A unique identifier for a payout provided by the connector

data.attempts.cancellation_reason

string | null

If the payout was cancelled the reason provided here

data.attempts.unified_code

string | null

error code unified across the connectors is received here if there was an error while calling connector

data.attempts.unified_message

string | null

error message unified across the connectors is received here if there was an error while calling connector

data.payout_link

object

Payouts - List Events - List

curl --request POST \
  --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": "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>"
      }
    }
  ]
}

Payments

Payment Methods

Customers

Mandates

Refunds

Disputes

Merchant Account

Business Profile

API Key

Merchant Connector Account

Event

GSM (Global Status Mapping)

Poll

Blocklist

Routing

Schemas

Payouts - Filter

Authorizations

Response