Read a payment request
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}', 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-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}"
req, _ := http.NewRequest("GET", 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.get("https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"data": {
"reference": "3f9c1b2a-9d84-4e15-8c26-0b7a5d3e1f90",
"status": "open",
"expires_at": "2026-09-11T10:30:00Z",
"source_type": "wallet",
"destination_type": "bank",
"payment_type": "send",
"amount": 250,
"currency": "USD",
"fee": 3,
"destinations_supported": false,
"fields": {
"reference": {
"required": true,
"requirements": []
},
"idempotency_key": {
"required": true,
"requirements": []
},
"wallet_id": {
"required": true,
"requirements": []
},
"payee_destination_id": {
"required": true,
"requirements": [
{
"field": "bank_account_number",
"label": "Bank account number"
},
{
"field": "last_name",
"label": "Last name"
}
]
},
"user_id": {
"required": false,
"requirements": []
},
"payment_category": {
"required": false,
"requirements": []
},
"metadata": {
"required": false,
"requirements": []
},
"from_hold": {
"required": false,
"requirements": []
},
"notify_recipient": {
"required": false,
"requirements": []
}
}
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get a Payment Request
Re-read a reference issued by request-payload: the same body, with a live
status — open while it can still be used, consumed once a payment was
created from it, expired once expires_at has passed without one.
GET
/
v1
/
platform
/
payments
/
request-payload
/
{reference}
Read a payment request
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}', 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-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}"
req, _ := http.NewRequest("GET", 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.get("https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payments/request-payload/{reference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"data": {
"reference": "3f9c1b2a-9d84-4e15-8c26-0b7a5d3e1f90",
"status": "open",
"expires_at": "2026-09-11T10:30:00Z",
"source_type": "wallet",
"destination_type": "bank",
"payment_type": "send",
"amount": 250,
"currency": "USD",
"fee": 3,
"destinations_supported": false,
"fields": {
"reference": {
"required": true,
"requirements": []
},
"idempotency_key": {
"required": true,
"requirements": []
},
"wallet_id": {
"required": true,
"requirements": []
},
"payee_destination_id": {
"required": true,
"requirements": [
{
"field": "bank_account_number",
"label": "Bank account number"
},
{
"field": "last_name",
"label": "Last name"
}
]
},
"user_id": {
"required": false,
"requirements": []
},
"payment_category": {
"required": false,
"requirements": []
},
"metadata": {
"required": false,
"requirements": []
},
"from_hold": {
"required": false,
"requirements": []
},
"notify_recipient": {
"required": false,
"requirements": []
}
}
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The reference request-payload returned.
Response
Payment request
Standard response wrapper for single-object responses and errors.
Generic over the payload type. A route that declares
CommonResponse[SomeModel] gets the real data schema rendered in
OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

