Issue a checkout
curl --request POST \
--url https://api.quidkey.com/v1/transactions/{id}:issueCheckout \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.quidkey.com/v1/transactions/{id}:issueCheckout"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.quidkey.com/v1/transactions/{id}:issueCheckout', 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.quidkey.com/v1/transactions/{id}:issueCheckout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.quidkey.com/v1/transactions/{id}:issueCheckout"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.quidkey.com/v1/transactions/{id}:issueCheckout")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quidkey.com/v1/transactions/{id}:issueCheckout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"result": {
"_type": "transaction",
"_uri": "<string>",
"_view": "full",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "payment",
"is_test": true,
"transaction_number": "<string>",
"status": "pending",
"reason": "<string>",
"failure": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"required_actions": [
{
"code": "<string>",
"message": "<string>",
"actor": "api",
"target": {
"_link": "<string>",
"_type": "<string>",
"id": "<string>"
},
"fields": [
"<string>"
],
"hosted_link": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
}
],
"amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"payout_amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"exchange_rate": {
"rate": "<string>",
"from_currency": "<string>",
"to_currency": "<string>"
},
"fees": {
"total": {
"value": 4503599627370495,
"currency": "<string>"
},
"items": [
{
"type": "percentage",
"amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"tax_amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"rate": "<string>",
"status": "pending",
"settled_at": "2023-11-07T05:31:56Z"
}
]
},
"routing": "virtual_account",
"refund_status": "refunding",
"can_refund": true,
"order": {
"order_id": "<string>"
},
"rewards": {
"extra_rewards": "<string>",
"total_rewards": "<string>",
"description": "<string>"
},
"reported_statement_descriptor": "<string>",
"platform": "api",
"merchant": {
"_link": "<string>",
"_type": "merchant",
"id": "<string>"
},
"customer_details": {
"_link": "<string>",
"_type": "customer_details",
"id": "<string>"
},
"parent_transaction": {
"_link": "<string>",
"_type": "transaction",
"id": "<string>"
},
"refunds": {
"_link": "<string>",
"_type": "collection"
},
"reversals": [
{
"_link": "<string>",
"_type": "transaction",
"id": "<string>"
}
],
"payout": {
"_link": "<string>",
"_type": "payout",
"id": "<string>"
},
"checkout": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
},
"entities": {},
"not_included": [
{
"link": {
"_link": "<string>",
"_type": "<string>",
"id": "<string>"
},
"reason": "no_permission"
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}transaction
Issue a checkout
Answers with the one-time checkout for a pending payment transaction. It never rotates a live token, so a customer already on the page is not stranded, and past expiry it issues a new one. Safe to repeat. Only the owner of the payment transaction can do this: the partner that created it, while the merchant is still with that partner, and otherwise the merchant. For any other caller, and on a payment transaction from a payment link or an e-commerce platform, it answers 404.
Credentials: partner, merchant
Permission: transactions:issue-checkout
Issue a checkout
curl --request POST \
--url https://api.quidkey.com/v1/transactions/{id}:issueCheckout \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.quidkey.com/v1/transactions/{id}:issueCheckout"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.quidkey.com/v1/transactions/{id}:issueCheckout', 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.quidkey.com/v1/transactions/{id}:issueCheckout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.quidkey.com/v1/transactions/{id}:issueCheckout"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.quidkey.com/v1/transactions/{id}:issueCheckout")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quidkey.com/v1/transactions/{id}:issueCheckout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"result": {
"_type": "transaction",
"_uri": "<string>",
"_view": "full",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "payment",
"is_test": true,
"transaction_number": "<string>",
"status": "pending",
"reason": "<string>",
"failure": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"required_actions": [
{
"code": "<string>",
"message": "<string>",
"actor": "api",
"target": {
"_link": "<string>",
"_type": "<string>",
"id": "<string>"
},
"fields": [
"<string>"
],
"hosted_link": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
}
],
"amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"payout_amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"exchange_rate": {
"rate": "<string>",
"from_currency": "<string>",
"to_currency": "<string>"
},
"fees": {
"total": {
"value": 4503599627370495,
"currency": "<string>"
},
"items": [
{
"type": "percentage",
"amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"tax_amount": {
"value": 4503599627370495,
"currency": "<string>"
},
"rate": "<string>",
"status": "pending",
"settled_at": "2023-11-07T05:31:56Z"
}
]
},
"routing": "virtual_account",
"refund_status": "refunding",
"can_refund": true,
"order": {
"order_id": "<string>"
},
"rewards": {
"extra_rewards": "<string>",
"total_rewards": "<string>",
"description": "<string>"
},
"reported_statement_descriptor": "<string>",
"platform": "api",
"merchant": {
"_link": "<string>",
"_type": "merchant",
"id": "<string>"
},
"customer_details": {
"_link": "<string>",
"_type": "customer_details",
"id": "<string>"
},
"parent_transaction": {
"_link": "<string>",
"_type": "transaction",
"id": "<string>"
},
"refunds": {
"_link": "<string>",
"_type": "collection"
},
"reversals": [
{
"_link": "<string>",
"_type": "transaction",
"id": "<string>"
}
],
"payout": {
"_link": "<string>",
"_type": "payout",
"id": "<string>"
},
"checkout": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
},
"entities": {},
"not_included": [
{
"link": {
"_link": "<string>",
"_type": "<string>",
"id": "<string>"
},
"reason": "no_permission"
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"retryable": true,
"request_id": "<string>"
}
}