Get an invoice
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/invoices/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/invoices/{id}"
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.rails.wayex.com/v1/invoices/{id}', 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.rails.wayex.com/v1/invoices/{id}",
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.rails.wayex.com/v1/invoices/{id}"
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.rails.wayex.com/v1/invoices/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/invoices/{id}")
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{
"id": "<string>",
"number": "<string>",
"counterpartyId": "<string>",
"periodFrom": "2023-11-07T05:31:56Z",
"periodTo": "2023-11-07T05:31:56Z",
"status": "draft",
"currency": "AUD",
"lines": [
{
"type": "kyc",
"description": "<string>",
"count": 1,
"amount": "<string>",
"amountMinor": "<string>"
}
],
"platformFeesDue": "<string>",
"platformFeesDueMinor": "<string>",
"developerFeesCredit": "<string>",
"developerFeesCreditMinor": "<string>",
"tax": "<string>",
"taxMinor": "<string>",
"netDue": "<string>",
"netDueMinor": "<string>",
"inflowCollected": [
{
"asset": "AUD",
"amount": "<string>",
"amountMinor": "<string>",
"count": 1
}
],
"generatedAt": "2023-11-07T05:31:56Z",
"generatedBy": "<string>",
"issuedAt": "2023-11-07T05:31:56Z",
"issuedBy": "<string>",
"settledAt": "2023-11-07T05:31:56Z",
"settledBy": "<string>",
"voidedAt": "2023-11-07T05:31:56Z",
"voidedBy": "<string>"
}Webhooks and account administration
Get an invoice
Returns line items and status for one invoice.
GET
/
v1
/
invoices
/
{id}
Get an invoice
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/invoices/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/invoices/{id}"
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.rails.wayex.com/v1/invoices/{id}', 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.rails.wayex.com/v1/invoices/{id}",
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.rails.wayex.com/v1/invoices/{id}"
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.rails.wayex.com/v1/invoices/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/invoices/{id}")
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{
"id": "<string>",
"number": "<string>",
"counterpartyId": "<string>",
"periodFrom": "2023-11-07T05:31:56Z",
"periodTo": "2023-11-07T05:31:56Z",
"status": "draft",
"currency": "AUD",
"lines": [
{
"type": "kyc",
"description": "<string>",
"count": 1,
"amount": "<string>",
"amountMinor": "<string>"
}
],
"platformFeesDue": "<string>",
"platformFeesDueMinor": "<string>",
"developerFeesCredit": "<string>",
"developerFeesCreditMinor": "<string>",
"tax": "<string>",
"taxMinor": "<string>",
"netDue": "<string>",
"netDueMinor": "<string>",
"inflowCollected": [
{
"asset": "AUD",
"amount": "<string>",
"amountMinor": "<string>",
"count": 1
}
],
"generatedAt": "2023-11-07T05:31:56Z",
"generatedBy": "<string>",
"issuedAt": "2023-11-07T05:31:56Z",
"issuedBy": "<string>",
"settledAt": "2023-11-07T05:31:56Z",
"settledBy": "<string>",
"voidedAt": "2023-11-07T05:31:56Z",
"voidedBy": "<string>"
}What this endpoint does
Returns line items and status for one invoice.When to use it
Use it for invoice detail, accounting export, or support investigation.Before you call
Authenticate with an API key that can read fees — a scoped key must includefees:read (fees:write implies it); this family also covers revenue and invoices — and pass an invoice ID owned by the same tenant account.
Money and balance effect
This is a read-only request. It does not reserve, debit, credit, or settle money.States and completion
Use the invoice status and amounts as returned; a listed invoice is not necessarily settled.Safe retries
GET requests are read-only and may be retried with normal exponential backoff. Do not send anIdempotency-Key.
Read Revenue and invoices for the complete workflow.Authorizations
BearerApiKey
Send the same Wayex API key as Authorization: Bearer <key>.
Path Parameters
Response
The invoice.
Minimum string length:
1Pattern:
^INV-\d{6}-\d{4}$Minimum string length:
1Available options:
draft, issued, settled, void Available options:
AUD Show child attributes
Show child attributes
Pattern:
^-?\d+(\.\d+)?$Pattern:
^-?\d+$Pattern:
^-?\d+(\.\d+)?$Pattern:
^-?\d+$Pattern:
^\d+(\.\d+)?$Pattern:
^\d+$Pattern:
^-?\d+(\.\d+)?$Pattern:
^-?\d+$Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1
