Outgoing webhook

merchant_id · string · required

The merchant id of the merchant

event_id · string · required

The unique event id for each webhook

event_type · enum<string> · required

Available options: payment_succeeded, payment_failed, payment_processing, payment_cancelled, payment_cancelled_post_capture, payment_authorized, payment_partially_authorized, payment_captured, payment_expired, action_required, refund_succeeded, refund_failed, dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost, mandate_active, mandate_revoked, payout_success, payout_failed, payout_initiated, payout_processing, payout_cancelled, payout_expired, payout_reversed, invoice_paid

content · PaymentsResponse · object · required

PaymentsResponse

Show child attributes

content. type · enum<string> · required

Available options: payment_details

content. object · object · required

Show child attributes

content.object. payment_id · string · required

Unique identifier for the payment. This ensures idempotency for multiple payments that have been done by a single merchant.

Required string length: 30

Example:

"pay_mbabizu24mvu3mela5njyhpit4"

content.object. merchant_id · string · required

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

Maximum string length: 255

Example:

"merchant_1668273825"

content.object. status · enum<string> · default: requires_confirmation · required

Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).

Available options: succeeded, failed, cancelled, cancelled_post_capture, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable, partially_authorized_and_requires_capture, conflicted, expired

content.object. amount · integer<int64> · required

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

Example:

6540

content.object. net_amount · integer<int64> · required

The payment net amount. net_amount = amount + surcharge_details.surcharge_amount + surcharge_details.tax_amount + shipping_cost + order_tax_amount, If no surcharge_details, shipping_cost, order_tax_amount, net_amount = amount

Example:

6540

content.object. amount_capturable · integer<int64> · required

The amount (in minor units) that can still be captured for this payment. This is relevant when capture_method is manual. Once fully captured, or if capture_method is automatic and payment succeeded, this will be 0.

Required range: x >= 100

Example:

6540

content.object. currency · enum<string> · required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

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, CLF, CLP, CNY, COP, CRC, CUC, 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, STD, 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

content.object. payment_method · enum<string> · required

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Available options: card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card, open_banking, mobile_payment

content.object. attempt_count · integer<int32> · required

Total number of attempts associated with this payment

content.object. shipping_cost · integer<int64> | null

The shipping cost for the payment.

Example:

6540

content.object. amount_received · integer<int64> | null

The total amount (in minor units) that has been captured for this payment. For fauxpay sandbox connector, this might reflect the authorized amount if status is succeeded even if capture_method was manual.

Example:

6540

content.object. connector · string | null

The name of the payment connector (e.g., 'stripe', 'adyen') that processed or is processing this payment.

Example:

"stripe"

content.object. client_secret · string | null

A secret token unique to this payment intent. It is primarily used by client-side applications (e.g., Hyperswitch SDKs) to authenticate actions like confirming the payment or handling next actions. This secret should be handled carefully and not exposed publicly beyond its intended client-side use.

Example:

"pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo"

content.object. created · string<date-time> | null

Timestamp indicating when this payment intent was created, in ISO 8601 format.

Example:

"2022-09-10T10:11:12Z"

content.object. customer_id · string | null · deprecated

The identifier for the customer object. If not provided the customer ID will be autogenerated. This field will be deprecated soon. Please refer to customer.id

Required string length: 1 - 64

Example:

"cus_y3oqhf46pyzuxjbcn2giaqnb44"

content.object. customer · object

Details of customer attached to this payment

Show child attributes

content.object.customer. id · string | null

The identifier for the customer.

Required string length: 1 - 64

Example:

"cus_y3oqhf46pyzuxjbcn2giaqnb44"

content.object.customer. name · string | null

The customer's name

Maximum string length: 255

Example:

"John Doe"

content.object.customer. email · string | null

The customer's email address

Maximum string length: 255

Example:

"[e-mail]"

content.object.customer. phone · string | null

The customer's phone number

Maximum string length: 10

Example:

"9123456789"

content.object.customer. phone_country_code · string | null

The country code for the customer's phone number

Maximum string length: 2

Example:

"+1"

content.object. description · string | null

An arbitrary string providing a description for the payment, often useful for display or internal record-keeping.

Example:

"It's my first payment request"

content.object. refunds · object[] | null

An array of refund objects associated with this payment. Empty or null if no refunds have been processed.

Show child attributes

content.object.refunds. refund_id · string · required

Unique Identifier for the refund

content.object.refunds. payment_id · string · required

The payment id against which refund is initiated

content.object.refunds. amount · integer<int64> · required

The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc

Required range: x >= 100

Example:

6540

content.object.refunds. currency · string · required

The three-letter ISO currency code

content.object.refunds. status · enum<string> · required

The status for refunds

Available options: succeeded, failed, pending, review

content.object.refunds. connector · string · required

