Revenue Recovery - Create
curl --request POST \
--url https://sandbox.hyperswitch.io/v2/recovery \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: <x-profile-id>' \
--data '
{
"action": "schedule_failed_payment",
"amount_details": {
"currency": "USD",
"order_amount": 6540
},
"billing_merchant_connector_id": "mca_billing_1234567890",
"billing_started_at": "2022-09-10T10:11:12Z",
"connector_customer_id": "cust_12345",
"connector_transaction_id": "993672945374576J",
"error": {
"code": "card_declined",
"message": "The card was declined.",
"network_advice_code": "01",
"network_decline_code": "51",
"network_error_message": "Retry after some time",
"reason": "Insufficient funds"
},
"merchant_reference_id": "invoice_mbabizu24mvu3mela5njyh",
"payment_merchant_connector_id": "mca_payment_1234567890",
"payment_method_data": {
"payment_method_metadata": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_extended_bin": "42424242",
"card_isin": "424242",
"card_network": "Visa",
"card_type": "credit",
"last4": "4242"
},
"primary_processor_payment_method_token": "token_1234"
},
"payment_method_sub_type": "credit",
"payment_method_type": "card",
"transaction_created_at": "2022-09-10T10:11:12Z",
"transaction_status": "failure"
}
'import requests
url = "https://sandbox.hyperswitch.io/v2/recovery"
payload = {
"action": "schedule_failed_payment",
"amount_details": {
"currency": "USD",
"order_amount": 6540
},
"billing_merchant_connector_id": "mca_billing_1234567890",
"billing_started_at": "2022-09-10T10:11:12Z",
"connector_customer_id": "cust_12345",
"connector_transaction_id": "993672945374576J",
"error": {
"code": "card_declined",
"message": "The card was declined.",
"network_advice_code": "01",
"network_decline_code": "51",
"network_error_message": "Retry after some time",
"reason": "Insufficient funds"
},
"merchant_reference_id": "invoice_mbabizu24mvu3mela5njyh",
"payment_merchant_connector_id": "mca_payment_1234567890",
"payment_method_data": {
"payment_method_metadata": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_extended_bin": "42424242",
"card_isin": "424242",
"card_network": "Visa",
"card_type": "credit",
"last4": "4242"
},
"primary_processor_payment_method_token": "token_1234"
},
"payment_method_sub_type": "credit",
"payment_method_type": "card",
"transaction_created_at": "2022-09-10T10:11:12Z",
"transaction_status": "failure"
}
headers = {
"X-Profile-Id": "<x-profile-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Profile-Id': '<x-profile-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
action: 'schedule_failed_payment',
amount_details: {currency: 'USD', order_amount: 6540},
billing_merchant_connector_id: 'mca_billing_1234567890',
billing_started_at: '2022-09-10T10:11:12Z',
connector_customer_id: 'cust_12345',
connector_transaction_id: '993672945374576J',
error: {
code: 'card_declined',
message: 'The card was declined.',
network_advice_code: '01',
network_decline_code: '51',
network_error_message: 'Retry after some time',
reason: 'Insufficient funds'
},
merchant_reference_id: 'invoice_mbabizu24mvu3mela5njyh',
payment_merchant_connector_id: 'mca_payment_1234567890',
payment_method_data: {
payment_method_metadata: {
card_exp_month: '01',
card_exp_year: '2026',
card_extended_bin: '42424242',
card_isin: '424242',
card_network: 'Visa',
card_type: 'credit',
last4: '4242'
},
primary_processor_payment_method_token: 'token_1234'
},
payment_method_sub_type: 'credit',
payment_method_type: 'card',
transaction_created_at: '2022-09-10T10:11:12Z',
transaction_status: 'failure'
})
};
fetch('https://sandbox.hyperswitch.io/v2/recovery', 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.hyperswitch.io/v2/recovery",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'schedule_failed_payment',
'amount_details' => [
'currency' => 'USD',
'order_amount' => 6540
],
'billing_merchant_connector_id' => 'mca_billing_1234567890',
'billing_started_at' => '2022-09-10T10:11:12Z',
'connector_customer_id' => 'cust_12345',
'connector_transaction_id' => '993672945374576J',
'error' => [
'code' => 'card_declined',
'message' => 'The card was declined.',
'network_advice_code' => '01',
'network_decline_code' => '51',
'network_error_message' => 'Retry after some time',
'reason' => 'Insufficient funds'
],
'merchant_reference_id' => 'invoice_mbabizu24mvu3mela5njyh',
'payment_merchant_connector_id' => 'mca_payment_1234567890',
'payment_method_data' => [
'payment_method_metadata' => [
'card_exp_month' => '01',
'card_exp_year' => '2026',
'card_extended_bin' => '42424242',
'card_isin' => '424242',
'card_network' => 'Visa',
'card_type' => 'credit',
'last4' => '4242'
],
'primary_processor_payment_method_token' => 'token_1234'
],
'payment_method_sub_type' => 'credit',
'payment_method_type' => 'card',
'transaction_created_at' => '2022-09-10T10:11:12Z',
'transaction_status' => 'failure'
]),
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.hyperswitch.io/v2/recovery"
payload := strings.NewReader("{\n \"action\": \"schedule_failed_payment\",\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n },\n \"billing_merchant_connector_id\": \"mca_billing_1234567890\",\n \"billing_started_at\": \"2022-09-10T10:11:12Z\",\n \"connector_customer_id\": \"cust_12345\",\n \"connector_transaction_id\": \"993672945374576J\",\n \"error\": {\n \"code\": \"card_declined\",\n \"message\": \"The card was declined.\",\n \"network_advice_code\": \"01\",\n \"network_decline_code\": \"51\",\n \"network_error_message\": \"Retry after some time\",\n \"reason\": \"Insufficient funds\"\n },\n \"merchant_reference_id\": \"invoice_mbabizu24mvu3mela5njyh\",\n \"payment_merchant_connector_id\": \"mca_payment_1234567890\",\n \"payment_method_data\": {\n \"payment_method_metadata\": {\n \"card_exp_month\": \"01\",\n \"card_exp_year\": \"2026\",\n \"card_extended_bin\": \"42424242\",\n \"card_isin\": \"424242\",\n \"card_network\": \"Visa\",\n \"card_type\": \"credit\",\n \"last4\": \"4242\"\n },\n \"primary_processor_payment_method_token\": \"token_1234\"\n },\n \"payment_method_sub_type\": \"credit\",\n \"payment_method_type\": \"card\",\n \"transaction_created_at\": \"2022-09-10T10:11:12Z\",\n \"transaction_status\": \"failure\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.hyperswitch.io/v2/recovery")
.header("X-Profile-Id", "<x-profile-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"schedule_failed_payment\",\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n },\n \"billing_merchant_connector_id\": \"mca_billing_1234567890\",\n \"billing_started_at\": \"2022-09-10T10:11:12Z\",\n \"connector_customer_id\": \"cust_12345\",\n \"connector_transaction_id\": \"993672945374576J\",\n \"error\": {\n \"code\": \"card_declined\",\n \"message\": \"The card was declined.\",\n \"network_advice_code\": \"01\",\n \"network_decline_code\": \"51\",\n \"network_error_message\": \"Retry after some time\",\n \"reason\": \"Insufficient funds\"\n },\n \"merchant_reference_id\": \"invoice_mbabizu24mvu3mela5njyh\",\n \"payment_merchant_connector_id\": \"mca_payment_1234567890\",\n \"payment_method_data\": {\n \"payment_method_metadata\": {\n \"card_exp_month\": \"01\",\n \"card_exp_year\": \"2026\",\n \"card_extended_bin\": \"42424242\",\n \"card_isin\": \"424242\",\n \"card_network\": \"Visa\",\n \"card_type\": \"credit\",\n \"last4\": \"4242\"\n },\n \"primary_processor_payment_method_token\": \"token_1234\"\n },\n \"payment_method_sub_type\": \"credit\",\n \"payment_method_type\": \"card\",\n \"transaction_created_at\": \"2022-09-10T10:11:12Z\",\n \"transaction_status\": \"failure\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/v2/recovery")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"schedule_failed_payment\",\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n },\n \"billing_merchant_connector_id\": \"mca_billing_1234567890\",\n \"billing_started_at\": \"2022-09-10T10:11:12Z\",\n \"connector_customer_id\": \"cust_12345\",\n \"connector_transaction_id\": \"993672945374576J\",\n \"error\": {\n \"code\": \"card_declined\",\n \"message\": \"The card was declined.\",\n \"network_advice_code\": \"01\",\n \"network_decline_code\": \"51\",\n \"network_error_message\": \"Retry after some time\",\n \"reason\": \"Insufficient funds\"\n },\n \"merchant_reference_id\": \"invoice_mbabizu24mvu3mela5njyh\",\n \"payment_merchant_connector_id\": \"mca_payment_1234567890\",\n \"payment_method_data\": {\n \"payment_method_metadata\": {\n \"card_exp_month\": \"01\",\n \"card_exp_year\": \"2026\",\n \"card_extended_bin\": \"42424242\",\n \"card_isin\": \"424242\",\n \"card_network\": \"Visa\",\n \"card_type\": \"credit\",\n \"last4\": \"4242\"\n },\n \"primary_processor_payment_method_token\": \"token_1234\"\n },\n \"payment_method_sub_type\": \"credit\",\n \"payment_method_type\": \"card\",\n \"transaction_created_at\": \"2022-09-10T10:11:12Z\",\n \"transaction_status\": \"failure\"\n}"
response = http.request(request)
puts response.read_body{
"id": "12_pay_01a3868d94a471219b5c4bc71638e2zc",
"intent_status": "failed",
"merchant_reference_id": "invoice_mbabizu24mvu3mela5njyh"
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}Revenue Recovery
Revenue Recovery - Create
Record a transaction made outside of Hyperswitch against a billing connector invoice, and take the requested recovery action on it, such as scheduling a retry for a failed payment or recording an externally successful payment.
POST
/
v2
/
recovery
Revenue Recovery - Create
curl --request POST \
--url https://sandbox.hyperswitch.io/v2/recovery \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: <x-profile-id>' \
--data '
{
"action": "schedule_failed_payment",
"amount_details": {
"currency": "USD",
"order_amount": 6540
},
"billing_merchant_connector_id": "mca_billing_1234567890",
"billing_started_at": "2022-09-10T10:11:12Z",
"connector_customer_id": "cust_12345",
"connector_transaction_id": "993672945374576J",
"error": {
"code": "card_declined",
"message": "The card was declined.",
"network_advice_code": "01",
"network_decline_code": "51",
"network_error_message": "Retry after some time",
"reason": "Insufficient funds"
},
"merchant_reference_id": "invoice_mbabizu24mvu3mela5njyh",
"payment_merchant_connector_id": "mca_payment_1234567890",
"payment_method_data": {
"payment_method_metadata": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_extended_bin": "42424242",
"card_isin": "424242",
"card_network": "Visa",
"card_type": "credit",
"last4": "4242"
},
"primary_processor_payment_method_token": "token_1234"
},
"payment_method_sub_type": "credit",
"payment_method_type": "card",
"transaction_created_at": "2022-09-10T10:11:12Z",
"transaction_status": "failure"
}
'import requests
url = "https://sandbox.hyperswitch.io/v2/recovery"
payload = {
"action": "schedule_failed_payment",
"amount_details": {
"currency": "USD",
"order_amount": 6540
},
"billing_merchant_connector_id": "mca_billing_1234567890",
"billing_started_at": "2022-09-10T10:11:12Z",
"connector_customer_id": "cust_12345",
"connector_transaction_id": "993672945374576J",
"error": {
"code": "card_declined",
"message": "The card was declined.",
"network_advice_code": "01",
"network_decline_code": "51",
"network_error_message": "Retry after some time",
"reason": "Insufficient funds"
},
"merchant_reference_id": "invoice_mbabizu24mvu3mela5njyh",
"payment_merchant_connector_id": "mca_payment_1234567890",
"payment_method_data": {
"payment_method_metadata": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_extended_bin": "42424242",
"card_isin": "424242",
"card_network": "Visa",
"card_type": "credit",
"last4": "4242"
},
"primary_processor_payment_method_token": "token_1234"
},
"payment_method_sub_type": "credit",
"payment_method_type": "card",
"transaction_created_at": "2022-09-10T10:11:12Z",
"transaction_status": "failure"
}
headers = {
"X-Profile-Id": "<x-profile-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Profile-Id': '<x-profile-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
action: 'schedule_failed_payment',
amount_details: {currency: 'USD', order_amount: 6540},
billing_merchant_connector_id: 'mca_billing_1234567890',
billing_started_at: '2022-09-10T10:11:12Z',
connector_customer_id: 'cust_12345',
connector_transaction_id: '993672945374576J',
error: {
code: 'card_declined',
message: 'The card was declined.',
network_advice_code: '01',
network_decline_code: '51',
network_error_message: 'Retry after some time',
reason: 'Insufficient funds'
},
merchant_reference_id: 'invoice_mbabizu24mvu3mela5njyh',
payment_merchant_connector_id: 'mca_payment_1234567890',
payment_method_data: {
payment_method_metadata: {
card_exp_month: '01',
card_exp_year: '2026',
card_extended_bin: '42424242',
card_isin: '424242',
card_network: 'Visa',
card_type: 'credit',
last4: '4242'
},
primary_processor_payment_method_token: 'token_1234'
},
payment_method_sub_type: 'credit',
payment_method_type: 'card',
transaction_created_at: '2022-09-10T10:11:12Z',
transaction_status: 'failure'
})
};
fetch('https://sandbox.hyperswitch.io/v2/recovery', 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.hyperswitch.io/v2/recovery",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'schedule_failed_payment',
'amount_details' => [
'currency' => 'USD',
'order_amount' => 6540
],
'billing_merchant_connector_id' => 'mca_billing_1234567890',
'billing_started_at' => '2022-09-10T10:11:12Z',
'connector_customer_id' => 'cust_12345',
'connector_transaction_id' => '993672945374576J',
'error' => [
'code' => 'card_declined',
'message' => 'The card was declined.',
'network_advice_code' => '01',
'network_decline_code' => '51',
'network_error_message' => 'Retry after some time',
'reason' => 'Insufficient funds'
],
'merchant_reference_id' => 'invoice_mbabizu24mvu3mela5njyh',
'payment_merchant_connector_id' => 'mca_payment_1234567890',
'payment_method_data' => [
'payment_method_metadata' => [
'card_exp_month' => '01',
'card_exp_year' => '2026',
'card_extended_bin' => '42424242',
'card_isin' => '424242',
'card_network' => 'Visa',
'card_type' => 'credit',
'last4' => '4242'
],
'primary_processor_payment_method_token' => 'token_1234'
],
'payment_method_sub_type' => 'credit',
'payment_method_type' => 'card',
'transaction_created_at' => '2022-09-10T10:11:12Z',
'transaction_status' => 'failure'
]),
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.hyperswitch.io/v2/recovery"
payload := strings.NewReader("{\n \"action\": \"schedule_failed_payment\",\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n },\n \"billing_merchant_connector_id\": \"mca_billing_1234567890\",\n \"billing_started_at\": \"2022-09-10T10:11:12Z\",\n \"connector_customer_id\": \"cust_12345\",\n \"connector_transaction_id\": \"993672945374576J\",\n \"error\": {\n \"code\": \"card_declined\",\n \"message\": \"The card was declined.\",\n \"network_advice_code\": \"01\",\n \"network_decline_code\": \"51\",\n \"network_error_message\": \"Retry after some time\",\n \"reason\": \"Insufficient funds\"\n },\n \"merchant_reference_id\": \"invoice_mbabizu24mvu3mela5njyh\",\n \"payment_merchant_connector_id\": \"mca_payment_1234567890\",\n \"payment_method_data\": {\n \"payment_method_metadata\": {\n \"card_exp_month\": \"01\",\n \"card_exp_year\": \"2026\",\n \"card_extended_bin\": \"42424242\",\n \"card_isin\": \"424242\",\n \"card_network\": \"Visa\",\n \"card_type\": \"credit\",\n \"last4\": \"4242\"\n },\n \"primary_processor_payment_method_token\": \"token_1234\"\n },\n \"payment_method_sub_type\": \"credit\",\n \"payment_method_type\": \"card\",\n \"transaction_created_at\": \"2022-09-10T10:11:12Z\",\n \"transaction_status\": \"failure\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.hyperswitch.io/v2/recovery")
.header("X-Profile-Id", "<x-profile-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"schedule_failed_payment\",\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n },\n \"billing_merchant_connector_id\": \"mca_billing_1234567890\",\n \"billing_started_at\": \"2022-09-10T10:11:12Z\",\n \"connector_customer_id\": \"cust_12345\",\n \"connector_transaction_id\": \"993672945374576J\",\n \"error\": {\n \"code\": \"card_declined\",\n \"message\": \"The card was declined.\",\n \"network_advice_code\": \"01\",\n \"network_decline_code\": \"51\",\n \"network_error_message\": \"Retry after some time\",\n \"reason\": \"Insufficient funds\"\n },\n \"merchant_reference_id\": \"invoice_mbabizu24mvu3mela5njyh\",\n \"payment_merchant_connector_id\": \"mca_payment_1234567890\",\n \"payment_method_data\": {\n \"payment_method_metadata\": {\n \"card_exp_month\": \"01\",\n \"card_exp_year\": \"2026\",\n \"card_extended_bin\": \"42424242\",\n \"card_isin\": \"424242\",\n \"card_network\": \"Visa\",\n \"card_type\": \"credit\",\n \"last4\": \"4242\"\n },\n \"primary_processor_payment_method_token\": \"token_1234\"\n },\n \"payment_method_sub_type\": \"credit\",\n \"payment_method_type\": \"card\",\n \"transaction_created_at\": \"2022-09-10T10:11:12Z\",\n \"transaction_status\": \"failure\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/v2/recovery")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"schedule_failed_payment\",\n \"amount_details\": {\n \"currency\": \"USD\",\n \"order_amount\": 6540\n },\n \"billing_merchant_connector_id\": \"mca_billing_1234567890\",\n \"billing_started_at\": \"2022-09-10T10:11:12Z\",\n \"connector_customer_id\": \"cust_12345\",\n \"connector_transaction_id\": \"993672945374576J\",\n \"error\": {\n \"code\": \"card_declined\",\n \"message\": \"The card was declined.\",\n \"network_advice_code\": \"01\",\n \"network_decline_code\": \"51\",\n \"network_error_message\": \"Retry after some time\",\n \"reason\": \"Insufficient funds\"\n },\n \"merchant_reference_id\": \"invoice_mbabizu24mvu3mela5njyh\",\n \"payment_merchant_connector_id\": \"mca_payment_1234567890\",\n \"payment_method_data\": {\n \"payment_method_metadata\": {\n \"card_exp_month\": \"01\",\n \"card_exp_year\": \"2026\",\n \"card_extended_bin\": \"42424242\",\n \"card_isin\": \"424242\",\n \"card_network\": \"Visa\",\n \"card_type\": \"credit\",\n \"last4\": \"4242\"\n },\n \"primary_processor_payment_method_token\": \"token_1234\"\n },\n \"payment_method_sub_type\": \"credit\",\n \"payment_method_type\": \"card\",\n \"transaction_created_at\": \"2022-09-10T10:11:12Z\",\n \"transaction_status\": \"failure\"\n}"
response = http.request(request)
puts response.read_body{
"id": "12_pay_01a3868d94a471219b5c4bc71638e2zc",
"intent_status": "failed",
"merchant_reference_id": "invoice_mbabizu24mvu3mela5njyh"
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}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
Unique identifier of the business profile under which the invoice is processed. The billing and payment merchant connector accounts in the request must belong to this profile.
Body
application/json
Show child attributes
Show child attributes
Unique identifier of the invoice in the merchant's billing system against which the transaction is being recorded.
Required string length:
30Example:
"invoice_mbabizu24mvu3mela5njyh"
Unique identifier of the billing connector account, such as Chargebee, that manages the
invoice. The account must belong to the profile passed in the X-Profile-Id header.
Example:
"mca_1234567890"
Unique identifier of the payment connector account, such as Stripe, on which the
transaction was processed. The account must belong to the profile passed in the
X-Profile-Id header.
Example:
"mca_1234567890"
Status of the transaction reported.
Available options:
charged, failure, partial_charged, partial_charged_and_chargeable Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
Available options:
ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eft_debit_order, 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, neteller, 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, pix_key, pix_emv, pix_qr, pix_automatico_qr, pix_automatico_push, 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, wero, 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, payshap, payshap_proxy, ted The time at which the transaction was created at the payment connector.
Example:
"2022-09-10T10:11:12Z"
Indicates the type of payment method. Eg: 'card', 'wallet', etc.
Available options:
card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card, open_banking, mobile_payment, network_token Unique identifier of the customer at the payment connector, with which the payment method token used for the transaction is associated.
Example:
"cust_12345"
Invoice billing started at billing connector's end.
Example:
"2022-09-10T10:11:12Z"
Unique identifier of the transaction at the payment connector. It is used to identify the transaction among the attempts recorded for the invoice.
Example:
"993672945374576J"
Show child attributes
Show child attributes
Action to be taken on the transaction reported through the revenue recovery API
Available options:
schedule_failed_payment, success_payment_external Error details for the payment
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Allow partial authorization for this payment
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.
Response
Revenue Recovery Transaction Recorded Successfully
Unique identifier of the invoice in Hyperswitch against which the transaction has been recorded.
Required string length:
30Example:
"pay_mbabizu24mvu3mela5njyhpit4"
Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).
Available options:
succeeded, failed, cancelled, cancelled_post_capture, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable, partially_authorized_and_requires_capture, partially_captured_and_processing, conflicted, expired, review Unique identifier of the invoice in the merchant's billing system against which the transaction is being recorded.
Required string length:
30Example:
"invoice_mbabizu24mvu3mela5njyh"
Was this page helpful?