Get a checkout payment

Get checkout Payment

curl --request GET \
  --url https://prod-api.stableyard.fi/v2/public/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://prod-api.stableyard.fi/v2/public/payments/{paymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://prod-api.stableyard.fi/v2/public/payments/{paymentId}', 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://prod-api.stableyard.fi/v2/public/payments/{paymentId}",
  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://prod-api.stableyard.fi/v2/public/payments/{paymentId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://prod-api.stableyard.fi/v2/public/payments/{paymentId}")

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

{
  "payment": {
    "id": "payment_123",
    "apiVersion": "2026-09-09",
    "intent": "receive",
    "amountMode": "collect_exact",
    "status": "requires_payment_method",
    "stage": null,
    "operationalState": "normal",
    "operationalReasonCode": null,
    "operationalUpdatedAt": null,
    "statusVersion": 1,
    "paymentAmount": {
      "amount": "50.00",
      "amountAtomic": "50000000",
      "assetType": "crypto",
      "assetCode": "USDC",
      "decimals": 6,
      "chainId": 8453,
      "tokenAddress": "0x1111111111111111111111111111111111111111"
    },
    "description": null,
    "externalReference": null,
    "expiresAt": null,
    "createdAt": "2026-08-28T10:00:00.000Z",
    "updatedAt": "2026-08-28T10:00:00.000Z"
  },
  "execution": {
    "appId": "app_123",
    "displayState": "preparing",
    "statusInfo": {
      "code": "example",
      "terminal": true,
      "userActionRequired": true,
      "retryable": true,
      "message": "example",
      "updatedAt": null,
      "nextPollAfterMs": null
    },
    "description": null,
    "returnUrl": null,
    "destinationAmount": {
      "amountAtomic": "10000000",
      "assetSymbol": "USDC",
      "decimals": 6,
      "chainId": 42161,
      "tokenAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831"
    },
    "amounts": {
      "recipient": {
        "amountAtomic": "10000000",
        "amountDecimal": "10",
        "assetSymbol": "USDC",
        "decimals": 6,
        "chainId": 42161,
        "tokenAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831"
      }
    },
    "expiresAt": "2026-08-28T10:00:00.000Z",
    "merchant": {
      "displayName": "Acme Inc",
      "logoUrl": "https://cdn.example.com/acme-logo.png",
      "primaryColor": "#5B5BF6"
    },
    "presentedBy": {
      "displayName": "Acme Platform",
      "logoUrl": null
    },
    "provisioning": {
      "status": "preparing"
    }
  },
  "checkout": {
    "paymentUrl": "https://example.com",
    "clientSecret": "examplexxxxxxxxxxxxxxxxxxxxxxxxx",
    "expiresAt": "2026-08-28T10:00:00.000Z",
    "returnUrl": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication is required"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found"
  }
}

GET

public

payments

{paymentId}

Get checkout Payment

curl --request GET \
  --url https://prod-api.stableyard.fi/v2/public/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://prod-api.stableyard.fi/v2/public/payments/{paymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://prod-api.stableyard.fi/v2/public/payments/{paymentId}', 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://prod-api.stableyard.fi/v2/public/payments/{paymentId}",
  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://prod-api.stableyard.fi/v2/public/payments/{paymentId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://prod-api.stableyard.fi/v2/public/payments/{paymentId}")

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

{
  "payment": {
    "id": "payment_123",
    "apiVersion": "2026-09-09",
    "intent": "receive",
    "amountMode": "collect_exact",
    "status": "requires_payment_method",
    "stage": null,
    "operationalState": "normal",
    "operationalReasonCode": null,
    "operationalUpdatedAt": null,
    "statusVersion": 1,
    "paymentAmount": {
      "amount": "50.00",
      "amountAtomic": "50000000",
      "assetType": "crypto",
      "assetCode": "USDC",
      "decimals": 6,
      "chainId": 8453,
      "tokenAddress": "0x1111111111111111111111111111111111111111"
    },
    "description": null,
    "externalReference": null,
    "expiresAt": null,
    "createdAt": "2026-08-28T10:00:00.000Z",
    "updatedAt": "2026-08-28T10:00:00.000Z"
  },
  "execution": {
    "appId": "app_123",
    "displayState": "preparing",
    "statusInfo": {
      "code": "example",
      "terminal": true,
      "userActionRequired": true,
      "retryable": true,
      "message": "example",
      "updatedAt": null,
      "nextPollAfterMs": null
    },
    "description": null,
    "returnUrl": null,
    "destinationAmount": {
      "amountAtomic": "10000000",
      "assetSymbol": "USDC",
      "decimals": 6,
      "chainId": 42161,
      "tokenAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831"
    },
    "amounts": {
      "recipient": {
        "amountAtomic": "10000000",
        "amountDecimal": "10",
        "assetSymbol": "USDC",
        "decimals": 6,
        "chainId": 42161,
        "tokenAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831"
      }
    },
    "expiresAt": "2026-08-28T10:00:00.000Z",
    "merchant": {
      "displayName": "Acme Inc",
      "logoUrl": "https://cdn.example.com/acme-logo.png",
      "primaryColor": "#5B5BF6"
    },
    "presentedBy": {
      "displayName": "Acme Platform",
      "logoUrl": null
    },
    "provisioning": {
      "status": "preparing"
    }
  },
  "checkout": {
    "paymentUrl": "https://example.com",
    "clientSecret": "examplexxxxxxxxxxxxxxxxxxxxxxxxx",
    "expiresAt": "2026-08-28T10:00:00.000Z",
    "returnUrl": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication is required"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found"
  }
}

Returns the browser-safe canonical Payment and its checkout state. Send the Payment’s clientSecret in the Authorization header as a Bearer token; the credential never belongs in the URL.

Authorizations

Authorization

string

header

required

Short-lived browser capability for exactly one payment_* resource. Never place it in a URL.

Path Parameters

paymentId

string

required

The payment_* ID returned when the Payment was created.

Pattern: ^payment_[A-Za-z0-9_-]+$

Example:

"payment_123"

Response

Public Payment state

payment

object

required

Show child attributes

execution

object

required

Show child attributes

checkout

object

Show child attributes

Introduction

Onboarding

Accounts

Money movement

Activity

Vaults

Client & checkout

Platform

Get a checkout payment

Authorizations

Path Parameters

Response