The connector used for the refund and the corresponding payment

Example:

"stripe"

content.object.refunds. reason · string | null

An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive

content.object.refunds. metadata · object

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

content.object.refunds. error_message · string | null

The error message

content.object.refunds. error_code · string | null

The code for the error

content.object.refunds. unified_code · string | null

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

content.object.refunds. unified_message · string | null

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

content.object.refunds. created_at · string<date-time> | null

The timestamp at which refund is created

content.object.refunds. updated_at · string<date-time> | null

The timestamp at which refund is updated

content.object.refunds. profile_id · string | null

The id of business profile for this refund

content.object.refunds. merchant_connector_id · string | null

The merchant_connector_id of the processor through which this payment went through

content.object.refunds. split_refunds · object

Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.

Option 1

Show child attributes

content.object.refunds.split_refunds. stripe_split_refund · object · required

Charge specific fields for controlling the revert of funds from either platform or connected account for Stripe. Check sub-fields for more details.

Show child attributes

content.object.refunds.split_refunds.stripe_split_refund. revert_platform_fee · boolean | null

Toggle for reverting the application fee that was collected for the payment. If set to false, the funds are pulled from the destination account.

content.object.refunds.split_refunds.stripe_split_refund. revert_transfer · boolean | null

Toggle for reverting the transfer that was made during the charge. If set to false, the funds are pulled from the main platform's account.

content.object.refunds. issuer_error_code · string | null

Error code received from the issuer in case of failed refunds

content.object.refunds. issuer_error_message · string | null

Error message received from the issuer in case of failed refunds

content.object.refunds. raw_connector_response · string | null

Contains whole connector response

content.object. disputes · object[] | null

List of disputes that happened on this intent

Show child attributes

content.object.disputes. dispute_id · string · required

The identifier for dispute

content.object.disputes. dispute_stage · enum<string> · required

Stage of the dispute

Available options: pre_dispute, dispute, pre_arbitration, arbitration, dispute_reversal

content.object.disputes. dispute_status · enum<string> · required

Status of the dispute

Available options: dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost

content.object.disputes. connector_status · string · required

Status of the dispute sent by connector

content.object.disputes. connector_dispute_id · string · required

Dispute id sent by connector

content.object.disputes. created_at · string<date-time> · required

Time at which dispute is received

content.object.disputes. connector_reason · string | null

Reason of dispute sent by connector

content.object.disputes. connector_reason_code · string | null

Reason code of dispute sent by connector

content.object.disputes. challenge_required_by · string<date-time> | null

Evidence deadline of dispute sent by connector

content.object.disputes. connector_created_at · string<date-time> | null

Dispute created time sent by connector

content.object.disputes. connector_updated_at · string<date-time> | null

Dispute updated time sent by connector

content.object. attempts · object[] | null

List of attempts that happened on this intent

Show child attributes

content.object.attempts. attempt_id · string · required

A unique identifier for this specific payment attempt.

content.object.attempts. status · enum<string> · required

The status of the attempt

Available options: started, authentication_failed, router_declined, authentication_pending, authentication_successful, authorized, authorization_failed, charged, authorizing, cod_initiated, voided, voided_post_charge, void_initiated, capture_initiated, capture_failed, void_failed, auto_refunded, partial_charged, partially_authorized, partial_charged_and_chargeable, unresolved, pending, failure, payment_method_awaited, confirmation_awaited, device_data_collection_pending, integrity_failure, expired

content.object.attempts. amount · integer<int64> · required

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

Example:

6540

content.object.attempts. created_at · string<date-time> · required

Time at which the payment attempt was created

Example:

"2022-09-10T10:11:12Z"

content.object.attempts. modified_at · string<date-time> · required

Time at which the payment attempt was last modified

Example:

"2022-09-10T10:11:12Z"

content.object.attempts. order_tax_amount · integer<int64> | null

The payment attempt tax_amount.

Example:

6540

content.object.attempts. currency · enum<string>

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

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, CLF, CLP, CNY, COP, CRC, CUC, 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, STD, 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

content.object.attempts. connector · string | null

The name of the payment connector (e.g., 'stripe', 'adyen') used for this attempt.

content.object.attempts. error_message · string | null

A human-readable message from the connector explaining the error, if one occurred during this payment attempt.

content.object.attempts. payment_method · enum<string>

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Available options: card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card, open_banking, mobile_payment

content.object.attempts. connector_transaction_id · string | null

A unique identifier for a payment provided by the connector

content.object.attempts. capture_method · enum<string>

Specifies how the payment is captured.

• automatic: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.
• manual: Funds are authorized but not captured. A separate request to the /payments/{payment_id}/capture endpoint is required to capture the funds.

Available options: automatic, manual, manual_multiple, scheduled, sequential_automatic

