Start a payment attempt
curl --request POST \
--url https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"method_code": "test",
"country": "US",
"phone": {
"number": "+15550000000",
"country": "US"
},
"currency": "<string>"
}
'import requests
url = "https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts"
payload = {
"method_code": "test",
"country": "US",
"phone": {
"number": "+15550000000",
"country": "US"
},
"currency": "<string>"
}
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({
method_code: 'test',
country: 'US',
phone: {number: '+15550000000', country: 'US'},
currency: '<string>'
})
};
fetch('https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts', 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/{paymentIntentId}/attempts",
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([
'method_code' => 'test',
'country' => 'US',
'phone' => [
'number' => '+15550000000',
'country' => 'US'
],
'currency' => '<string>'
]),
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/{paymentIntentId}/attempts"
payload := strings.NewReader("{\n \"method_code\": \"test\",\n \"country\": \"US\",\n \"phone\": {\n \"number\": \"+15550000000\",\n \"country\": \"US\"\n },\n \"currency\": \"<string>\"\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/{paymentIntentId}/attempts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"method_code\": \"test\",\n \"country\": \"US\",\n \"phone\": {\n \"number\": \"+15550000000\",\n \"country\": \"US\"\n },\n \"currency\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts")
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 \"method_code\": \"test\",\n \"country\": \"US\",\n \"phone\": {\n \"number\": \"+15550000000\",\n \"country\": \"US\"\n },\n \"currency\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"id": "pi_7Ba4Xq",
"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>"
},
"description": "Order #1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "<string>",
"metadata": {},
"refunds_summary": {
"refunded_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"pending_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"refundable_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"has_pending_refund": true
},
"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": 123,
"correction_rate": 123,
"gateway": {
"transaction": {
"id": "<string>",
"reference": "<string>",
"external_id": "<string>",
"status": "<string>"
}
},
"next_action": {
"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>",
"message": "<string>"
},
"message": "<string>"
},
"failover": {
"is_failover": true,
"decision": {}
},
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"completed_at": "2023-11-07T05:31:56Z",
"expires_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 attempts
Start a payment attempt
Attempts to collect the payment with the chosen method. Returns the payment intent; read active_attempt.next_action to know what the payer must do next.
POST
/
payment
/
intents
/
{paymentIntentId}
/
attempts
Start a payment attempt
curl --request POST \
--url https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"method_code": "test",
"country": "US",
"phone": {
"number": "+15550000000",
"country": "US"
},
"currency": "<string>"
}
'import requests
url = "https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts"
payload = {
"method_code": "test",
"country": "US",
"phone": {
"number": "+15550000000",
"country": "US"
},
"currency": "<string>"
}
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({
method_code: 'test',
country: 'US',
phone: {number: '+15550000000', country: 'US'},
currency: '<string>'
})
};
fetch('https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts', 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/{paymentIntentId}/attempts",
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([
'method_code' => 'test',
'country' => 'US',
'phone' => [
'number' => '+15550000000',
'country' => 'US'
],
'currency' => '<string>'
]),
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/{paymentIntentId}/attempts"
payload := strings.NewReader("{\n \"method_code\": \"test\",\n \"country\": \"US\",\n \"phone\": {\n \"number\": \"+15550000000\",\n \"country\": \"US\"\n },\n \"currency\": \"<string>\"\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/{paymentIntentId}/attempts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"method_code\": \"test\",\n \"country\": \"US\",\n \"phone\": {\n \"number\": \"+15550000000\",\n \"country\": \"US\"\n },\n \"currency\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.com/v1/payment/intents/{paymentIntentId}/attempts")
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 \"method_code\": \"test\",\n \"country\": \"US\",\n \"phone\": {\n \"number\": \"+15550000000\",\n \"country\": \"US\"\n },\n \"currency\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"id": "pi_7Ba4Xq",
"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>"
},
"description": "Order #1042",
"return_url": "<string>",
"webhook_url": "<string>",
"statement_descriptor": "<string>",
"receipt_email": "<string>",
"metadata": {},
"refunds_summary": {
"refunded_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"pending_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"refundable_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"has_pending_refund": true
},
"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": 123,
"correction_rate": 123,
"gateway": {
"transaction": {
"id": "<string>",
"reference": "<string>",
"external_id": "<string>",
"status": "<string>"
}
},
"next_action": {
"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>",
"message": "<string>"
},
"message": "<string>"
},
"failover": {
"is_failover": true,
"decision": {}
},
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"completed_at": "2023-11-07T05:31:56Z",
"expires_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 - 128Path Parameters
The payment intent id.
Body
application/json
A code returned by the methods endpoint for this payment. Do not hard-code it.
Example:
"test"
ISO 3166-1 alpha-2 code the payer is paying from.
Required string length:
2Example:
"US"
Show child attributes
Show child attributes
Charge in this currency instead of the intent's.
Required string length:
3Was this page helpful?
⌘I