Payouts

POST

payouts

list

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.

Body

application/json

A type representing a range of time for filtering, including a mandatory start time and an optional end time.

currency

enum<string>

required

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

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

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,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

entity_type

enum<string>

required

Type of entity to whom the payout is being carried out to, select from the given list of options

Available options:

Individual,

Company,

NonProfit,

PublicSector,

NaturalPerson,

lowercase,

Personal

start_time

string

required

The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed

connector

enum<string>[] | null

The list of connectors to filter payouts list

Available options:

adyen,

adyenplatform,

cybersource,

ebanx,

payone,

paypal,

stripe,

wise

customer_id

string | null

The identifier for customer

end_time

string | null

The end time to filter payments list or to get list of filters. If not passed the default time is now

limit

integer

The limit on the number of objects. The default limit is 10 and max limit is 20

Required range: x > 0

offset

integer | null

The starting point within a list of objects

Required range: x > 0

payout_id

string | null

The identifier for payout

Required string length: 30

payout_method

enum<string>[] | null

The list of payout methods to filter payouts list

Available options:

card,

bank,

wallet

profile_id

string | null

The identifier for business profile

status

enum<string>[] | null

The list of payout status to filter payouts list

Available options:

success,

failed,

cancelled,

initiated,

expired,

reversed,

pending,

ineligible,

requires_creation,

requires_confirmation,

requires_payout_method_data,

requires_fulfillment,

requires_vendor_account_creation

Response

200 - application/json

data

object[]

required

The list of payouts response objects

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

boolean

default:

false

required

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

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

string

required

It's a token used for client side verification.

data.currency

enum<string>

required

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

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

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,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

data.customer_id

string

required

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

Maximum length: 255

data.entity_type

enum<string>

required

Type of entity to whom the payout is being carried out to, select from the given list of options

Available options:

Individual,

Company,

NonProfit,

PublicSector,

NaturalPerson,

lowercase,

Personal

data.merchant_id

string

required

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

Maximum length: 255

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.

Required string length: 30

data.profile_id

string

required

The business profile that is associated with this payout

data.recurring

boolean

default:

false

required

Specifies whether or not the payout request is recurring

data.return_url

string

required

The URL to redirect after the completion of the operation

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

object[] | null

List of attempts

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

string | null

If the payout was cancelled the reason provided here

data.attempts.connector

string | null

The connector used for the payout

data.attempts.connector_transaction_id

string | null

A unique identifier for a payout provided by the connector

data.attempts.currency

enum<string>

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

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

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,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

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>

The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.

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,

paze,

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,

open_banking_pis,

direct_carrier_billing

data.attempts.unified_code

string | null

(This field is not live yet) Error code unified across the connectors is received here in case of errors while calling the underlying connector

Maximum length: 255

data.attempts.unified_message

string | null

(This field is not live yet) Error message unified across the connectors is received here in case of errors while calling the underlying connector

Maximum length: 1024

data.billing

object

data.billing.address

object

Address details

data.billing.email

string | null

data.billing.phone

object

data.business_label

string | null

Business label of the merchant for this payout

data.connector

string | null

The connector used for the payout

data.connector_transaction_id

string | null

Underlying processor's payout resource ID

data.created

string | null

Time when the payout was created

data.customer

object

Details of customer attached to this payment

data.description

string | null

A description of the payout

data.email

string | null

deprecated

Customer's email. Deprecated: Use customer object instead.

Maximum length: 255

data.error_code

string | null

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

data.error_message

string | null

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

data.merchant_connector_id

string | null

Unique identifier of the merchant connector account

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

string | null

deprecated

Customer's name. Deprecated: Use customer object instead.

Maximum length: 255

data.payout_link

object

data.payout_method_data

object

The payout method information for response

data.payout_type

enum<string>

Available options:

card,

bank,

wallet

data.phone

string | null

deprecated

Customer's phone. Deprecated: Use customer object instead.

Maximum length: 255

data.phone_country_code

string | null

deprecated

Customer's phone country code. Deprecated: Use customer object instead.

Maximum length: 255

data.priority

enum<string>

The send method which will be required for processing payouts, check options for better understanding.

Available options:

instant,

fast,

regular,

wire,

cross_border,

internal

data.unified_code

string | null

(This field is not live yet) Error code unified across the connectors is received here in case of errors while calling the underlying connector

Maximum length: 255

data.unified_message

string | null

(This field is not live yet) Error message unified across the connectors is received here in case of errors while calling the underlying connector

Maximum length: 1024

size

integer

required

The number of payouts included in the list

Required range: x > 0

total_count

integer | null

The total number of available payouts for given constraints

Payouts - List available filters Events - List

Payments

Payment Methods

Customers

Mandates

Refunds

Disputes

Organization

Merchant Account

Business Profile

API Key

Merchant Connector Account

Event

GSM (Global Status Mapping)

Poll

Blocklist

Routing

Relay

Schemas

Payouts - List using filters

Authorizations

Body

Response