content.object.attempts. authentication_type · enum<string> · default: three_ds

Specifies the type of cardholder authentication to be applied for a payment.

• ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
• NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.

Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.

Available options: three_ds, no_three_ds

content.object.attempts. cancellation_reason · string | null

If the payment was cancelled the reason will be provided here

content.object.attempts. mandate_id · string | null

If this payment attempt is associated with a mandate (e.g., for a recurring or subsequent payment), this field will contain the ID of that mandate.

content.object.attempts. error_code · string | null

The error code returned by the connector if this payment attempt failed. This code is specific to the connector.

content.object.attempts. payment_token · string | null

If a tokenized (saved) payment method was used for this attempt, this field contains the payment token representing that payment method.

content.object.attempts. connector_metadata · any | null

Additional data related to some connectors

content.object.attempts. payment_experience · enum<string>

To indicate the type of payment experience that the customer would go through

Available options: redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp

content.object.attempts. payment_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, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eps, flexiti, 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, payjustnow, paypal, paze, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, 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, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer

content.object.attempts. reference_id · string | null

The connector's own reference or transaction ID for this specific payment attempt. Useful for reconciliation with the connector.

Example:

"993672945374576J"

content.object.attempts. unified_code · string | null

(This field is not live yet)Error code unified across the connectors is received here if there was an error while calling connector

content.object.attempts. unified_message · string | null

(This field is not live yet)Error message unified across the connectors is received here if there was an error while calling connector

content.object.attempts. client_source · string | null

Value passed in X-CLIENT-SOURCE header during payments confirm request by the client

content.object.attempts. client_version · string | null

Value passed in X-CLIENT-VERSION header during payments confirm request by the client

content.object. captures · object[] | null

List of captures done on latest attempt

Show child attributes

content.object.captures. capture_id · string · required

A unique identifier for this specific capture operation.

content.object.captures. status · enum<string> · required

Available options: started, charged, pending, failed

content.object.captures. amount · integer<int64> · required

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

Example:

6540

content.object.captures. connector · string · required

The name of the payment connector that processed this capture.

content.object.captures. authorized_attempt_id · string · required

The ID of the payment attempt that was successfully authorized and subsequently captured by this operation.

content.object.captures. capture_sequence · integer<int32> · required

Sequence number of this capture, in the series of captures made for the parent attempt

content.object.captures. currency · enum<string>

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

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, CLF, CLP, CNY, COP, CRC, CUC, 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, STD, 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

content.object.captures. connector_capture_id · string | null

A unique identifier for this capture provided by the connector

content.object.captures. error_message · string | null

A human-readable message from the connector explaining why this capture operation failed, if applicable.

content.object.captures. error_code · string | null

The error code returned by the connector if this capture operation failed. This code is connector-specific.

content.object.captures. error_reason · string | null

A more detailed reason from the connector explaining the capture failure, if available.

content.object.captures. reference_id · string | null

The connector's own reference or transaction ID for this specific capture operation. Useful for reconciliation.

content.object. mandate_id · string | null

A unique identifier to link the payment to a mandate, can be used instead of payment_method_data, in case of setting up recurring payments

Maximum string length: 255

Example:

"mandate_iwer89rnjef349dni3"

content.object. mandate_data · object

Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.

Show child attributes

content.object.mandate_data. update_mandate_id · string | null

A way to update the mandate's payment method details

content.object.mandate_data. customer_acceptance · object

This "CustomerAcceptance" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.

Show child attributes

content.object.mandate_data.customer_acceptance. acceptance_type · enum<string> · required

This is used to indicate if the mandate was accepted online or offline

Available options: online, offline

content.object.mandate_data.customer_acceptance. accepted_at · string<date-time> | null

Specifying when the customer acceptance was provided

Example:

"2022-09-10T10:11:12Z"

content.object.mandate_data.customer_acceptance. online · object

Details of online mandate

Show child attributes

content.object.mandate_data.customer_acceptance.online. ip_address · string · required

Ip address of the customer machine from which the mandate was created

Example:

"123.32.25.123"

content.object.mandate_data.customer_acceptance.online. user_agent · string · required

The user-agent of the customer's browser

content.object.mandate_data. mandate_type · object

Option 1

Show child attributes

content.object.mandate_data.mandate_type. single_use · object · required

Show child attributes

content.object.mandate_data.mandate_type.single_use. amount · integer<int64> · required

The maximum amount to be debited for the mandate transaction

Example:

6540

content.object.mandate_data.mandate_type.single_use. currency · enum<string> · required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

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, CLF, CLP, CNY, COP, CRC, CUC, 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, STD, 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

content.object.mandate_data.mandate_type.single_use. start_date · string<date-time> | null

Specifying start date of the mandate

Example:

"2022-09-10T00:00:00Z"

