curl --request PUT \
--url https://sandbox.birrpay.io/v2/payments/{id}/update-intent \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: <x-profile-id>' \
--data '
{
"amount_details": {
"currency": "USD",
"order_amount": 6540
}
}
'import requests
url = "https://sandbox.birrpay.io/v2/payments/{id}/update-intent"
payload = { "amount_details": {
"currency": "USD",
"order_amount": 6540
} }
headers = {
"X-Profile-Id": "<x-profile-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Profile-Id': '<x-profile-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount_details: {currency: 'USD', order_amount: 6540}})
};
fetch('https://sandbox.birrpay.io/v2/payments/{id}/update-intent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.birrpay.io/v2/payments/{id}/update-intent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount_details' => [
'currency' => 'USD',
'order_amount' => 6540
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"X-Profile-Id: <x-profile-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.birrpay.io/v2/payments/{id}/update-intent"
payload := strings.NewReader("{\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Profile-Id", "<x-profile-id>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://sandbox.birrpay.io/v2/payments/{id}/update-intent")
.header("X-Profile-Id", "<x-profile-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/v2/payments/{id}/update-intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "succeeded",
"amount_details": {
"order_amount": 6540,
"currency": "AED",
"external_tax_calculation": "skip",
"surcharge_calculation": "skip",
"shipping_cost": 123,
"order_tax_amount": 123,
"surcharge_amount": 123,
"tax_on_surcharge": 123,
"amount_captured": 123
},
"client_secret": "cs_0195b34da95d75239c6a4bf514458896",
"profile_id": "<string>",
"capture_method": "automatic",
"customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
"customer_present": "present",
"setup_future_usage": "off_session",
"apply_mit_exemption": "Apply",
"payment_link_enabled": "Enable",
"request_incremental_authorization": "true",
"split_txns_enabled": "skip",
"expires_on": "2023-11-07T05:31:56Z",
"request_external_three_ds_authentication": "Enable",
"payment_type": "normal",
"merchant_reference_id": "pay_mbabizu24mvu3mela5njyhpit4",
"routing_algorithm_id": "<string>",
"authentication_type": "three_ds",
"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",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"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",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"description": "It's my first payment request",
"return_url": "https://birrpay.io",
"statement_descriptor": "BirrPay Router",
"order_details": "[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]",
"allowed_payment_method_types": [
"ach"
],
"metadata": {},
"connector_metadata": {
"apple_pay": {
"session_token_data": {
"payment_processing_certificate": "<string>",
"payment_processing_certificate_key": "<string>",
"payment_processing_details_at": "BirrPay",
"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>"
},
"braintree": {
"merchant_account_id": "<string>",
"merchant_config_currency": "<string>"
},
"adyen": {
"testing": {
"holder_name": "<string>"
}
}
},
"feature_metadata": {
"redirect_response": {
"param": "<string>",
"json_payload": {}
},
"search_tags": [
"<string>"
],
"apple_pay_recurring_details": {
"payment_description": "<string>",
"regular_billing": {
"label": "<string>",
"recurring_payment_start_date": "2023-09-10T23:59:59Z",
"recurring_payment_end_date": "2023-09-10T23:59:59Z",
"recurring_payment_interval_unit": "year",
"recurring_payment_interval_count": 123
},
"management_url": "https://birrpay.io",
"billing_agreement": "<string>"
},
"revenue_recovery": {
"total_retry_count": "1",
"billing_connector_id": "mca_1234567890",
"active_attempt_payment_connector_id": "mca_1234567890",
"billing_connector_payment_details": {
"payment_processor_token": "<string>",
"connector_customer_id": "<string>"
},
"payment_method_type": "card",
"payment_method_subtype": "ach",
"connector": "authipay",
"billing_connector_payment_method_details": {
"type": "card",
"value": {
"card_network": "Visa",
"card_issuer": "JP MORGAN CHASE"
}
},
"payment_connector_transmission": "ConnectorCallUnsuccessful",
"invoice_next_billing_time": "2023-11-07T05:31:56Z",
"invoice_billing_started_at_time": "2023-11-07T05:31:56Z",
"first_payment_attempt_pg_error_code": "card_declined",
"first_payment_attempt_network_decline_code": "05",
"first_payment_attempt_network_advice_code": "02"
}
},
"payment_link_config": {
"theme": "#4E6ADD",
"logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
"seller_name": "hyperswitch",
"sdk_layout": "accordion",
"display_sdk_only": true,
"enabled_saved_payment_method": true,
"hide_card_nickname_field": true,
"show_card_form_by_default": true,
"transaction_details": [
{
"key": "Policy-Number",
"value": "297472368473924",
"ui_configuration": {
"position": 5,
"is_key_bold": true,
"is_value_bold": true
}
}
],
"background_image": {
"url": "https://birrpay.io/favicon.ico",
"position": "left",
"size": {
"Variants": "cover"
}
},
"details_layout": "layout1",
"payment_button_text": "<string>",
"custom_message_for_card_terms": "<string>",
"custom_message_for_payment_method_types": [
{
"payment_method": "card",
"payment_method_types": [
{
"message": {
"display_mode": "custom",
"value": "Sample message"
},
"payment_method_type": "credit"
}
]
}
],
"payment_button_colour": "<string>",
"skip_status_screen": true,
"payment_button_text_colour": "<string>",
"background_colour": "<string>",
"sdk_ui_rules": {},
"payment_link_ui_rules": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"is_setup_mandate_flow": true,
"color_icon_card_cvc_error": "<string>"
},
"frm_metadata": {},
"enable_partial_authorization": false
}Payments - Update Intent
Update a payment intent object
You will require the ‘API - Key’ from the BirrPay dashboard to make the call.
curl --request PUT \
--url https://sandbox.birrpay.io/v2/payments/{id}/update-intent \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: <x-profile-id>' \
--data '
{
"amount_details": {
"currency": "USD",
"order_amount": 6540
}
}
'import requests
url = "https://sandbox.birrpay.io/v2/payments/{id}/update-intent"
payload = { "amount_details": {
"currency": "USD",
"order_amount": 6540
} }
headers = {
"X-Profile-Id": "<x-profile-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Profile-Id': '<x-profile-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount_details: {currency: 'USD', order_amount: 6540}})
};
fetch('https://sandbox.birrpay.io/v2/payments/{id}/update-intent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.birrpay.io/v2/payments/{id}/update-intent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount_details' => [
'currency' => 'USD',
'order_amount' => 6540
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"X-Profile-Id: <x-profile-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.birrpay.io/v2/payments/{id}/update-intent"
payload := strings.NewReader("{\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Profile-Id", "<x-profile-id>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://sandbox.birrpay.io/v2/payments/{id}/update-intent")
.header("X-Profile-Id", "<x-profile-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/v2/payments/{id}/update-intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "succeeded",
"amount_details": {
"order_amount": 6540,
"currency": "AED",
"external_tax_calculation": "skip",
"surcharge_calculation": "skip",
"shipping_cost": 123,
"order_tax_amount": 123,
"surcharge_amount": 123,
"tax_on_surcharge": 123,
"amount_captured": 123
},
"client_secret": "cs_0195b34da95d75239c6a4bf514458896",
"profile_id": "<string>",
"capture_method": "automatic",
"customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
"customer_present": "present",
"setup_future_usage": "off_session",
"apply_mit_exemption": "Apply",
"payment_link_enabled": "Enable",
"request_incremental_authorization": "true",
"split_txns_enabled": "skip",
"expires_on": "2023-11-07T05:31:56Z",
"request_external_three_ds_authentication": "Enable",
"payment_type": "normal",
"merchant_reference_id": "pay_mbabizu24mvu3mela5njyhpit4",
"routing_algorithm_id": "<string>",
"authentication_type": "three_ds",
"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",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"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",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"description": "It's my first payment request",
"return_url": "https://birrpay.io",
"statement_descriptor": "BirrPay Router",
"order_details": "[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]",
"allowed_payment_method_types": [
"ach"
],
"metadata": {},
"connector_metadata": {
"apple_pay": {
"session_token_data": {
"payment_processing_certificate": "<string>",
"payment_processing_certificate_key": "<string>",
"payment_processing_details_at": "BirrPay",
"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>"
},
"braintree": {
"merchant_account_id": "<string>",
"merchant_config_currency": "<string>"
},
"adyen": {
"testing": {
"holder_name": "<string>"
}
}
},
"feature_metadata": {
"redirect_response": {
"param": "<string>",
"json_payload": {}
},
"search_tags": [
"<string>"
],
"apple_pay_recurring_details": {
"payment_description": "<string>",
"regular_billing": {
"label": "<string>",
"recurring_payment_start_date": "2023-09-10T23:59:59Z",
"recurring_payment_end_date": "2023-09-10T23:59:59Z",
"recurring_payment_interval_unit": "year",
"recurring_payment_interval_count": 123
},
"management_url": "https://birrpay.io",
"billing_agreement": "<string>"
},
"revenue_recovery": {
"total_retry_count": "1",
"billing_connector_id": "mca_1234567890",
"active_attempt_payment_connector_id": "mca_1234567890",
"billing_connector_payment_details": {
"payment_processor_token": "<string>",
"connector_customer_id": "<string>"
},
"payment_method_type": "card",
"payment_method_subtype": "ach",
"connector": "authipay",
"billing_connector_payment_method_details": {
"type": "card",
"value": {
"card_network": "Visa",
"card_issuer": "JP MORGAN CHASE"
}
},
"payment_connector_transmission": "ConnectorCallUnsuccessful",
"invoice_next_billing_time": "2023-11-07T05:31:56Z",
"invoice_billing_started_at_time": "2023-11-07T05:31:56Z",
"first_payment_attempt_pg_error_code": "card_declined",
"first_payment_attempt_network_decline_code": "05",
"first_payment_attempt_network_advice_code": "02"
}
},
"payment_link_config": {
"theme": "#4E6ADD",
"logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
"seller_name": "hyperswitch",
"sdk_layout": "accordion",
"display_sdk_only": true,
"enabled_saved_payment_method": true,
"hide_card_nickname_field": true,
"show_card_form_by_default": true,
"transaction_details": [
{
"key": "Policy-Number",
"value": "297472368473924",
"ui_configuration": {
"position": 5,
"is_key_bold": true,
"is_value_bold": true
}
}
],
"background_image": {
"url": "https://birrpay.io/favicon.ico",
"position": "left",
"size": {
"Variants": "cover"
}
},
"details_layout": "layout1",
"payment_button_text": "<string>",
"custom_message_for_card_terms": "<string>",
"custom_message_for_payment_method_types": [
{
"payment_method": "card",
"payment_method_types": [
{
"message": {
"display_mode": "custom",
"value": "Sample message"
},
"payment_method_type": "credit"
}
]
}
],
"payment_button_colour": "<string>",
"skip_status_screen": true,
"payment_button_text_colour": "<string>",
"background_colour": "<string>",
"sdk_ui_rules": {},
"payment_link_ui_rules": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"is_setup_mandate_flow": true,
"color_icon_card_cvc_error": "<string>"
},
"frm_metadata": {},
"enable_partial_authorization": false
}Authorizations
Format: api-key=<api_key>
Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Headers
Profile ID associated to the payment intent
Path Parameters
The unique identifier for the Payment Intent
Body
Show child attributes
Show child attributes
The routing algorithm id to be used for the payment
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}/captureendpoint is required to capture the funds.
automatic, manual, manual_multiple, scheduled, sequential_automatic 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.
three_ds, no_three_ds Show child attributes
Show child attributes
Show child attributes
Show child attributes
Set to present to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be absent when merchant's doing merchant initiated payments and customer is not present while doing the payment.
present, absent A description for the payment
"It's my first payment request"
The URL to which you want the user to be redirected after the completion of the payment operation
"https://birrpay.io"
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 toon_session.
off_session, on_session Apply, Skip 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.
22"BirrPay Router"
Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount
Show child attributes
Show child attributes
"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]"
Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent
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, 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, qris, 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, open_banking, network_token Metadata is useful for storing additional, unstructured information on an object. This metadata will override the metadata that was passed in payments
Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.
Show child attributes
Show child attributes
additional data that might be required by hyperswitch
Show child attributes
Show child attributes
Show child attributes
Show child attributes
true, false, default Will be used to expire client secret after certain amount of time to be supplied in seconds, if not sent it will be taken from profile config (900) for 15 mins
x >= 0900
Additional data related to some frm(Fraud Risk Management) connectors
Whether 3ds authentication is requested or not
Enable, Skip Whether active attempt is to be set/unset
Show child attributes
Show child attributes
Allow partial authorization for this payment
Response
Payment Intent Updated
Global Payment Id for the payment
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).
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, partially_captured_and_processing, conflicted, expired Show child attributes
Show child attributes
It's a token used for client side verification.
"cs_0195b34da95d75239c6a4bf514458896"
The identifier for the profile. This is inferred from the x-profile-id header
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}/captureendpoint is required to capture the funds.
automatic, manual, manual_multiple, scheduled, sequential_automatic The identifier for the customer
32 - 64"12345_cus_01926c58bc6e77c09e809964e72af8c8"
Set to present to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be absent when merchant's doing merchant initiated payments and customer is not present while doing the payment.
present, absent 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 toon_session.
off_session, on_session Apply, Skip Whether payment link is requested to be enabled or not for this transaction
Enable, Skip true, false, default enable, skip Will be used to expire client secret after certain amount of time to be supplied in seconds
Whether 3ds authentication is requested or not
Enable, Skip The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.
normal, new_mandate, setup_mandate, recurring_mandate Unique identifier for the payment. This ensures idempotency for multiple payments that have been done by a single merchant.
30"pay_mbabizu24mvu3mela5njyhpit4"
The routing algorithm id to be used for the payment
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.
three_ds, no_three_ds Show child attributes
Show child attributes
Show child attributes
Show child attributes
A description for the payment
"It's my first payment request"
The URL to which you want the user to be redirected after the completion of the payment operation
"https://birrpay.io"
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.
22"BirrPay Router"
Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount
Show child attributes
Show child attributes
"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]"
Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent
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, 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, qris, 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, open_banking, network_token Metadata is useful for storing additional, unstructured information on an 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
Show child attributes
additional data that might be required by hyperswitch
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Additional data related to some frm(Fraud Risk Management) connectors
Allow partial authorization for this payment