Skip to main content
GET
/
invoices
/
{id}
Retrieve an invoice
curl --request GET \
  --url https://payoes.com/api/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://payoes.com/api/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://payoes.com/api/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://payoes.com/api/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://payoes.com/api/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://payoes.com/api/v1/invoices/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://payoes.com/api/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": "inv_abc123xyz",
  "object": "invoice",
  "invoice_number": "INV-000001",
  "amount": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "settlement_asset": {
    "asset_code": "USDC",
    "issuer_address": "<string>"
  },
  "allowed_assets": [
    {
      "asset_code": "USDC",
      "issuer_address": "<string>"
    }
  ],
  "description": "<string>",
  "metadata": {},
  "customer_id": "<string>",
  "checkout_session_id": "<string>",
  "checkout_url": "<string>",
  "hosted_invoice_url": "<string>",
  "items": [
    {
      "description": "<string>",
      "quantity": "<string>",
      "unit_amount": "10.5"
    }
  ],
  "due_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z"
}
{
"error": "Unauthorized"
}
{
"error": "Payment not found"
}

Authorizations

Authorization
string
header
required

API key from the Payoes dashboard (pk_test_... or pk_live_...)

Path Parameters

id
string
required

Public invoice ID

Example:

"inv_abc123xyz"

Response

Invoice details

id
string
required
Example:

"inv_abc123xyz"

object
enum<string>
required
Available options:
invoice
invoice_number
string
required
Example:

"INV-000001"

status
enum<string>
required
Available options:
draft,
open,
paid,
void
amount
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
settlement_asset
object | null

From the linked payment after finalize (null on draft)

allowed_assets
object[]
description
string | null
metadata
object | null
customer_id
string | null
checkout_session_id
string | null
checkout_url
string<uri> | null
hosted_invoice_url
string<uri> | null

Public invoice page (/i/inv_...)

items
object[]
due_at
string<date-time> | null
paid_at
string<date-time> | null
sent_at
string<date-time> | null