content.object.mandate_data.mandate_type.single_use. end_date · string<date-time> | null

Specifying end date of the mandate

Example:

"2023-09-10T23:59:59Z"

content.object.mandate_data.mandate_type.single_use. metadata · object

Additional details required by mandate

content.object. setup_future_usage · enum<string>

Specifies how the payment method can be used for future payments.

• off_session: The payment method can be used for future payments when the customer is not present.
• on_session: The payment method is intended for use only when the customer is present during checkout. If omitted, defaults to on_session.

Available options: off_session, on_session

content.object. off_session · boolean | null

Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.

Example:

true

content.object. capture_on · string<date-time> | null

A timestamp (ISO 8601 code) that determines when the payment should be captured. Providing this field will automatically set capture to true

Example:

"2022-09-10T10:11:12Z"

content.object. capture_method · enum<string>

Specifies how the payment is captured.

• automatic: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.
• manual: Funds are authorized but not captured. A separate request to the /payments/{payment_id}/capture endpoint is required to capture the funds.

Available options: automatic, manual, manual_multiple, scheduled, sequential_automatic

content.object. payment_method_data · object

Option 1

Show child attributes

content.object.payment_method_data. card · object · required

Show child attributes

content.object.payment_method_data.card. last4 · string | null

content.object.payment_method_data.card. card_type · string | null

content.object.payment_method_data.card. card_network · enum<string>

Indicates the card network.

Available options: Visa, Mastercard, AmericanExpress, JCB, DinersClub, Discover, CartesBancaires, UnionPay, Interac, RuPay, Maestro, Star, Pulse, Accel, Nyce

content.object.payment_method_data.card. card_issuer · string | null

content.object.payment_method_data.card. card_issuing_country · string | null

content.object.payment_method_data.card. card_isin · string | null

content.object.payment_method_data.card. card_extended_bin · string | null

content.object.payment_method_data.card. card_exp_month · string | null

content.object.payment_method_data.card. card_exp_year · string | null

content.object.payment_method_data.card. card_holder_name · string | null

content.object.payment_method_data.card. payment_checks · unknown

content.object.payment_method_data.card. authentication_data · unknown

content.object.payment_method_data. billing · object

Show child attributes

content.object.payment_method_data.billing. address · object

Address details

Show child attributes

content.object.payment_method_data.billing.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

content.object.payment_method_data.billing.address. country · enum<string>

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

content.object.payment_method_data.billing.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

content.object.payment_method_data.billing.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

content.object.payment_method_data.billing.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

content.object.payment_method_data.billing.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

content.object.payment_method_data.billing.address. state · string | null

The address state

Example:

"New York"

content.object.payment_method_data.billing.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

content.object.payment_method_data.billing.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

content.object.payment_method_data.billing.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

content.object.payment_method_data.billing. phone · object

Show child attributes

content.object.payment_method_data.billing.phone. number · string | null

The contact number

Example:

"9123456789"

content.object.payment_method_data.billing.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

content.object.payment_method_data.billing. email · string | null

content.object. payment_token · string | null

Provide a reference to a stored payment method

Example:

"187282ab-40ef-47a9-9206-5099ba31e432"

content.object. shipping · object

Show child attributes

content.object.shipping. address · object

Address details

Show child attributes

content.object.shipping.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

content.object.shipping.address. country · enum<string>

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

content.object.shipping.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

content.object.shipping.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

content.object.shipping.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

content.object.shipping.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

content.object.shipping.address. state · string | null

The address state

Example:

"New York"

content.object.shipping.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

content.object.shipping.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

content.object.shipping.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

content.object.shipping. phone · object

Show child attributes

content.object.shipping.phone. number · string | null

The contact number

Example:

"9123456789"

content.object.shipping.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

content.object.shipping. email · string | null

content.object. billing · object

Show child attributes

content.object.billing. address · object

Address details

Show child attributes

content.object.billing.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

content.object.billing.address. country · enum<string>

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

content.object.billing.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

content.object.billing.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

content.object.billing.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

content.object.billing.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

content.object.billing.address. state · string | null

The address state

Example:

"New York"

content.object.billing.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

content.object.billing.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

content.object.billing.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

content.object.billing. phone · object

Show child attributes

content.object.billing.phone. number · string | null

The contact number

Example:

"9123456789"

content.object.billing.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

content.object.billing. email · string | null

content.object. order_details · object[] | null

Information about the product , quantity and amount for connectors. (e.g. Klarna)

Show child attributes

content.object.order_details. product_name · string · required

Name of the product that is being purchased

Maximum string length: 255

Example:

"shirt"

content.object.order_details. quantity · integer<int32> · required

The quantity of the product to be purchased

Required range: x >= 0

Example:

1

content.object.order_details. amount · integer<int64> · required

the amount per quantity of product

content.object.order_details. tax_rate · number<double> | null

