Get a payment instruction - Spendin API

Get a payment instruction

curl --request GET \
  --url https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction', 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.spendin.app/v1/payouts/{payout_id}/payment-instruction",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "b7e2f1a0-...",
  "payout_id": "a1b2c3d4-...",
  "rail": "CRYPTO",
  "account_unique": "TXyz1234...abc",
  "provider_name": "USDT (TRC-20)",
  "network": "TRC20",
  "expected_amount": 42.32,
  "expected_currency": "USDT",
  "payment_status": "UNPAID",
  "expires_at": "2026-07-20T10:11:00.000Z",
  "paid_at": null,
  "created_at": "2026-07-20T09:41:00.000Z"
}

GET

/

v1

/

payouts

/

{payout_id}

/

payment-instruction

Get a payment instruction

curl --request GET \
  --url https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction', 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.spendin.app/v1/payouts/{payout_id}/payment-instruction",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.spendin.app/v1/payouts/{payout_id}/payment-instruction")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "b7e2f1a0-...",
  "payout_id": "a1b2c3d4-...",
  "rail": "CRYPTO",
  "account_unique": "TXyz1234...abc",
  "provider_name": "USDT (TRC-20)",
  "network": "TRC20",
  "expected_amount": 42.32,
  "expected_currency": "USDT",
  "payment_status": "UNPAID",
  "expires_at": "2026-07-20T10:11:00.000Z",
  "paid_at": null,
  "created_at": "2026-07-20T09:41:00.000Z"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

payout_id

string<uuid>

required

Response

Active instruction

id

string

required

Example:

"b7e2f1a0-..."

payout_id

string

required

Example:

"a1b2c3d4-..."

rail

enum<string>

required

Available options:

CRYPTO,

BANK_TRANSFER

Example:

"CRYPTO"

account_unique

string

required

Crypto address (CRYPTO) or virtual account number (BANK_TRANSFER) the merchant settles to

Example:

"TXyz1234...abc"

provider_name

string

required

Example:

"USDT (TRC-20)"

network

object | null

required

Example:

"TRC20"

expected_amount

number

required

Amount the merchant must send

Example:

42.32

expected_currency

string

required

Example:

"USDT"

payment_status

enum<string>

required

Available options:

UNPAID,

PAID,

EXPIRED

Example:

"UNPAID"

expires_at

string

required

Example:

"2026-07-20T10:11:00.000Z"

paid_at

object | null

required

Example:

null

created_at

string

required

Example:

"2026-07-20T09:41:00.000Z"

⌘I