Overview
Your First Payment
Payment Operations
Advanced Features
Webhooks & Events
Outgoing webhook
The merchant id of the merchant
The unique event id for each webhook
payment_succeeded, payment_failed, payment_processing, payment_cancelled, payment_authorized, payment_captured, 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 - PaymentsResponse
- RefundResponse
- DisputeResponse
- MandateResponse
- PayoutCreateResponse
Show child attributes
Show child attributes
payment_details Show child attributes
Show child attributes
Unique identifier for the payment. This ensures idempotency for multiple payments that have been done by a single merchant.
30"pay_mbabizu24mvu3mela5njyhpit4"
This is an identifier for the merchant account. This is inferred from the API key provided during the request
255"merchant_1668273825"
The status of the current payment that was made
succeeded, failed, cancelled, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable 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.,
6540
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
6540
The maximum amount that could be captured from the payment
x >= 1006540
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
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 Indicates the type of payment method. Eg: 'card', 'wallet', etc.
pay_later Total number of attempts associated with this payment
The shipping cost for the payment.
6540
The amount which is already captured from the payment, this helps in the cases where merchants can't capture all capturable amount at once.
6540
The amount that has been cancelled from the payment
The connector used for the payment
"svea"
It's a token used for client side verification.
"pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo"
Time when the payment was created
"2022-09-10T10:11:12Z"
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
1 - 64"cus_y3oqhf46pyzuxjbcn2giaqnb44"
Details of customer attached to this payment
Show child attributes
Show child attributes
The identifier for the customer.
1 - 64"cus_y3oqhf46pyzuxjbcn2giaqnb44"
The customer's name
255"John Doe"
The customer's phone number
10"9123456789"
The country code for the customer's phone number
2"+1"
A description of the payment
"It's my first payment request"
List of refunds that happened on this intent, as same payment intent can have multiple refund requests depending on the nature of order
Show child attributes
Show child attributes
Unique Identifier for the refund
The payment id against which refund is initiated
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
x >= 1006540
The three-letter ISO currency code
The status for refunds
succeeded, failed, pending, review The connector used for the refund and the corresponding payment
"stripe"
An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive
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
The error message
The code for the error
Error code unified across the connectors is received here if there was an error while calling connector
Error message unified across the connectors is received here if there was an error while calling connector
The timestamp at which refund is created
The timestamp at which refund is updated
The id of business profile for this refund
The merchant_connector_id of the processor through which this payment went through
Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.
Show child attributes
Show child attributes
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
Show child attributes
Toggle for reverting the application fee that was collected for the payment. If set to false, the funds are pulled from the destination account.
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.
List of disputes that happened on this intent
Show child attributes
Show child attributes
The identifier for dispute
Stage of the dispute
pre_dispute, dispute, pre_arbitration Status of the dispute
dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost Status of the dispute sent by connector
Dispute id sent by connector
Time at which dispute is received
Reason of dispute sent by connector
Reason code of dispute sent by connector
Evidence deadline of dispute sent by connector
Dispute created time sent by connector
Dispute updated time sent by connector
List of attempts that happened on this intent
Show child attributes
Show child attributes
Unique identifier for the attempt
The status of the attempt
started, authentication_failed, router_declined, authentication_pending, authentication_successful, authorized, authorization_failed, charged, authorizing, cod_initiated, voided, void_initiated, capture_initiated, capture_failed, void_failed, auto_refunded, partial_charged, partial_charged_and_chargeable, unresolved, pending, failure, payment_method_awaited, confirmation_awaited, device_data_collection_pending 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.,
6540
Time at which the payment attempt was created
"2022-09-10T10:11:12Z"
Time at which the payment attempt was last modified
"2022-09-10T10:11:12Z"
The payment attempt tax_amount.
6540
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
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 The connector used for the payment
If there was an error while calling the connector, the error message is received here
Indicates the type of payment method. Eg: 'card', 'wallet', etc.
pay_later A unique identifier for a payment provided by the connector
Default value if not passed is set to 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors
automatic, manual, manual_multiple, scheduled, sequential_automatic Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set
three_ds, no_three_ds If the payment was cancelled the reason will be provided here
A unique identifier to link the payment to a mandate, can be use instead of payment_method_data
If there was an error while calling the connectors the error code is received here
Provide a reference to a stored payment method
Additional data related to some connectors
To indicate the type of payment experience that the customer would go through
redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp Indicates the sub type of payment method. Eg: 'invoice' & 'direct_debit'.
direct_debit, installment_invoice, installment_direct_debit, invoice, subscription_invoice, subscription_direct_debit Reference to the payment at connector side
"993672945374576J"
(This field is not live yet)Error code unified across the connectors is received here if there was an error while calling connector
(This field is not live yet)Error message unified across the connectors is received here if there was an error while calling connector
Value passed in X-CLIENT-SOURCE header during payments confirm request by the client
Value passed in X-CLIENT-VERSION header during payments confirm request by the client
List of captures done on latest attempt
Show child attributes
Show child attributes
Unique identifier for the capture
started, charged, pending, failed 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.,
6540
The connector used for the payment
Unique identifier for the parent attempt on which this capture is made
Sequence number of this capture, in the series of captures made for the parent attempt
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
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 A unique identifier for this capture provided by the connector
If there was an error while calling the connector the error message is received here
If there was an error while calling the connectors the code is received here
If there was an error while calling the connectors the reason is received here
Reference to the capture at connector side
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
255"mandate_iwer89rnjef349dni3"
Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.
Show child attributes
Show child attributes
A way to update the mandate's payment method details
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
Show child attributes
This is used to indicate if the mandate was accepted online or offline
online, offline Specifying when the customer acceptance was provided
"2022-09-10T10:11:12Z"
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The maximum amount to be debited for the mandate transaction
6540
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
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 Specifying start date of the mandate
"2022-09-10T00:00:00Z"
Specifying end date of the mandate
"2023-09-10T23:59:59Z"
Additional details required by mandate
Indicates that you intend to make future payments with the payment methods used for this Payment. Providing this parameter will attach the payment method to the Customer, if present, after the Payment is confirmed and any required actions from the user are complete.
- On_session - Payment method saved only at hyperswitch when consent is provided by the user. CVV will asked during the returning user payment
- Off_session - Payment method saved at both hyperswitch and Processor when consent is provided by the user. No input is required during the returning user payment.
off_session, on_session 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.
true
A timestamp (ISO 8601 code) that determines when the payment should be captured.
Providing this field will automatically set capture to true
"2022-09-10T10:11:12Z"
Default value if not passed is set to 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors
automatic, manual, manual_multiple, scheduled, sequential_automatic - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indicates the card network.
Visa, Mastercard, AmericanExpress, JCB, DinersClub, Discover, CartesBancaires, UnionPay, Interac, RuPay, Maestro Show child attributes
Show child attributes
Address details
Show child attributes
Show child attributes
The address city
50"New York"
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 The first line of the address
200"123, King Street"
The second line of the address
50"Powelson Avenue"
The third line of the address
50"Bridgewater"
The zip/postal code for the address
50"08807"
The address state
"New York"
The first name for the address
255"John"
The last name for the address
255"Doe"
Provide a reference to a stored payment method
"187282ab-40ef-47a9-9206-5099ba31e432"
Show child attributes
Show child attributes
Address details
Show child attributes
Show child attributes
The address city
50"New York"
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 The first line of the address
200"123, King Street"
The second line of the address
50"Powelson Avenue"
The third line of the address
50"Bridgewater"
The zip/postal code for the address
50"08807"
The address state
"New York"
The first name for the address
255"John"
The last name for the address
255"Doe"
Show child attributes
Show child attributes
Address details
Show child attributes
Show child attributes
The address city
50"New York"
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 The first line of the address
200"123, King Street"
The second line of the address
50"Powelson Avenue"
The third line of the address
50"Bridgewater"
The zip/postal code for the address
50"08807"
The address state
"New York"
The first name for the address
255"John"
The last name for the address
255"Doe"
Information about the product , quantity and amount for connectors. (e.g. Klarna)
Show child attributes
Show child attributes
Name of the product that is being purchased
255"shirt"
The quantity of the product to be purchased
x >= 01
the amount per quantity of product, this is the amount before tax is added to it
total tax amount applicable to the product
The image URL of the product
The URL of the product
ID of the product that is being purchased
regular, shipping_costs, gift_card, discount, voucher, return_costs Sub category of the product that is being purchased
Brand of the product that is being purchased
physical, digital, travel, ride, event, accommodation Tax of the product in percentage
The tax code for the product
This Unit struct represents MinorUnit in which core amount works
"[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]"
description: The customer's email address
This field will be deprecated soon. Please refer to customer.email object
255description: The customer's name
This field will be deprecated soon. Please refer to customer.name object
255"John Test"
The customer's phone number
This field will be deprecated soon. Please refer to customer.phone object
255"9123456789"
The customer's date of birth
10"2025-01-31"
The customer's social security number
20"12-345-6789"
The customer's gender
10"female"
The customer's locale
5"de_DE"
The URL to redirect after the completion of the operation
"https://hyperswitch.io"
Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set
three_ds, no_three_ds 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.
255"Hyperswitch Router"
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 22 characters for the concatenated descriptor.
255"Payment for shoes purchase"
If the payment was cancelled the reason will be provided here
If there was an error while calling the connectors the code is received here
"E0001"
If there was an error while calling the connector the error message is received here
"Failed while verifying the card"
error code unified across the connectors is received here if there was an error while calling connector
error message unified across the connectors is received here if there was an error while calling connector
To indicate the type of payment experience that the customer would go through
redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp Indicates the sub type of payment method. Eg: 'invoice' & 'direct_debit'.
direct_debit, installment_invoice, installment_direct_debit, invoice, subscription_invoice, subscription_direct_debit The connector used for this payment along with the country and business details
"stripe_US_food"
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 The business label of merchant for this payment
The business_sub_label for this payment
Allowed Payment Method Types for a given PaymentIntent
Indicates the sub type of payment method. Eg: 'invoice' & 'direct_debit'.
direct_debit, installment_invoice, installment_direct_debit, invoice, subscription_invoice, subscription_direct_debit ephemeral_key for the customer_id mentioned
Show child attributes
Show child attributes
customer_id to which this ephemeral key belongs to
1 - 64"cus_y3oqhf46pyzuxjbcn2giaqnb44"
time at which this ephemeral key was created
time at which this ephemeral key would expire
ephemeral key
If true the payment can be retried with same or different payment method which means the confirm call can be made again.
A unique identifier for a payment provided by the connector
"993672945374576J"
frm message is an object sent inside the payments response...when frm is invoked, its value is Some(...), else its None
Show child attributes
Show child attributes
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.
Some connectors might require some additional information, find specific details in the child attributes below.
additional data that might be required by hyperswitch
Show child attributes
Show child attributes
Additional tags to be used for global search
Show child attributes
Show child attributes
A description of the recurring payment that Apple Pay displays to the user in the payment sheet
Show child attributes
Show child attributes
The label that Apple Pay displays to the user in the payment sheet with the recurring details
The date of the first payment
"2023-09-10T23:59:59Z"
The date of the final payment
"2023-09-10T23:59:59Z"
year, month, day, hour, minute The number of interval units that make up the total payment interval
A URL to a web page where the user can update or delete the payment method for the recurring payment
"https://hyperswitch.io"
A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment
reference(Identifier) to the payment at connector side
"993672945374576J"
The business profile that is associated with this payment
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
Identifier of the connector ( merchant connector account ) which was chosen to make the payment
If true, incremental authorization can be performed on this payment, in case the funds authorized initially fall short.
Total number of authorizations happened in an incremental_authorization payment
List of incremental authorizations happened to the payment
Show child attributes
Show child attributes
The unique identifier of authorization
Amount the authorization has been made for
6540
success, failure, processing, unresolved This Unit struct represents MinorUnit in which core amount works
Error code sent by the connector for authorization
Error message sent by the connector for authorization
Details of external authentication
Show child attributes
Show child attributes
started, pending, success, failed challenge, frictionless Electronic Commerce Indicator (eci)
DS Transaction ID
Message Version
Error Code
Error Message
Flag indicating if external 3ds authentication is made or not
Date Time for expiry of the payment
"2022-09-10T10:11:12Z"
Payment Fingerprint, to identify a particular card. It is a 20 character long alphanumeric code.
Browser information to be used for 3DS 2.0
Show child attributes
Show child attributes
Color depth supported by the browser
x >= 0Whether java is enabled in the browser
Whether javascript is enabled in the browser
Language supported
The screen height in pixels
x >= 0The screen width in pixels
x >= 0Time zone of the client
Ip address of the client
List of headers that are accepted
"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"
User-agent of the browser
The os type of the client device
The os version of the client device
The device model of the client
Identifier for Payment Method used for the payment
Payment Method Status
active, inactive, processing, awaiting_data Date time at which payment was updated
"2022-09-10T10:11:12Z"
Show child attributes
Show child attributes
Fee information to be charged on the payment being collected
Show child attributes
Show child attributes
Platform fees collected on the payment
6540
Identifier for the reseller's account where the funds were transferred
Identifier for charge created for the payment
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.
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.
255"Custom_Order_id_123"
This Unit struct represents MinorUnit in which core amount works
Connector Identifier for the payment method
The time at which webhook was sent