tax rate applicable to the product

content.object.order_details. total_tax_amount · integer<int64> | null

total tax amount applicable to the product

content.object.order_details. requires_shipping · boolean | null

content.object.order_details. product_img_link · string | null

The image URL of the product

content.object.order_details. product_id · string | null

ID of the product that is being purchased

content.object.order_details. category · string | null

Category of the product that is being purchased

content.object.order_details. sub_category · string | null

Sub category of the product that is being purchased

content.object.order_details. brand · string | null

Brand of the product that is being purchased

content.object.order_details. product_type · enum<string>

Available options: physical, digital, travel, ride, event, accommodation

content.object.order_details. product_tax_code · string | null

The tax code for the product

content.object.order_details. description · string | null

Description for the item

content.object.order_details. sku · string | null

Stock Keeping Unit (SKU) or the item identifier for this item.

content.object.order_details. upc · string | null

Universal Product Code for the item.

content.object.order_details. commodity_code · string | null

Code describing a commodity or a group of commodities pertaining to goods classification.

content.object.order_details. unit_of_measure · string | null

Unit of measure used for the item quantity.

content.object.order_details. total_amount · integer<int64> | null

Total amount for the item.

content.object.order_details. unit_discount_amount · integer<int64> | null

Discount amount applied to this item.

Example:

"[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]"

content.object. email · string | null · deprecated

description: The customer's email address This field will be deprecated soon. Please refer to customer.email object

Maximum string length: 255

Example:

"[e-mail]"

content.object. name · string | null · deprecated

description: The customer's name This field will be deprecated soon. Please refer to customer.name object

Maximum string length: 255

Example:

"John Test"

content.object. phone · string | null · deprecated

The customer's phone number This field will be deprecated soon. Please refer to customer.phone object

Maximum string length: 255

Example:

"9123456789"

content.object. return_url · string | null

The URL to redirect after the completion of the operation

Example:

"https://hyperswitch.io"

content.object. authentication_type · enum<string> · default: three_ds

Specifies the type of cardholder authentication to be applied for a payment.

• ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
• NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.

Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.

Available options: three_ds, no_three_ds

content.object. statement_descriptor_name · string | null

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

Maximum string length: 255

Example:

"Hyperswitch Router"

content.object. statement_descriptor_suffix · string | null

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 255 characters for the concatenated descriptor.

Maximum string length: 255

Example:

"Payment for shoes purchase"

content.object. next_action · object

Contains the url for redirection flow

Option 1

Show child attributes

content.object.next_action. redirect_to_url · string · required

content.object.next_action. type · enum<string> · required

Available options: redirect_to_url

content.object. cancellation_reason · string | null

If the payment intent was cancelled, this field provides a textual reason for the cancellation (e.g., "requested_by_customer", "abandoned").

content.object. error_code · string | null

The connector-specific error code from the last failed payment attempt associated with this payment intent.

Example:

"E0001"

content.object. error_message · string | null

A human-readable error message from the last failed payment attempt associated with this payment intent.

Example:

"Failed while verifying the card"

content.object. error_reason · string | null

Example:

"Insufficient Funds"

content.object. unified_code · string | null

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

content.object. unified_message · string | null

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

content.object. payment_experience · enum<string>

To indicate the type of payment experience that the customer would go through

Available options: redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp

content.object. payment_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, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eps, flexiti, 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, payjustnow, paypal, paze, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, 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, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer

content.object. connector_label · string | null

A label identifying the specific merchant connector account (MCA) used for this payment. This often combines the connector name, business country, and a custom label (e.g., "stripe_US_primary").

Example:

"stripe_US_food"

content.object. business_country · enum<string>

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

content.object. business_label · string | null

The label identifying the specific business unit or profile under which this payment was processed by the merchant.

content.object. business_sub_label · string | null

An optional sub-label for further categorization of the business unit or profile used for this payment.

content.object. allowed_payment_method_types · enum<string>[] | null

Allowed Payment Method Types for a given PaymentIntent

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, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eps, flexiti, 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, payjustnow, paypal, paze, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, 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, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer

content.object. ephemeral_key · object

ephemeral_key for the customer_id mentioned

Show child attributes

content.object.ephemeral_key. customer_id · string · required

customer_id to which this ephemeral key belongs to

Required string length: 1 - 64

Example:

"cus_y3oqhf46pyzuxjbcn2giaqnb44"

content.object.ephemeral_key. created_at · integer<int64> · required

time at which this ephemeral key was created

content.object.ephemeral_key. expires · integer<int64> · required

time at which this ephemeral key would expire

content.object.ephemeral_key. secret · string · required

ephemeral key

content.object. manual_retry_allowed · boolean | null

If true the payment can be retried with same or different payment method which means the confirm call can be made again.

