Payments - Update Metadata
curl --request POST \
--url https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"metadata": {},
"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_count": 123
},
"management_url": "https://orchestratorx.com",
"billing_agreement": "<string>"
},
"pix_additional_details": {
"immediate": {
"time": 1,
"pix_key": {
"type": "cpf",
"value": "<string>"
}
}
},
"boleto_additional_details": {
"due_date": "2026-12-31",
"covenant_code": "3568253",
"pix_key": {
"type": "cpf",
"value": "<string>"
}
},
"pix_automatico_additional_details": {
"time": 3600,
"type": "pix_automatico_push"
}
}
}
'import requests
url = "https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata"
payload = {
"metadata": {},
"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_count": 123
},
"management_url": "https://orchestratorx.com",
"billing_agreement": "<string>"
},
"pix_additional_details": { "immediate": {
"time": 1,
"pix_key": {
"type": "cpf",
"value": "<string>"
}
} },
"boleto_additional_details": {
"due_date": "2026-12-31",
"covenant_code": "3568253",
"pix_key": {
"type": "cpf",
"value": "<string>"
}
},
"pix_automatico_additional_details": {
"time": 3600,
"type": "pix_automatico_push"
}
}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {},
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_count: 123
},
management_url: 'https://orchestratorx.com',
billing_agreement: '<string>'
},
pix_additional_details: {immediate: {time: 1, pix_key: {type: 'cpf', value: '<string>'}}},
boleto_additional_details: {
due_date: '2026-12-31',
covenant_code: '3568253',
pix_key: {type: 'cpf', value: '<string>'}
},
pix_automatico_additional_details: {time: 3600, type: 'pix_automatico_push'}
}
})
};
fetch('https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata', 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.orchestratorx.com/payments/{payment_id}/update_metadata",
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([
'metadata' => [
],
'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_count' => 123
],
'management_url' => 'https://orchestratorx.com',
'billing_agreement' => '<string>'
],
'pix_additional_details' => [
'immediate' => [
'time' => 1,
'pix_key' => [
'type' => 'cpf',
'value' => '<string>'
]
]
],
'boleto_additional_details' => [
'due_date' => '2026-12-31',
'covenant_code' => '3568253',
'pix_key' => [
'type' => 'cpf',
'value' => '<string>'
]
],
'pix_automatico_additional_details' => [
'time' => 3600,
'type' => 'pix_automatico_push'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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.orchestratorx.com/payments/{payment_id}/update_metadata"
payload := strings.NewReader("{\n \"metadata\": {},\n \"feature_metadata\": {\n \"redirect_response\": {\n \"param\": \"<string>\",\n \"json_payload\": {}\n },\n \"search_tags\": [\n \"<string>\"\n ],\n \"apple_pay_recurring_details\": {\n \"payment_description\": \"<string>\",\n \"regular_billing\": {\n \"label\": \"<string>\",\n \"recurring_payment_start_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_end_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_interval_count\": 123\n },\n \"management_url\": \"https://orchestratorx.com\",\n \"billing_agreement\": \"<string>\"\n },\n \"pix_additional_details\": {\n \"immediate\": {\n \"time\": 1,\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n }\n },\n \"boleto_additional_details\": {\n \"due_date\": \"2026-12-31\",\n \"covenant_code\": \"3568253\",\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n },\n \"pix_automatico_additional_details\": {\n \"time\": 3600,\n \"type\": \"pix_automatico_push\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<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.orchestratorx.com/payments/{payment_id}/update_metadata")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"feature_metadata\": {\n \"redirect_response\": {\n \"param\": \"<string>\",\n \"json_payload\": {}\n },\n \"search_tags\": [\n \"<string>\"\n ],\n \"apple_pay_recurring_details\": {\n \"payment_description\": \"<string>\",\n \"regular_billing\": {\n \"label\": \"<string>\",\n \"recurring_payment_start_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_end_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_interval_count\": 123\n },\n \"management_url\": \"https://orchestratorx.com\",\n \"billing_agreement\": \"<string>\"\n },\n \"pix_additional_details\": {\n \"immediate\": {\n \"time\": 1,\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n }\n },\n \"boleto_additional_details\": {\n \"due_date\": \"2026-12-31\",\n \"covenant_code\": \"3568253\",\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n },\n \"pix_automatico_additional_details\": {\n \"time\": 3600,\n \"type\": \"pix_automatico_push\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {},\n \"feature_metadata\": {\n \"redirect_response\": {\n \"param\": \"<string>\",\n \"json_payload\": {}\n },\n \"search_tags\": [\n \"<string>\"\n ],\n \"apple_pay_recurring_details\": {\n \"payment_description\": \"<string>\",\n \"regular_billing\": {\n \"label\": \"<string>\",\n \"recurring_payment_start_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_end_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_interval_count\": 123\n },\n \"management_url\": \"https://orchestratorx.com\",\n \"billing_agreement\": \"<string>\"\n },\n \"pix_additional_details\": {\n \"immediate\": {\n \"time\": 1,\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n }\n },\n \"boleto_additional_details\": {\n \"due_date\": \"2026-12-31\",\n \"covenant_code\": \"3568253\",\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n },\n \"pix_automatico_additional_details\": {\n \"time\": 3600,\n \"type\": \"pix_automatico_push\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"payment_id": "<string>",
"status": "requires_confirmation",
"metadata": {},
"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_count": 123
},
"management_url": "https://orchestratorx.com",
"billing_agreement": "<string>"
},
"pix_additional_details": {
"immediate": {
"time": 1,
"pix_key": {
"type": "cpf",
"value": "<string>"
}
}
},
"boleto_additional_details": {
"due_date": "2026-12-31",
"covenant_code": "3568253",
"pix_key": {
"type": "cpf",
"value": "<string>"
}
},
"pix_automatico_additional_details": {
"time": 3600,
"type": "pix_automatico_push"
}
}
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}Payments
Payments - Update Metadata
POST
/
payments
/
{payment_id}
/
update_metadata
Payments - Update Metadata
curl --request POST \
--url https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"metadata": {},
"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_count": 123
},
"management_url": "https://orchestratorx.com",
"billing_agreement": "<string>"
},
"pix_additional_details": {
"immediate": {
"time": 1,
"pix_key": {
"type": "cpf",
"value": "<string>"
}
}
},
"boleto_additional_details": {
"due_date": "2026-12-31",
"covenant_code": "3568253",
"pix_key": {
"type": "cpf",
"value": "<string>"
}
},
"pix_automatico_additional_details": {
"time": 3600,
"type": "pix_automatico_push"
}
}
}
'import requests
url = "https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata"
payload = {
"metadata": {},
"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_count": 123
},
"management_url": "https://orchestratorx.com",
"billing_agreement": "<string>"
},
"pix_additional_details": { "immediate": {
"time": 1,
"pix_key": {
"type": "cpf",
"value": "<string>"
}
} },
"boleto_additional_details": {
"due_date": "2026-12-31",
"covenant_code": "3568253",
"pix_key": {
"type": "cpf",
"value": "<string>"
}
},
"pix_automatico_additional_details": {
"time": 3600,
"type": "pix_automatico_push"
}
}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {},
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_count: 123
},
management_url: 'https://orchestratorx.com',
billing_agreement: '<string>'
},
pix_additional_details: {immediate: {time: 1, pix_key: {type: 'cpf', value: '<string>'}}},
boleto_additional_details: {
due_date: '2026-12-31',
covenant_code: '3568253',
pix_key: {type: 'cpf', value: '<string>'}
},
pix_automatico_additional_details: {time: 3600, type: 'pix_automatico_push'}
}
})
};
fetch('https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata', 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.orchestratorx.com/payments/{payment_id}/update_metadata",
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([
'metadata' => [
],
'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_count' => 123
],
'management_url' => 'https://orchestratorx.com',
'billing_agreement' => '<string>'
],
'pix_additional_details' => [
'immediate' => [
'time' => 1,
'pix_key' => [
'type' => 'cpf',
'value' => '<string>'
]
]
],
'boleto_additional_details' => [
'due_date' => '2026-12-31',
'covenant_code' => '3568253',
'pix_key' => [
'type' => 'cpf',
'value' => '<string>'
]
],
'pix_automatico_additional_details' => [
'time' => 3600,
'type' => 'pix_automatico_push'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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.orchestratorx.com/payments/{payment_id}/update_metadata"
payload := strings.NewReader("{\n \"metadata\": {},\n \"feature_metadata\": {\n \"redirect_response\": {\n \"param\": \"<string>\",\n \"json_payload\": {}\n },\n \"search_tags\": [\n \"<string>\"\n ],\n \"apple_pay_recurring_details\": {\n \"payment_description\": \"<string>\",\n \"regular_billing\": {\n \"label\": \"<string>\",\n \"recurring_payment_start_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_end_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_interval_count\": 123\n },\n \"management_url\": \"https://orchestratorx.com\",\n \"billing_agreement\": \"<string>\"\n },\n \"pix_additional_details\": {\n \"immediate\": {\n \"time\": 1,\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n }\n },\n \"boleto_additional_details\": {\n \"due_date\": \"2026-12-31\",\n \"covenant_code\": \"3568253\",\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n },\n \"pix_automatico_additional_details\": {\n \"time\": 3600,\n \"type\": \"pix_automatico_push\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<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.orchestratorx.com/payments/{payment_id}/update_metadata")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"feature_metadata\": {\n \"redirect_response\": {\n \"param\": \"<string>\",\n \"json_payload\": {}\n },\n \"search_tags\": [\n \"<string>\"\n ],\n \"apple_pay_recurring_details\": {\n \"payment_description\": \"<string>\",\n \"regular_billing\": {\n \"label\": \"<string>\",\n \"recurring_payment_start_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_end_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_interval_count\": 123\n },\n \"management_url\": \"https://orchestratorx.com\",\n \"billing_agreement\": \"<string>\"\n },\n \"pix_additional_details\": {\n \"immediate\": {\n \"time\": 1,\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n }\n },\n \"boleto_additional_details\": {\n \"due_date\": \"2026-12-31\",\n \"covenant_code\": \"3568253\",\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n },\n \"pix_automatico_additional_details\": {\n \"time\": 3600,\n \"type\": \"pix_automatico_push\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.orchestratorx.com/payments/{payment_id}/update_metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {},\n \"feature_metadata\": {\n \"redirect_response\": {\n \"param\": \"<string>\",\n \"json_payload\": {}\n },\n \"search_tags\": [\n \"<string>\"\n ],\n \"apple_pay_recurring_details\": {\n \"payment_description\": \"<string>\",\n \"regular_billing\": {\n \"label\": \"<string>\",\n \"recurring_payment_start_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_end_date\": \"2023-09-10T23:59:59Z\",\n \"recurring_payment_interval_count\": 123\n },\n \"management_url\": \"https://orchestratorx.com\",\n \"billing_agreement\": \"<string>\"\n },\n \"pix_additional_details\": {\n \"immediate\": {\n \"time\": 1,\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n }\n },\n \"boleto_additional_details\": {\n \"due_date\": \"2026-12-31\",\n \"covenant_code\": \"3568253\",\n \"pix_key\": {\n \"type\": \"cpf\",\n \"value\": \"<string>\"\n }\n },\n \"pix_automatico_additional_details\": {\n \"time\": 3600,\n \"type\": \"pix_automatico_push\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"payment_id": "<string>",
"status": "requires_confirmation",
"metadata": {},
"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_count": 123
},
"management_url": "https://orchestratorx.com",
"billing_agreement": "<string>"
},
"pix_additional_details": {
"immediate": {
"time": 1,
"pix_key": {
"type": "cpf",
"value": "<string>"
}
}
},
"boleto_additional_details": {
"due_date": "2026-12-31",
"covenant_code": "3568253",
"pix_key": {
"type": "cpf",
"value": "<string>"
}
},
"pix_automatico_additional_details": {
"time": 3600,
"type": "pix_automatico_push"
}
}
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}Authorizations
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.
Path Parameters
The identifier for payment
Body
application/json
Response
Metadata updated successfully
The identifier 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).
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 Metadata is useful for storing additional, unstructured information on an object.
additional data that might be required by OrchestratorX
Show child attributes
Show child attributes
⌘I