Overview
Your First Payment
Payment Operations
Advanced Features
Webhooks & Events
{
"merchant_id": "<string>",
"event_id": "<string>",
"event_type": "payment_succeeded",
"content": {
"type": "payment_details",
"object": {
"payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
"merchant_id": "merchant_1668273825",
"status": "requires_confirmation",
"amount": 6540,
"net_amount": 6540,
"amount_capturable": 6540,
"currency": "AED",
"payment_method": "pay_later",
"attempt_count": 123,
"amount_received": 6540,
"amount_cancelled": 123,
"connector": "svea",
"client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
"created": "2022-09-10T10:11:12Z",
"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",
"connector": "stripe",
"reason": "<string>",
"metadata": {},
"error_message": "<string>",
"error_code": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"order_details": [
{
"product_name": "shirt",
"quantity": 1,
"amount": 123,
"requires_shipping": true,
"product_img_link": "<string>",
"product_link": "<string>",
"product_id": "<string>",
"category": "regular",
"sub_category": "<string>",
"brand": "<string>",
"product_type": "physical",
"tax_percentage": 123,
"product_tax_code": "<string>",
"tax_amount": 123
}
],
"capture_id": "<string>"
}
],
"disputes": [
{
"dispute_id": "<string>",
"dispute_stage": "pre_dispute",
"dispute_status": "dispute_opened",
"connector_status": "<string>",
"connector_dispute_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"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"
}
],
"attempts": [
{
"attempt_id": "<string>",
"status": "started",
"amount": 6540,
"created_at": "2022-09-10T10:11:12Z",
"modified_at": "2022-09-10T10:11:12Z",
"order_tax_amount": 6540,
"currency": "AED",
"connector": "<string>",
"error_message": "<string>",
"payment_method": "pay_later",
"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": "<unknown>",
"payment_experience": "redirect_to_url",
"payment_method_type": "direct_debit",
"reference_id": "993672945374576J",
"unified_code": "<string>",
"unified_message": "<string>",
"client_source": "<string>",
"client_version": "<string>"
}
],
"captures": [
{
"capture_id": "<string>",
"status": "started",
"amount": 6540,
"connector": "<string>",
"authorized_attempt_id": "<string>",
"capture_sequence": 123,
"currency": "AED",
"order_details": [
{
"product_name": "shirt",
"quantity": 1,
"amount": 123,
"requires_shipping": true,
"product_img_link": "<string>",
"product_link": "<string>",
"product_id": "<string>",
"category": "regular",
"sub_category": "<string>",
"brand": "<string>",
"product_type": "physical",
"tax_percentage": 123,
"product_tax_code": "<string>",
"tax_amount": 123
}
],
"connector_capture_id": "<string>",
"error_message": "<string>",
"error_code": "<string>",
"error_reason": "<string>",
"reference_id": "<string>"
}
],
"mandate_id": "mandate_iwer89rnjef349dni3",
"mandate_data": {
"update_mandate_id": "<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_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": "<unknown>",
"authentication_data": "<unknown>"
},
"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",
"birth_date": "2025-01-31",
"ssn": "12-345-6789",
"gender": "female",
"locale": "de_DE",
"return_url": "https://hyperswitch.io",
"signed_checkout_token": "eyJkIjp7InMiOiJzaG9wXzEyMyIsInAiOiJwYXlfYWJjMTIzIiwiYyI6InBheV9hYmMxMjNfc2VjcmV0X3h5eiIsInIiOiJodHRwczovL2V4YW1wbGUuY29tL3JldHVybiIsIngiOiJodHRwczovL2V4YW1wbGUuY29tL2NhbmNlbCIsInQiOjE3MDUwMDAwMDB9LCJzaWciOiJhYmNkZWZnaGlqa2xtbm9wcXJzdHV2d3h5eiJ9",
"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": "direct_debit",
"connector_label": "stripe_US_food",
"business_country": "AF",
"business_label": "<string>",
"business_sub_label": "<string>",
"allowed_payment_method_types": [
"direct_debit"
],
"manual_retry_allowed": true,
"connector_transaction_id": "993672945374576J",
"metadata": {},
"connector_metadata": {},
"feature_metadata": {
"redirect_response": {
"param": "<string>",
"json_payload": {}
},
"search_tags": [
"<string>"
]
},
"reference_id": "993672945374576J",
"profile_id": "<string>",
"merchant_decision": "<string>",
"merchant_connector_id": "<string>",
"incremental_authorization_allowed": true,
"authorization_count": 123,
"incremental_authorizations": [
{
"authorization_id": "<string>",
"amount": 6540,
"status": "success",
"previously_authorized_amount": 123,
"error_code": "<string>",
"error_message": "<string>"
}
],
"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>",
"os_type": "<string>",
"os_version": "<string>",
"device_model": "<string>",
"device_fingerprint": {
"payla": "<string>",
"ratepay": "<string>",
"unzer": "<string>"
}
},
"payment_method_id": "<string>",
"payment_method_status": "active",
"updated": "2022-09-10T10:11:12Z",
"merchant_order_reference_id": "Custom_Order_id_123",
"order_tax_amount": 123,
"connector_mandate_id": "<string>"
}
},
"timestamp": "2023-11-07T05:31:56Z"
}Webhooks & Events
Outgoing webhook
Documentation Index
Fetch the complete documentation index at: https://docs.bnplx.io/llms.txt
Use this file to discover all available pages before exploring further.
The merchant id of the merchant
The unique event id for each webhook
Available options:
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 - PaymentsResponse
- RefundResponse
- DisputeResponse
- MandateResponse
Show child attributes
Show child attributes
The time at which webhook was sent
⌘I