content.object. connector_transaction_id · string | null

A unique identifier for a payment provided by the connector

Example:

"993672945374576J"

content.object. frm_message · object

frm message is an object sent inside the payments response...when frm is invoked, its value is Some(...), else its None

Show child attributes

content.object.frm_message. frm_name · string · required

content.object.frm_message. frm_transaction_id · string | null

content.object.frm_message. frm_transaction_type · string | null

content.object.frm_message. frm_status · string | null

content.object.frm_message. frm_score · integer<int32> | null

content.object.frm_message. frm_reason · unknown

content.object.frm_message. frm_error · string | null

content.object. metadata · object

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.

content.object. connector_metadata · object

Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.

Show child attributes

content.object.connector_metadata. apple_pay · object

Show child attributes

content.object.connector_metadata.apple_pay. session_token_data · object

Option 1

Show child attributes

content.object.connector_metadata.apple_pay.session_token_data. payment_processing_certificate · string · required

content.object.connector_metadata.apple_pay.session_token_data. payment_processing_certificate_key · string · required

content.object.connector_metadata.apple_pay.session_token_data. payment_processing_details_at · enum<string> · required

Available options: Hyperswitch

content.object.connector_metadata.apple_pay.session_token_data. certificate · string · required

content.object.connector_metadata.apple_pay.session_token_data. certificate_keys · string · required

content.object.connector_metadata.apple_pay.session_token_data. merchant_identifier · string · required

content.object.connector_metadata.apple_pay.session_token_data. display_name · string · required

content.object.connector_metadata.apple_pay.session_token_data. initiative · enum<string> · required

Available options: web, ios

content.object.connector_metadata.apple_pay.session_token_data. initiative_context · string | null

content.object.connector_metadata.apple_pay.session_token_data. merchant_business_country · enum<string>

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

content.object.connector_metadata. airwallex · object

Show child attributes

content.object.connector_metadata.airwallex. payload · string | null

payload required by airwallex

content.object.connector_metadata. noon · object

Show child attributes

content.object.connector_metadata.noon. order_category · string | null

