Create a payment intent
curl --request POST \
--url https://api.orqex.com/v1/payment/intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 50,
"currency": "USD",
"description": "Order #1042",
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "ORDER-1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "[email protected]",
"entity_id": "<string>",
"entity_created_at": "2023-11-07T05:31:56Z",
"gateway_options": {},
"metadata": {
"order_id": "1042"
},
"restriction": {
"payment_methods": {
"allow": [
"momo_mtn"
],
"deny": [
"card"
]
},
"payment_method_categories": {
"allow": [
"mobile_money"
],
"deny": [
"crypto"
]
}
}
}
'import requests
url = "https://api.orqex.com/v1/payment/intents"
payload = {
"amount": 50,
"currency": "USD",
"description": "Order #1042",
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "ORDER-1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "[email protected]",
"entity_id": "<string>",
"entity_created_at": "2023-11-07T05:31:56Z",
"gateway_options": {},
"metadata": { "order_id": "1042" },
"restriction": {
"payment_methods": {
"allow": ["momo_mtn"],
"deny": ["card"]
},
"payment_method_categories": {
"allow": ["mobile_money"],
"deny": ["crypto"]
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 50,
currency: 'USD',
description: 'Order #1042',
customer: {
email: '[email protected]',
first_name: 'Ada',
last_name: 'Lovelace',
address: '<string>',
city: '<string>',
state: '<string>',
country: 'US',
zip: '<string>'
},
reference: 'ORDER-1042',
return_url: '<string>',
webhook_url: '<string>',
statement_descriptor: '<string>',
receipt_email: '[email protected]',
entity_id: '<string>',
entity_created_at: '2023-11-07T05:31:56Z',
gateway_options: {},
metadata: {order_id: '1042'},
restriction: {
payment_methods: {allow: ['momo_mtn'], deny: ['card']},
payment_method_categories: {allow: ['mobile_money'], deny: ['crypto']}
}
})
};
fetch('https://api.orqex.com/v1/payment/intents', 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://api.orqex.com/v1/payment/intents",
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([
'amount' => 50,
'currency' => 'USD',
'description' => 'Order #1042',
'customer' => [
'email' => '[email protected]',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => 'US',
'zip' => '<string>'
],
'reference' => 'ORDER-1042',
'return_url' => '<string>',
'webhook_url' => '<string>',
'statement_descriptor' => '<string>',
'receipt_email' => '[email protected]',
'entity_id' => '<string>',
'entity_created_at' => '2023-11-07T05:31:56Z',
'gateway_options' => [
],
'metadata' => [
'order_id' => '1042'
],
'restriction' => [
'payment_methods' => [
'allow' => [
'momo_mtn'
],
'deny' => [
'card'
]
],
'payment_method_categories' => [
'allow' => [
'mobile_money'
],
'deny' => [
'crypto'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.orqex.com/v1/payment/intents"
payload := strings.NewReader("{\n \"amount\": 50,\n \"currency\": \"USD\",\n \"description\": \"Order #1042\",\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"ORDER-1042\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"statement_descriptor\": \"<string>\",\n \"receipt_email\": \"[email protected]\",\n \"entity_id\": \"<string>\",\n \"entity_created_at\": \"2023-11-07T05:31:56Z\",\n \"gateway_options\": {},\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"restriction\": {\n \"payment_methods\": {\n \"allow\": [\n \"momo_mtn\"\n ],\n \"deny\": [\n \"card\"\n ]\n },\n \"payment_method_categories\": {\n \"allow\": [\n \"mobile_money\"\n ],\n \"deny\": [\n \"crypto\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.orqex.com/v1/payment/intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 50,\n \"currency\": \"USD\",\n \"description\": \"Order #1042\",\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"ORDER-1042\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"statement_descriptor\": \"<string>\",\n \"receipt_email\": \"[email protected]\",\n \"entity_id\": \"<string>\",\n \"entity_created_at\": \"2023-11-07T05:31:56Z\",\n \"gateway_options\": {},\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"restriction\": {\n \"payment_methods\": {\n \"allow\": [\n \"momo_mtn\"\n ],\n \"deny\": [\n \"card\"\n ]\n },\n \"payment_method_categories\": {\n \"allow\": [\n \"mobile_money\"\n ],\n \"deny\": [\n \"crypto\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.com/v1/payment/intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 50,\n \"currency\": \"USD\",\n \"description\": \"Order #1042\",\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"ORDER-1042\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"statement_descriptor\": \"<string>\",\n \"receipt_email\": \"[email protected]\",\n \"entity_id\": \"<string>\",\n \"entity_created_at\": \"2023-11-07T05:31:56Z\",\n \"gateway_options\": {},\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"restriction\": {\n \"payment_methods\": {\n \"allow\": [\n \"momo_mtn\"\n ],\n \"deny\": [\n \"card\"\n ]\n },\n \"payment_method_categories\": {\n \"allow\": [\n \"mobile_money\"\n ],\n \"deny\": [\n \"crypto\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"id": "pi_7Ba4Xq",
"reference": "ORDER-1042",
"amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"customer": {
"id": "cus_2f8Kd1",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"avatar_url": "<string>"
},
"status": "pending",
"description": "Order #1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "<string>",
"metadata": {},
"active_attempt": {
"id": "att_9Kd12f",
"method": {
"value": "test",
"label": "<string>",
"description": "<string>",
"icon_url": "<string>",
"category": "<string>",
"requires_phone": true
},
"amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"exchange_rate": {
"value": "0.92000000",
"from_currency": "USD",
"to_currency": "EUR",
"expression": "$1.00 ≈ €0.92"
},
"correction_rate": 123,
"status": "processing",
"gateway": {
"transaction": {
"id": "<string>",
"reference": "<string>",
"external_id": "<string>",
"status": "<string>"
}
},
"next_action": {
"type": "none",
"message": "<string>",
"instructions": [
"<string>"
],
"dial_code": "<string>",
"digits": 123,
"is_strict": true,
"fields": [
{}
],
"url": "<string>",
"method": "<string>",
"post_data": {},
"can_auto_redirect": true,
"content": "<string>",
"image_url": "<string>",
"title": "<string>",
"provider": "<string>",
"sdk_url": "<string>",
"public_key": "<string>",
"client_params": {},
"container_id": "<string>"
},
"failure": {
"code": {
"value": "<string>",
"category": "CUSTOMER_ERROR",
"message": "<string>"
},
"message": "<string>"
},
"failover": {
"is_failover": true,
"decision": {}
},
"processing_at": "2023-11-07T05:31:56Z",
"action_required_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"restriction": {
"payment_methods": {
"allow": [
"momo_mtn"
],
"deny": [
"card"
]
},
"payment_method_categories": {
"allow": [
"mobile_money"
],
"deny": [
"crypto"
]
}
},
"completed_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "The given data was invalid.",
"errors": {}
}{
"message": "<string>"
}Payment intents
Create a payment intent
Creates a payment you will collect through the API. Pass attempt to start collecting straight away.
POST
/
payment
/
intents
Create a payment intent
curl --request POST \
--url https://api.orqex.com/v1/payment/intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 50,
"currency": "USD",
"description": "Order #1042",
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "ORDER-1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "[email protected]",
"entity_id": "<string>",
"entity_created_at": "2023-11-07T05:31:56Z",
"gateway_options": {},
"metadata": {
"order_id": "1042"
},
"restriction": {
"payment_methods": {
"allow": [
"momo_mtn"
],
"deny": [
"card"
]
},
"payment_method_categories": {
"allow": [
"mobile_money"
],
"deny": [
"crypto"
]
}
}
}
'import requests
url = "https://api.orqex.com/v1/payment/intents"
payload = {
"amount": 50,
"currency": "USD",
"description": "Order #1042",
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "ORDER-1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "[email protected]",
"entity_id": "<string>",
"entity_created_at": "2023-11-07T05:31:56Z",
"gateway_options": {},
"metadata": { "order_id": "1042" },
"restriction": {
"payment_methods": {
"allow": ["momo_mtn"],
"deny": ["card"]
},
"payment_method_categories": {
"allow": ["mobile_money"],
"deny": ["crypto"]
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 50,
currency: 'USD',
description: 'Order #1042',
customer: {
email: '[email protected]',
first_name: 'Ada',
last_name: 'Lovelace',
address: '<string>',
city: '<string>',
state: '<string>',
country: 'US',
zip: '<string>'
},
reference: 'ORDER-1042',
return_url: '<string>',
webhook_url: '<string>',
statement_descriptor: '<string>',
receipt_email: '[email protected]',
entity_id: '<string>',
entity_created_at: '2023-11-07T05:31:56Z',
gateway_options: {},
metadata: {order_id: '1042'},
restriction: {
payment_methods: {allow: ['momo_mtn'], deny: ['card']},
payment_method_categories: {allow: ['mobile_money'], deny: ['crypto']}
}
})
};
fetch('https://api.orqex.com/v1/payment/intents', 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://api.orqex.com/v1/payment/intents",
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([
'amount' => 50,
'currency' => 'USD',
'description' => 'Order #1042',
'customer' => [
'email' => '[email protected]',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => 'US',
'zip' => '<string>'
],
'reference' => 'ORDER-1042',
'return_url' => '<string>',
'webhook_url' => '<string>',
'statement_descriptor' => '<string>',
'receipt_email' => '[email protected]',
'entity_id' => '<string>',
'entity_created_at' => '2023-11-07T05:31:56Z',
'gateway_options' => [
],
'metadata' => [
'order_id' => '1042'
],
'restriction' => [
'payment_methods' => [
'allow' => [
'momo_mtn'
],
'deny' => [
'card'
]
],
'payment_method_categories' => [
'allow' => [
'mobile_money'
],
'deny' => [
'crypto'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.orqex.com/v1/payment/intents"
payload := strings.NewReader("{\n \"amount\": 50,\n \"currency\": \"USD\",\n \"description\": \"Order #1042\",\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"ORDER-1042\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"statement_descriptor\": \"<string>\",\n \"receipt_email\": \"[email protected]\",\n \"entity_id\": \"<string>\",\n \"entity_created_at\": \"2023-11-07T05:31:56Z\",\n \"gateway_options\": {},\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"restriction\": {\n \"payment_methods\": {\n \"allow\": [\n \"momo_mtn\"\n ],\n \"deny\": [\n \"card\"\n ]\n },\n \"payment_method_categories\": {\n \"allow\": [\n \"mobile_money\"\n ],\n \"deny\": [\n \"crypto\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.orqex.com/v1/payment/intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 50,\n \"currency\": \"USD\",\n \"description\": \"Order #1042\",\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"ORDER-1042\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"statement_descriptor\": \"<string>\",\n \"receipt_email\": \"[email protected]\",\n \"entity_id\": \"<string>\",\n \"entity_created_at\": \"2023-11-07T05:31:56Z\",\n \"gateway_options\": {},\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"restriction\": {\n \"payment_methods\": {\n \"allow\": [\n \"momo_mtn\"\n ],\n \"deny\": [\n \"card\"\n ]\n },\n \"payment_method_categories\": {\n \"allow\": [\n \"mobile_money\"\n ],\n \"deny\": [\n \"crypto\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.com/v1/payment/intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 50,\n \"currency\": \"USD\",\n \"description\": \"Order #1042\",\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"ORDER-1042\",\n \"return_url\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"statement_descriptor\": \"<string>\",\n \"receipt_email\": \"[email protected]\",\n \"entity_id\": \"<string>\",\n \"entity_created_at\": \"2023-11-07T05:31:56Z\",\n \"gateway_options\": {},\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"restriction\": {\n \"payment_methods\": {\n \"allow\": [\n \"momo_mtn\"\n ],\n \"deny\": [\n \"card\"\n ]\n },\n \"payment_method_categories\": {\n \"allow\": [\n \"mobile_money\"\n ],\n \"deny\": [\n \"crypto\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"id": "pi_7Ba4Xq",
"reference": "ORDER-1042",
"amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"customer": {
"id": "cus_2f8Kd1",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"avatar_url": "<string>"
},
"status": "pending",
"description": "Order #1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "<string>",
"metadata": {},
"active_attempt": {
"id": "att_9Kd12f",
"method": {
"value": "test",
"label": "<string>",
"description": "<string>",
"icon_url": "<string>",
"category": "<string>",
"requires_phone": true
},
"amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"exchange_rate": {
"value": "0.92000000",
"from_currency": "USD",
"to_currency": "EUR",
"expression": "$1.00 ≈ €0.92"
},
"correction_rate": 123,
"status": "processing",
"gateway": {
"transaction": {
"id": "<string>",
"reference": "<string>",
"external_id": "<string>",
"status": "<string>"
}
},
"next_action": {
"type": "none",
"message": "<string>",
"instructions": [
"<string>"
],
"dial_code": "<string>",
"digits": 123,
"is_strict": true,
"fields": [
{}
],
"url": "<string>",
"method": "<string>",
"post_data": {},
"can_auto_redirect": true,
"content": "<string>",
"image_url": "<string>",
"title": "<string>",
"provider": "<string>",
"sdk_url": "<string>",
"public_key": "<string>",
"client_params": {},
"container_id": "<string>"
},
"failure": {
"code": {
"value": "<string>",
"category": "CUSTOMER_ERROR",
"message": "<string>"
},
"message": "<string>"
},
"failover": {
"is_failover": true,
"decision": {}
},
"processing_at": "2023-11-07T05:31:56Z",
"action_required_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"restriction": {
"payment_methods": {
"allow": [
"momo_mtn"
],
"deny": [
"card"
]
},
"payment_method_categories": {
"allow": [
"mobile_money"
],
"deny": [
"crypto"
]
}
},
"completed_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "The given data was invalid.",
"errors": {}
}{
"message": "<string>"
}Authorizations
Your secret key, e.g. sk_live_... or sk_sandbox_....
Headers
Optional key, 8 to 128 characters, that makes this request safe to retry. The first response is stored for 24 hours; a repeat returns it unchanged with X-Idempotent-Replayed: true.
Required string length:
8 - 128Body
application/json
Amount in major units. 50 means 50.00.
Required range:
x >= 1Example:
50
Uppercase ISO 4217 code.
Required string length:
3Example:
"USD"
Maximum string length:
500Example:
"Order #1042"
Show child attributes
Show child attributes
Your payment identifier. When provided, it must be unique within the project.
Maximum string length:
191Example:
"ORDER-1042"
Maximum string length:
2048Deliveries to this URL are not signed. Re-read the payment before acting on one.
Maximum string length:
2048Maximum string length:
22Pattern:
^[A-Za-z0-9\s.,\-]+$Maximum string length:
255Your own identifier for the thing being paid for.
Maximum string length:
191Must not be in the future.
Optional processor-specific parameters, keyed by gateway code. Only gateways that declare options accept a section, and each section is validated against that gateway's own schema; an unknown code or an unsupported option is rejected. The codes and options available to your project are listed in your dashboard.
Example:
{}
Up to 10 key/value pairs of your own, returned unchanged.
Example:
{ "order_id": "1042" }
Narrow the methods this payment may use. Applies to every attempt on it, whoever creates them.
Show child attributes
Show child attributes
Start an attempt immediately, when you already know the method. Rejected with 422 when restriction forbids the method.
Show child attributes
Show child attributes
Was this page helpful?