- POSTPayments - Create
- POSTPayments - Update
- POSTPayments - Confirm
- GETPayments - Retrieve
- POSTPayments - Cancel
- POSTPayments - Capture
- POSTPayments - Incremental Authorization
- POSTPayments - Session token
- GETPayments Link - Retrieve
- GETPayments - List
- POSTPayments - External 3DS Authentication
- POSTPayments - Complete Authorize
- POSTPaymentMethods - Create
- GETPayment Method - Retrieve
- POSTPayment Method - Update
- DELPayment Method - Delete
- GETPayment Method - Set Default Payment Method for Customer
- GETList payment methods for a Merchant
- GETList customer saved payment methods for a Payment
- GETList payment methods for a Customer
- GETPayment Method - Set Default Payment Method for Customer
- POSTCustomers - Create
- GETCustomers - Retrieve
- POSTCustomers - Update
- DELCustomers - Delete
- POSTCustomers - List
- POSTMandates - Revoke Mandate
- GETMandates - Retrieve Mandate
- POSTMandates - Customer Mandates List
- POSTMerchant Account - Create
- GETMerchant Account - Retrieve
- POSTMerchant Account - Update
- DELMerchant Account - Delete
- POSTMerchant Account - KV Status
- POSTBusiness Profile - Create
- POSTBusiness Profile - Update
- GETBusiness Profile - Retrieve
- DELBusiness Profile - Delete
- GETBusiness Profile - List
- POSTMerchant Connector - Create
- GETMerchant Connector - Retrieve
- POSTMerchant Connector - Update
- DELMerchant Connector - Delete
- GETMerchant Connector - List
- POSTPayouts - Create
- GETPayouts - Retrieve
- POSTPayouts - Update
- POSTPayouts - Cancel
- POSTPayouts - Fulfill
- GETPayouts - List
- POSTPayouts - Filter
- GETRouting - List
- POSTRouting - Create
- GETRouting - Retrieve Config
- POSTRouting - Deactivate
- GETRouting - Retrieve Default Config
- POSTRouting - Update Default Config
- GETRouting - Retrieve Default For Profile
- POSTRouting - Update Default For Profile
- GETRouting - Retrieve
- POSTRouting - Activate config
- Outgoing webhook
Payments
Payment Methods
Customers
Mandates
Merchant Account
Business Profile
Merchant Connector Account
Payouts
Routing
Schemas
Outgoing webhook
{
"merchant_id": "<string>",
"event_id": "<string>",
"event_type": "payment_succeeded",
"content": {
"type": "payment_details",
"object": {
"payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
"merchant_id": "merchant_1668273825",
"status": "succeeded",
"amount": 6540,
"net_amount": 6540,
"amount_capturable": 6540,
"amount_received": 6540,
"connector": "stripe",
"client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
"created": "2022-09-10T10:11:12Z",
"currency": "AED",
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1"
},
"description": "It's my first payment request",
"refunds": [
{
"refund_id": "<string>",
"payment_id": "<string>",
"amount": 6540,
"currency": "<string>",
"status": "succeeded",
"reason": "<string>",
"metadata": {},
"error_message": "<string>",
"error_code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"connector": "stripe",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"charges": {
"charge_id": "<string>",
"revert_platform_fee": true,
"revert_transfer": true
}
}
],
"disputes": [
{
"dispute_id": "<string>",
"dispute_stage": "pre_dispute",
"dispute_status": "dispute_opened",
"connector_status": "<string>",
"connector_dispute_id": "<string>",
"connector_reason": "<string>",
"connector_reason_code": "<string>",
"challenge_required_by": "2023-11-07T05:31:56Z",
"connector_created_at": "2023-11-07T05:31:56Z",
"connector_updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
],
"attempts": [
{
"attempt_id": "<string>",
"status": "started",
"amount": 6540,
"currency": "AED",
"connector": "<string>",
"error_message": "<string>",
"payment_method": "card",
"connector_transaction_id": "<string>",
"capture_method": "automatic",
"authentication_type": "three_ds",
"cancellation_reason": "<string>",
"mandate_id": "<string>",
"error_code": "<string>",
"payment_token": "<string>",
"connector_metadata": "<any>",
"payment_experience": "redirect_to_url",
"payment_method_type": "ach",
"reference_id": "993672945374576J",
"unified_code": "<string>",
"unified_message": "<string>",
"client_source": "<string>",
"client_version": "<string>"
}
],
"captures": [
{
"capture_id": "<string>",
"status": "started",
"amount": 6540,
"currency": "AED",
"connector": "<string>",
"authorized_attempt_id": "<string>",
"connector_capture_id": "<string>",
"capture_sequence": 123,
"error_message": "<string>",
"error_code": "<string>",
"error_reason": "<string>",
"reference_id": "<string>"
}
],
"mandate_id": "mandate_iwer89rnjef349dni3",
"mandate_data": {
"update_mandate_id": "<string>",
"customer_acceptance": {
"acceptance_type": "online",
"accepted_at": "2022-09-10T10:11:12Z",
"online": {
"ip_address": "123.32.25.123",
"user_agent": "<string>"
}
},
"mandate_type": {
"single_use": {
"amount": 6540,
"currency": "AED",
"start_date": "2022-09-10T00:00:00Z",
"end_date": "2023-09-10T23:59:59Z",
"metadata": {}
}
}
},
"setup_future_usage": "off_session",
"off_session": true,
"capture_on": "2022-09-10T10:11:12Z",
"capture_method": "automatic",
"payment_method": "card",
"payment_method_data": {
"card": {
"last4": "<string>",
"card_type": "<string>",
"card_network": "Visa",
"card_issuer": "<string>",
"card_issuing_country": "<string>",
"card_isin": "<string>",
"card_extended_bin": "<string>",
"card_exp_month": "<string>",
"card_exp_year": "<string>",
"card_holder_name": "<string>",
"payment_checks": "<any>",
"authentication_data": "<any>"
},
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
}
},
"payment_token": "187282ab-40ef-47a9-9206-5099ba31e432",
"shipping": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"order_details": "[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]",
"email": "johntest@test.com",
"name": "John Test",
"phone": "9123456789",
"return_url": "https://hyperswitch.io",
"authentication_type": "three_ds",
"statement_descriptor_name": "Hyperswitch Router",
"statement_descriptor_suffix": "Payment for shoes purchase",
"next_action": {
"redirect_to_url": "<string>",
"type": "redirect_to_url"
},
"cancellation_reason": "<string>",
"error_code": "E0001",
"error_message": "Failed while verifying the card",
"unified_code": "<string>",
"unified_message": "<string>",
"payment_experience": "redirect_to_url",
"payment_method_type": "ach",
"connector_label": "stripe_US_food",
"business_country": "AF",
"business_label": "<string>",
"business_sub_label": "<string>",
"allowed_payment_method_types": [
"ach"
],
"ephemeral_key": {
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"created_at": 123,
"expires": 123,
"secret": "<string>"
},
"manual_retry_allowed": true,
"connector_transaction_id": "993672945374576J",
"frm_message": {
"frm_name": "<string>",
"frm_transaction_id": "<string>",
"frm_transaction_type": "<string>",
"frm_status": "<string>",
"frm_score": 123,
"frm_reason": "<any>",
"frm_error": "<string>"
},
"metadata": {},
"connector_metadata": {
"apple_pay": {
"session_token_data": {
"payment_processing_certificate": "<string>",
"payment_processing_certificate_key": "<string>",
"payment_processing_details_at": "Hyperswitch",
"certificate": "<string>",
"certificate_keys": "<string>",
"merchant_identifier": "<string>",
"display_name": "<string>",
"initiative": "web",
"initiative_context": "<string>",
"merchant_business_country": "AF"
}
},
"airwallex": {
"payload": "<string>"
},
"noon": {
"order_category": "<string>"
}
},
"feature_metadata": {
"redirect_response": {
"param": "<string>",
"json_payload": {}
}
},
"reference_id": "993672945374576J",
"payment_link": {
"link": "<string>",
"payment_link_id": "<string>"
},
"profile_id": "<string>",
"surcharge_details": {
"surcharge_amount": 6540,
"tax_amount": 123
},
"attempt_count": 123,
"merchant_decision": "<string>",
"merchant_connector_id": "<string>",
"incremental_authorization_allowed": true,
"authorization_count": 123,
"incremental_authorizations": [
{
"authorization_id": "<string>",
"amount": 6540,
"status": "success",
"error_code": "<string>",
"error_message": "<string>",
"previously_authorized_amount": 123
}
],
"external_authentication_details": {
"authentication_flow": "challenge",
"electronic_commerce_indicator": "<string>",
"status": "started",
"ds_transaction_id": "<string>",
"version": "<string>",
"error_code": "<string>",
"error_message": "<string>"
},
"external_3ds_authentication_attempted": true,
"expires_on": "2022-09-10T10:11:12Z",
"fingerprint": "<string>",
"browser_info": {
"color_depth": 1,
"java_enabled": true,
"java_script_enabled": true,
"language": "<string>",
"screen_height": 1,
"screen_width": 1,
"time_zone": 123,
"ip_address": "<string>",
"accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
"user_agent": "<string>"
},
"payment_method_id": "<string>",
"payment_method_status": "active",
"updated": "2022-09-10T10:11:12Z",
"charges": {
"charge_id": "<string>",
"charge_type": {
"Stripe": "direct"
},
"application_fees": 6540,
"transfer_account_id": "<string>"
},
"frm_metadata": {}
}
},
"timestamp": "2023-11-07T05:31:56Z"
}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 payment_details Unique identifier for the payment. This ensures idempotency for multiple payments that have been done by a single merchant.
This is an identifier for the merchant account. This is inferred from the API key provided during the request
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.,
The payment net amount. net_amount = amount + surcharge_details.surcharge_amount + surcharge_details.tax_amount, If no surcharge_details, net_amount = amount
The maximum amount that could be captured from the payment
The amount which is already captured from the payment, this helps in the cases where merchants can't capture all capturable amount at once.
The connector used for the payment
It's a token used for client side verification.
Time when the payment was created
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW 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
Details of customer attached to this payment
The identifier for the customer.
The customer's name
The customer's email address
The customer's phone number
The country code for the customer's phone number
A description of the payment
List of refunds that happened on this intent, as same payment intent can have multiple refund requests depending on the nature of order
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
The three-letter ISO currency code
The status for refunds
succeeded, failed, pending, review 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
The timestamp at which refund is created
The timestamp at which refund is updated
The connector used for the refund and the corresponding payment
The id of business profile for this refund
The merchant_connector_id of the processor through which this payment went through
Charge object for refunds
Identifier for charge created for the payment
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 dispute that happened on this intent
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
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
Time at which dispute is received
List of attempts that happened on this intent
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.,
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW 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.
card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card 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 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 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 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 Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, boleto, bca_bank_transfer, bni_va, bri_va, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eps, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, paypal, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, vipps, viet_qr, venmo, walley, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity reference to the payment at connector side
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
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
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.,
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The connector used for the payment
unique identifier for the parent attempt on which this capture is made
A unique identifier for a capture provided by the connector
sequence number of this capture
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
A way to update the mandate's payment method details
We will be Passing this "CustomerAcceptance" object during Payments-Confirm. The customer_acceptance sub object is usually passed by the SDK or client
This is used to indicate if the mandate was accepted online or offline
online, offline Specifying when the customer acceptance was provided
Ip address of the customer machine from which the mandate was created
The user-agent of the customer's browser
The maximum amount to be debited for the mandate transaction
The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Specifying start date of the mandate
Specifying end date of the mandate
Additional details required by mandate
Indicates that you intend to make future payments with this Payment’s payment method. 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.
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.
A timestamp (ISO 8601 code) that determines when the payment should be captured.
Providing this field will automatically set capture to true
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 Indicates the type of payment method. Eg: 'card', 'wallet', etc.
card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card Indicates the card network.
Visa, Mastercard, AmericanExpress, JCB, DinersClub, Discover, CartesBancaires, UnionPay, Interac, RuPay, Maestro Address details
The address city
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
The second line of the address
The third line of the address
The zip/postal code for the address
The address state
The first name for the address
The last name for the address
The contact number
The country code attached to the number
Provide a reference to a stored payment method
Address details
The address city
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
The second line of the address
The third line of the address
The zip/postal code for the address
The address state
The first name for the address
The last name for the address
The contact number
The country code attached to the number
Address details
The address city
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
The second line of the address
The third line of the address
The zip/postal code for the address
The address state
The first name for the address
The last name for the address
The contact number
The country code attached to the number
Information about the product , quantity and amount for connectors. (e.g. Klarna)
Name of the product that is being purchased
The quantity of the product to be purchased
the amount per quantity of product
The image URL of the product
ID of the product that is being purchased
Category of the product that is being purchased
Sub category of the product that is being purchased
Brand of the product that is being purchased
physical, digital, travel, ride, event, accommodation description: The customer's email address
This field will be deprecated soon. Please refer to customer.email object
description: The customer's name
This field will be deprecated soon. Please refer to customer.name object
The customer's phone number
This field will be deprecated soon. Please refer to customer.phone object
The URL to redirect after the completion of the operation
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.
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.
Contains the url for redirection flow
redirect_to_url If the payment was cancelled the reason provided here
If there was an error while calling the connectors the code is received here
If there was an error while calling the connector the error message is received here
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 Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, boleto, bca_bank_transfer, bni_va, bri_va, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eps, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, paypal, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, vipps, viet_qr, venmo, walley, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity The connector used for this payment along with the country and business details
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
ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, boleto, bca_bank_transfer, bni_va, bri_va, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eps, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, paypal, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, vipps, viet_qr, venmo, walley, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity ephemeral_key for the customer_id mentioned
customer_id to which this ephemeral key belongs to
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
frm message is an object sent inside the payments response...when frm is invoked, its value is Some(...), else its None
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.
additional data related to some connectors
Hyperswitch web, ios 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 payload required by airwallex
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)
additional data that might be required by hyperswitch
reference(Identifier) to the payment at connector side
The business profile that is associated with this payment
details of surcharge applied on this payment, if applicable
This Unit struct represents MinorUnit in which core amount works
total number of attempts 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
The unique identifier of authorization
Amount the authorization has been made for
success, failure, processing, unresolved Error code sent by the connector for authorization
Error message sent by the connector for authorization
This Unit struct represents MinorUnit in which core amount works
Details of external authentication
challenge, frictionless Electronic Commerce Indicator (eci)
started, pending, success, failed 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
Payment Fingerprint, to identify a particular card. It is a 20 character long alphanumeric code.
Browser information to be used for 3DS 2.0
Color depth supported by the browser
Whether java is enabled in the browser
Whether javascript is enabled in the browser
Language supported
The screen height in pixels
The screen width in pixels
Time zone of the client
Ip address of the client
List of headers that are accepted
User-agent of the browser
Identifier for Payment Method
Payment Method Status
active, inactive, processing, awaiting_data Date time at which payment was updated
Fee information to be charged on the payment being collected
Identifier for charge created for the payment
direct, destination Platform fees collected on the payment
Identifier for the reseller's account where the funds were transferred
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.
The time at which webhook was sent
{
"merchant_id": "<string>",
"event_id": "<string>",
"event_type": "payment_succeeded",
"content": {
"type": "payment_details",
"object": {
"payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
"merchant_id": "merchant_1668273825",
"status": "succeeded",
"amount": 6540,
"net_amount": 6540,
"amount_capturable": 6540,
"amount_received": 6540,
"connector": "stripe",
"client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
"created": "2022-09-10T10:11:12Z",
"currency": "AED",
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1"
},
"description": "It's my first payment request",
"refunds": [
{
"refund_id": "<string>",
"payment_id": "<string>",
"amount": 6540,
"currency": "<string>",
"status": "succeeded",
"reason": "<string>",
"metadata": {},
"error_message": "<string>",
"error_code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"connector": "stripe",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"charges": {
"charge_id": "<string>",
"revert_platform_fee": true,
"revert_transfer": true
}
}
],
"disputes": [
{
"dispute_id": "<string>",
"dispute_stage": "pre_dispute",
"dispute_status": "dispute_opened",
"connector_status": "<string>",
"connector_dispute_id": "<string>",
"connector_reason": "<string>",
"connector_reason_code": "<string>",
"challenge_required_by": "2023-11-07T05:31:56Z",
"connector_created_at": "2023-11-07T05:31:56Z",
"connector_updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
],
"attempts": [
{
"attempt_id": "<string>",
"status": "started",
"amount": 6540,
"currency": "AED",
"connector": "<string>",
"error_message": "<string>",
"payment_method": "card",
"connector_transaction_id": "<string>",
"capture_method": "automatic",
"authentication_type": "three_ds",
"cancellation_reason": "<string>",
"mandate_id": "<string>",
"error_code": "<string>",
"payment_token": "<string>",
"connector_metadata": "<any>",
"payment_experience": "redirect_to_url",
"payment_method_type": "ach",
"reference_id": "993672945374576J",
"unified_code": "<string>",
"unified_message": "<string>",
"client_source": "<string>",
"client_version": "<string>"
}
],
"captures": [
{
"capture_id": "<string>",
"status": "started",
"amount": 6540,
"currency": "AED",
"connector": "<string>",
"authorized_attempt_id": "<string>",
"connector_capture_id": "<string>",
"capture_sequence": 123,
"error_message": "<string>",
"error_code": "<string>",
"error_reason": "<string>",
"reference_id": "<string>"
}
],
"mandate_id": "mandate_iwer89rnjef349dni3",
"mandate_data": {
"update_mandate_id": "<string>",
"customer_acceptance": {
"acceptance_type": "online",
"accepted_at": "2022-09-10T10:11:12Z",
"online": {
"ip_address": "123.32.25.123",
"user_agent": "<string>"
}
},
"mandate_type": {
"single_use": {
"amount": 6540,
"currency": "AED",
"start_date": "2022-09-10T00:00:00Z",
"end_date": "2023-09-10T23:59:59Z",
"metadata": {}
}
}
},
"setup_future_usage": "off_session",
"off_session": true,
"capture_on": "2022-09-10T10:11:12Z",
"capture_method": "automatic",
"payment_method": "card",
"payment_method_data": {
"card": {
"last4": "<string>",
"card_type": "<string>",
"card_network": "Visa",
"card_issuer": "<string>",
"card_issuing_country": "<string>",
"card_isin": "<string>",
"card_extended_bin": "<string>",
"card_exp_month": "<string>",
"card_exp_year": "<string>",
"card_holder_name": "<string>",
"payment_checks": "<any>",
"authentication_data": "<any>"
},
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
}
},
"payment_token": "187282ab-40ef-47a9-9206-5099ba31e432",
"shipping": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"order_details": "[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]",
"email": "johntest@test.com",
"name": "John Test",
"phone": "9123456789",
"return_url": "https://hyperswitch.io",
"authentication_type": "three_ds",
"statement_descriptor_name": "Hyperswitch Router",
"statement_descriptor_suffix": "Payment for shoes purchase",
"next_action": {
"redirect_to_url": "<string>",
"type": "redirect_to_url"
},
"cancellation_reason": "<string>",
"error_code": "E0001",
"error_message": "Failed while verifying the card",
"unified_code": "<string>",
"unified_message": "<string>",
"payment_experience": "redirect_to_url",
"payment_method_type": "ach",
"connector_label": "stripe_US_food",
"business_country": "AF",
"business_label": "<string>",
"business_sub_label": "<string>",
"allowed_payment_method_types": [
"ach"
],
"ephemeral_key": {
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"created_at": 123,
"expires": 123,
"secret": "<string>"
},
"manual_retry_allowed": true,
"connector_transaction_id": "993672945374576J",
"frm_message": {
"frm_name": "<string>",
"frm_transaction_id": "<string>",
"frm_transaction_type": "<string>",
"frm_status": "<string>",
"frm_score": 123,
"frm_reason": "<any>",
"frm_error": "<string>"
},
"metadata": {},
"connector_metadata": {
"apple_pay": {
"session_token_data": {
"payment_processing_certificate": "<string>",
"payment_processing_certificate_key": "<string>",
"payment_processing_details_at": "Hyperswitch",
"certificate": "<string>",
"certificate_keys": "<string>",
"merchant_identifier": "<string>",
"display_name": "<string>",
"initiative": "web",
"initiative_context": "<string>",
"merchant_business_country": "AF"
}
},
"airwallex": {
"payload": "<string>"
},
"noon": {
"order_category": "<string>"
}
},
"feature_metadata": {
"redirect_response": {
"param": "<string>",
"json_payload": {}
}
},
"reference_id": "993672945374576J",
"payment_link": {
"link": "<string>",
"payment_link_id": "<string>"
},
"profile_id": "<string>",
"surcharge_details": {
"surcharge_amount": 6540,
"tax_amount": 123
},
"attempt_count": 123,
"merchant_decision": "<string>",
"merchant_connector_id": "<string>",
"incremental_authorization_allowed": true,
"authorization_count": 123,
"incremental_authorizations": [
{
"authorization_id": "<string>",
"amount": 6540,
"status": "success",
"error_code": "<string>",
"error_message": "<string>",
"previously_authorized_amount": 123
}
],
"external_authentication_details": {
"authentication_flow": "challenge",
"electronic_commerce_indicator": "<string>",
"status": "started",
"ds_transaction_id": "<string>",
"version": "<string>",
"error_code": "<string>",
"error_message": "<string>"
},
"external_3ds_authentication_attempted": true,
"expires_on": "2022-09-10T10:11:12Z",
"fingerprint": "<string>",
"browser_info": {
"color_depth": 1,
"java_enabled": true,
"java_script_enabled": true,
"language": "<string>",
"screen_height": 1,
"screen_width": 1,
"time_zone": 123,
"ip_address": "<string>",
"accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
"user_agent": "<string>"
},
"payment_method_id": "<string>",
"payment_method_status": "active",
"updated": "2022-09-10T10:11:12Z",
"charges": {
"charge_id": "<string>",
"charge_type": {
"Stripe": "direct"
},
"application_fees": 6540,
"transfer_account_id": "<string>"
},
"frm_metadata": {}
}
},
"timestamp": "2023-11-07T05:31:56Z"
}