Information about the order category that merchant wants to specify at connector level. (e.g. In Noon Payments it can take values like "pay", "food", or any other custom string set by the merchant in Noon's Dashboard)

content.object.connector_metadata. braintree · object

Show child attributes

content.object.connector_metadata.braintree. merchant_account_id · string · required

Information about the merchant_account_id that merchant wants to specify at connector level.

content.object.connector_metadata.braintree. merchant_config_currency · string · required

Information about the merchant_config_currency that merchant wants to specify at connector level.

content.object.connector_metadata. adyen · object

Show child attributes

content.object.connector_metadata.adyen. testing · object · required

Show child attributes

content.object.connector_metadata.adyen.testing. holder_name · string · required

Holder name to be sent to Adyen for a card payment(CIT) or a generic payment(MIT). This value overrides the values for card.card_holder_name and applies during both CIT and MIT payment transactions.

content.object. feature_metadata · object

additional data that might be required by hyperswitch

Show child attributes

content.object.feature_metadata. redirect_response · object

Show child attributes

content.object.feature_metadata.redirect_response. param · string | null

content.object.feature_metadata.redirect_response. json_payload · object

content.object.feature_metadata. search_tags · string[] | null

Additional tags to be used for global search

content.object.feature_metadata. apple_pay_recurring_details · object

Show child attributes

content.object.feature_metadata.apple_pay_recurring_details. payment_description · string · required

A description of the recurring payment that Apple Pay displays to the user in the payment sheet

content.object.feature_metadata.apple_pay_recurring_details. regular_billing · object · required

Show child attributes

content.object.feature_metadata.apple_pay_recurring_details.regular_billing. label · string · required

The label that Apple Pay displays to the user in the payment sheet with the recurring details

content.object.feature_metadata.apple_pay_recurring_details.regular_billing. recurring_payment_start_date · string<date-time> | null

The date of the first payment

Example:

"2023-09-10T23:59:59Z"

content.object.feature_metadata.apple_pay_recurring_details.regular_billing. recurring_payment_end_date · string<date-time> | null

The date of the final payment

Example:

"2023-09-10T23:59:59Z"

content.object.feature_metadata.apple_pay_recurring_details.regular_billing. recurring_payment_interval_unit · enum<string>

Available options: year, month, day, hour, minute

content.object.feature_metadata.apple_pay_recurring_details.regular_billing. recurring_payment_interval_count · integer<int32> | null

The number of interval units that make up the total payment interval

content.object.feature_metadata.apple_pay_recurring_details. management_url · string · required

A URL to a web page where the user can update or delete the payment method for the recurring payment

Example:

"https://hyperswitch.io"

content.object.feature_metadata.apple_pay_recurring_details. billing_agreement · string | null

A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment

content.object. reference_id · string | null

reference(Identifier) to the payment at connector side

Example:

"993672945374576J"

content.object. payment_link · object

Show child attributes

content.object.payment_link. link · string · required

URL for rendering the open payment link

content.object.payment_link. payment_link_id · string · required

Identifier for the payment link

content.object.payment_link. secure_link · string | null

URL for rendering the secure payment link

content.object. profile_id · string | null

The business profile that is associated with this payment

content.object. surcharge_details · object

Details of surcharge applied on this payment, if applicable

Show child attributes

content.object.surcharge_details. surcharge_amount · integer<int64> · required

Example:

6540

content.object.surcharge_details. tax_amount · integer<int64>

This Unit struct represents MinorUnit in which core amount works

content.object. merchant_decision · string | null

Denotes the action(approve or reject) taken by merchant in case of manual review. Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment

content.object. merchant_connector_id · string | null

Identifier of the connector ( merchant connector account ) which was chosen to make the payment

content.object. incremental_authorization_allowed · boolean | null

If true, incremental authorization can be performed on this payment, in case the funds authorized initially fall short.

content.object. authorization_count · integer<int32> | null

Total number of authorizations happened in an incremental_authorization payment

content.object. incremental_authorizations · object[] | null

List of incremental authorizations happened to the payment

Show child attributes

content.object.incremental_authorizations. authorization_id · string · required

The unique identifier of authorization

content.object.incremental_authorizations. amount · integer<int64> · required

Amount the authorization has been made for

Example:

6540

content.object.incremental_authorizations. status · enum<string> · required

Available options: success, failure, processing, unresolved

content.object.incremental_authorizations. previously_authorized_amount · integer<int64> · required

This Unit struct represents MinorUnit in which core amount works

content.object.incremental_authorizations. error_code · string | null

Error code sent by the connector for authorization

content.object.incremental_authorizations. error_message · string | null

Error message sent by the connector for authorization

content.object. external_authentication_details · object

Details of external authentication

Show child attributes

content.object.external_authentication_details. status · enum<string> · required

Available options: started, pending, success, failed

content.object.external_authentication_details. authentication_flow · enum<string>

Available options: challenge, frictionless

content.object.external_authentication_details. electronic_commerce_indicator · string | null

Electronic Commerce Indicator (eci)

content.object.external_authentication_details. ds_transaction_id · string | null

DS Transaction ID

content.object.external_authentication_details. version · string | null

Message Version

content.object.external_authentication_details. error_code · string | null

Error Code

content.object.external_authentication_details. error_message · string | null

Error Message

content.object. external_3ds_authentication_attempted · boolean | null

Flag indicating if external 3ds authentication is made or not

content.object. expires_on · string<date-time> | null

Date Time for expiry of the payment

Example:

"2022-09-10T10:11:12Z"

content.object. fingerprint · string | null

Payment Fingerprint, to identify a particular card. It is a 20 character long alphanumeric code.

content.object. browser_info · object

Browser information to be used for 3DS 2.0

Show child attributes

content.object.browser_info. color_depth · integer<int32> | null

Color depth supported by the browser

Required range: x >= 0

content.object.browser_info. java_enabled · boolean | null

Whether java is enabled in the browser

content.object.browser_info. java_script_enabled · boolean | null

Whether javascript is enabled in the browser

content.object.browser_info. language · string | null

Language supported

content.object.browser_info. screen_height · integer<int32> | null

The screen height in pixels

Required range: x >= 0

content.object.browser_info. screen_width · integer<int32> | null

The screen width in pixels

Required range: x >= 0

content.object.browser_info. time_zone · integer<int32> | null

Time zone of the client

content.object.browser_info. ip_address · string | null

Ip address of the client

content.object.browser_info. accept_header · string | null

List of headers that are accepted

Example:

"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"

content.object.browser_info. user_agent · string | null

User-agent of the browser

content.object.browser_info. os_type · string | null

The os type of the client device

content.object.browser_info. os_version · string | null

The os version of the client device

content.object.browser_info. device_model · string | null

The device model of the client

content.object.browser_info. accept_language · string | null

Accept-language of the browser

content.object.browser_info. referer · string | null

Identifier of the source that initiated the request.

content.object. payment_channel

Describes the channel through which the payment was initiated.

Available options: ecommerce

content.object. payment_method_id · string | null

A unique identifier for the payment method used in this payment. If the payment method was saved or tokenized, this ID can be used to reference it for future transactions or recurring payments.

content.object. network_transaction_id · string | null

The network transaction ID is a unique identifier for the transaction as recognized by the payment network (e.g., Visa, Mastercard), this ID can be used to reference it for future transactions or recurring payments.

content.object. payment_method_status · enum<string>

Payment Method Status

Available options: active, inactive, processing, awaiting_data

content.object. updated · string<date-time> | null

Date time at which payment was updated

Example:

"2022-09-10T10:11:12Z"

content.object. split_payments · object

Charge Information

Option 1

Show child attributes

content.object.split_payments. stripe_split_payment · object · required

Fee information to be charged on the payment being collected via Stripe

Show child attributes

content.object.split_payments.stripe_split_payment. charge_type · object · required

Show child attributes

content.object.split_payments.stripe_split_payment.charge_type. Stripe · enum<string> · required

Available options: direct, destination

content.object.split_payments.stripe_split_payment. application_fees · integer<int64> · required

Platform fees collected on the payment

Example:

6540

content.object.split_payments.stripe_split_payment. transfer_account_id · string · required

Identifier for the reseller's account where the funds were transferred

content.object.split_payments.stripe_split_payment. charge_id · string | null

Identifier for charge created for the payment

content.object. frm_metadata · object

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

content.object. extended_authorization_applied · boolean | null

flag that indicates if extended authorization is applied on this payment or not

content.object. extended_authorization_last_applied_at · string<date-time> | null

date and time at which extended authorization was last applied on this payment

Example:

"2022-09-10T10:11:12Z"

content.object. request_extended_authorization · boolean | null · default: false

Optional boolean value to extent authorization period of this payment

capture method must be manual or manual_multiple

content.object. capture_before · string<date-time> | null

date and time after which this payment cannot be captured

content.object. merchant_order_reference_id · string | null

Merchant's identifier for the payment/invoice. This will be sent to the connector if the connector provides support to accept multiple reference ids. In case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.

Maximum string length: 255

Example:

"Custom_Order_id_123"

content.object. order_tax_amount · integer<int64>

This Unit struct represents MinorUnit in which core amount works

content.object. connector_mandate_id · string | null

Connector Identifier for the payment method

content.object. card_discovery · enum<string>

Indicates the method by which a card is discovered during a payment

Available options: manual, saved_card, click_to_pay

content.object. force_3ds_challenge · boolean | null

Indicates if 3ds challenge is forced

content.object. force_3ds_challenge_trigger · boolean | null

Indicates if 3ds challenge is triggered

content.object. issuer_error_code · string | null

Error code received from the issuer in case of failed payments

content.object. issuer_error_message · string | null

Error message received from the issuer in case of failed payments

content.object. is_iframe_redirection_enabled · boolean | null

Indicates if the redirection has to open in the iframe

content.object. whole_connector_response · string | null

Contains whole connector response

content.object. enable_partial_authorization · boolean | null · default: false

Allow partial authorization for this payment

content.object. enable_overcapture · boolean | null

Bool indicating if overcapture must be requested for this payment

content.object. is_overcapture_enabled · boolean | null

Boolean indicating whether overcapture is effectively enabled for this payment

content.object. network_details · object

Show child attributes

content.object.network_details. network_advice_code · string | null

content.object. is_stored_credential · boolean | null

Boolean flag indicating whether this payment method is stored and has been previously used for payments

Example:

true

content.object. mit_category · enum<string>

Available options: installment, unscheduled, recurring, resubmission

content.object. billing_descriptor · object

Billing Descriptor information to be sent to the payment gateway

Show child attributes

content.object.billing_descriptor. name · string | null

name to be put in billing description

Example:

"The Online Retailer"

content.object.billing_descriptor. city · string | null

city to be put in billing description

Example:

"San Francisco"

content.object.billing_descriptor. phone · string | null

phone to be put in billing description

Example:

"9123456789"

content.object.billing_descriptor. statement_descriptor · string | null

a short description for the payment

content.object.billing_descriptor. statement_descriptor_suffix · string | null

Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor.

content.object.billing_descriptor. reference · string | null

A reference to be shown on billing description

content.object. tokenization · enum<string>

The type of tokenization to use for the payment method

Available options: skip_psp, tokenize_at_psp

content.object. partner_merchant_identifier_details · object

Information identifying partner and merchant application initiating the request

Show child attributes

content.object.partner_merchant_identifier_details. partner_details · object

Information identifying partner / external platform details

Show child attributes

content.object.partner_merchant_identifier_details.partner_details. name · string | null

Name of the partner/external platform

content.object.partner_merchant_identifier_details.partner_details. version · string | null

Version of the partner/external platform

Example:

"1.0.0"

content.object.partner_merchant_identifier_details.partner_details. integrator · string | null

Integrator

content.object.partner_merchant_identifier_details. merchant_details · object

Information identifying merchant details

Show child attributes

content.object.partner_merchant_identifier_details.merchant_details. name · string | null

Name of the the merchant application

content.object.partner_merchant_identifier_details.merchant_details. version · string | null

Version of the merchant application

timestamp · string<date-time>

The time at which webhook was sent