Submit a checkout payment action
curl --request POST \
--url https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"action": "submit_otp",
"checkout_ref": "<string>",
"action_data": {}
}
'import requests
url = "https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action"
payload = {
"action": "submit_otp",
"checkout_ref": "<string>",
"action_data": {}
}
headers = {
"Authorization": "<authorization>",
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'X-Api-Key': '<x-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({action: 'submit_otp', checkout_ref: '<string>', action_data: {}})
};
fetch('https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action', 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://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action",
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' => 'submit_otp',
'checkout_ref' => '<string>',
'action_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"X-Api-Key: <x-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://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action"
payload := strings.NewReader("{\n \"action\": \"submit_otp\",\n \"checkout_ref\": \"<string>\",\n \"action_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("X-Api-Key", "<x-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://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action")
.header("Authorization", "<authorization>")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"submit_otp\",\n \"checkout_ref\": \"<string>\",\n \"action_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["X-Api-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"submit_otp\",\n \"checkout_ref\": \"<string>\",\n \"action_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {}
}{
"message": "<string>",
"status": "error"
}Checkout
Submit a checkout payment action
Continues an in-progress checkout payment that needs another interactive step (for example card OTP entry). Authorised by checkout_ref, which must have been issued for this payment or for the payment link it belongs to.
POST
/
payment-links
/
payments
/
{payment_id}
/
action
Submit a checkout payment action
curl --request POST \
--url https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"action": "submit_otp",
"checkout_ref": "<string>",
"action_data": {}
}
'import requests
url = "https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action"
payload = {
"action": "submit_otp",
"checkout_ref": "<string>",
"action_data": {}
}
headers = {
"Authorization": "<authorization>",
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'X-Api-Key': '<x-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({action: 'submit_otp', checkout_ref: '<string>', action_data: {}})
};
fetch('https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action', 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://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action",
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' => 'submit_otp',
'checkout_ref' => '<string>',
'action_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"X-Api-Key: <x-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://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action"
payload := strings.NewReader("{\n \"action\": \"submit_otp\",\n \"checkout_ref\": \"<string>\",\n \"action_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("X-Api-Key", "<x-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://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action")
.header("Authorization", "<authorization>")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"submit_otp\",\n \"checkout_ref\": \"<string>\",\n \"action_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.pcxpay.com/v1/payment-links/payments/{payment_id}/action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["X-Api-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"submit_otp\",\n \"checkout_ref\": \"<string>\",\n \"action_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {}
}{
"message": "<string>",
"status": "error"
}Headers
Body
application/json