Get a checkout link

One link, with what it has received.

GET

GET/checkout/organizations/{orgId}/links/{linkId}

curl -s "$AVVIO_BASE_URL/checkout/organizations/$AVVIO_ORG_ID/links/$linkId" \
  -H "x-api-key: $AVVIO_API_KEY"

const linkId = '<linkId>';

const res = await fetch(`${process.env.AVVIO_BASE_URL}/checkout/organizations/${process.env.AVVIO_ORG_ID}/links/${linkId}`, {
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
  },
});
console.log(res.status, await res.json());

import os
import requests

linkId = "<linkId>"

res = requests.get(
    f"{os.environ['AVVIO_BASE_URL']}/checkout/organizations/{os.environ['AVVIO_ORG_ID']}/links/{linkId}",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
    },
)
print(res.status_code, res.json())

200OK

{
  "id": "4f1c2a9e-8f7d-4c3b-9a2e-6b5d4c3f2a10",
  "number": "CHECKOUT",
  "paymentReference": null,
  "deepLink": "avvio://i/7e2a9c4b1d0f",
  "slug": "7e2a9c4b1d0f",
  "status": "sent",
  "shareUrl": "https://business.avvio.xyz/i/7e2a9c4b1d0f",
  "fromName": "Northstar Consulting",
  "fromEmail": null,
  "fromAddress": null,
  "customerName": null,
  "customerEmail": null,
  "customerAddress": null,
  "customerId": null,
  "feeTotal": "0",
  "settlementCurrency": "USDC",
  "settlementAmount": "150.00",
  "dueType": "on_receipt",
  "dueDate": null,
  "paidAt": null,
  "emailedAt": null,
  "currency": "USD",
  "subtotal": "150.00",
  "taxRate": "0",
  "taxName": null,
  "taxInclusive": false,
  "taxTotal": "0.00",
  "total": "150.00",
  "memo": null,
  "statementDescriptor": null,
  "adaptivePricing": false,
  "issuedAt": "2026-09-12T09:58:00.000Z",
  "createdAt": "2026-09-12T09:58:00.000Z",
  "items": [
    {
      "id": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
      "description": "Consulting (60 min)",
      "detail": null,
      "quantity": "1",
      "unitAmount": "150.00",
      "amount": "150.00"
    }
  ],
  "methods": [
    {
      "kind": "card",
      "enabled": true,
      "token": null,
      "chain": null,
      "currency": null,
      "depositAddress": null,
      "bankAccountRef": null,
      "cashAppPayload": null
    }
  ],
  "product": {
    "id": "2a7b8c9d-1e2f-4a5b-8c9d-0e1f2a3b4c5d",
    "name": "Consulting (60 min)"
  },
  "received": null,
  "successUrl": "https://example.com/thanks",
  "cancelUrl": "https://example.com/pricing",
  "clientReferenceId": "order_1042",
  "metadata": {
    "orderId": "1042"
  },
  "expiresAt": null,
  "source": "api"
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "detail": "1 field(s) failed validation",
  "resolution": "Correct the fields listed in `errors` and retry.",
  "errors": [
    "amount must be a decimal string with at most 2 decimal places, e.g. \"49.00\""
  ],
  "requestId": "req-9re",
  "message": "1 field(s) failed validation",
  "statusCode": 400
}

{
  "type": "UNAUTHORIZED",
  "status": 401,
  "detail": "Invalid API key",
  "resolution": "Check the API key was copied whole and has not been revoked.",
  "requestId": "req-9bz",
  "message": "Invalid API key",
  "statusCode": 401
}

{
  "type": "FORBIDDEN",
  "status": 403,
  "detail": "This API key cannot access that organization",
  "resolution": "This key is scoped to a different organization.",
  "requestId": "req-9d0",
  "message": "This API key cannot access that organization",
  "statusCode": 403
}

{
  "type": "RATE_LIMITED",
  "status": 429,
  "detail": "ThrottlerException: Too Many Requests",
  "resolution": "Back off and retry after the Retry-After interval.",
  "requestId": "req-9e1",
  "message": "ThrottlerException: Too Many Requests",
  "statusCode": 429
}

Path parameters

orgIdstringRequired
The opaque organization id issued to you, normally CUID-shaped (for example cmsx…). It is not an org_-prefixed alias. Pass it unchanged in every organization-scoped path.
linkIdstringRequired
The link's id (not its slug).

Responses

200The link.

Body · CheckoutLink

idstringRequired
Use this in every /links/{linkId} path.
numberstringOptional
Inherited from the invoice shape. Always CHECKOUT on a link; internal, never shown to a buyer and never the wire reference (that is slug).
paymentReferencestring | nullOptional
Inherited from the invoice shape. Null on a link; a bank payer references the slug.
deepLinkstring | nullOptional
Inherited from the invoice shape: an avvio:// app link to the same page.
fromEmailstring | nullOptional
Inherited from the invoice shape. Your contact email as shown to the buyer, when set.
fromAddressstring | nullOptional
Inherited from the invoice shape. Your address as shown to the buyer, when set.
customerName | nullOptional
Inherited from the invoice shape. Always null; a link is addressed to nobody.
customerEmail | nullOptional
Always null on a link.
customerAddress | nullOptional
Always null on a link.
customerId | nullOptional
Always null on a link.
feeTotalstringOptional
Inherited from the invoice shape. "0" on a link; processing fees are on each payment, not the link.
settlementCurrencystringOptional
Inherited from the invoice shape. The stablecoin the crypto rail settles in when offered; informational on a card link.
settlementAmountstringOptional
Inherited from the invoice shape. The total in settlementCurrency.
dueTypestringOptional
Inherited from the invoice shape. Always on_receipt on a link; a link has no due date.
dueDate | nullOptional
Always null on a link.
paidAt | nullOptional
Always null on a link. A link never closes; each payment carries its own paidAt.
emailedAt | nullOptional
Always null on a link. Links are not emailed to a customer.
slugstringRequired
The public page's path segment (the end of shareUrl), the avvio_link value on a success redirect, and the reference a bank payer types.
statusstringRequired
draft is not publicly readable. sent is live. cancelled is paused and expired is past its expiresAt: both are terminal, and the page answers 410.
Allowed values:draftsentcancelledexpired
shareUrlstring<uri> | nullRequired
The page to send buyers to. Null only when the environment has no public page URL configured.
fromNamestringRequired
currencystringRequired
subtotalstringOptional
taxRatestringOptional
taxNamestring | nullOptional
taxInclusivebooleanOptional
taxTotalstringOptional
totalstringRequired
What one buyer pays.
memostring | nullOptional
statementDescriptorstring | nullOptional
adaptivePricingbooleanOptional
issuedAtstring<date-time> | nullOptional
When it was published.
createdAtstring<date-time>Required
itemsarray of objectOptional
Show 6 properties
- idstringOptional
  Response only. The line's id.
- descriptionstringOptional
- detailstring | nullOptional
- quantitystringOptional
- unitAmountstringOptional
- amountstringOptional
  quantity × unitAmount, rounded once at the currency's precision. Response only.
methodsarray of objectOptional
Show 8 properties
- kindstringRequired
  How a buyer may pay. card is the hosted card page (card, wallets and PayPal in one).
  Allowed values:cardbankcryptocashapp
- enabledbooleanRequired
- tokenstring | nullOptional
- chainstring | nullOptional
- currencystring | nullOptional
- depositAddressstring | nullOptional
- bankAccountRefobject | nullOptional
  Bank rail only. The receiving account as you stored it on the link; the same object the public payer page shows a buyer.
- cashAppPayloadobject | nullOptional
productobject | nullRequired
The catalog product it was made from; null for an ad-hoc link.
Show 2 properties
- idstringRequired
- namestringRequired
receivedobject | nullRequired
What the link has taken in, summed over its paid and refunded payments. Base units with decimals beside them. Null on the link until the first payment lands, so "never paid" is not a zero.
Show 5 properties
- countintegerRequired
  Qualifying payments. Pending and reversed rows are not counted.
- grossBasestringRequired
  What arrived.
- refundedBasestringRequired
  What went back.
- currencystringRequired
- decimalsintegerRequired
successUrlstring<uri> | nullRequired
cancelUrlstring<uri> | nullRequired
clientReferenceIdstring | nullRequired
metadataobject | nullRequired
expiresAtstring<date-time> | nullRequired
When the link stops taking payments, or null for "until paused". Past it the page answers 410 and status reads expired within a minute.
sourcestringRequired
Who made the link (your server through an API key, or a person in the dashboard). The dashboard lists the two apart.
Allowed values:apidashboard

Errors

400
VALIDATION_ERROR (a field is malformed; errors names each), BAD_REQUEST (a request we understood but cannot carry out, named in detail: editing a published link, deleting one that was live, both productId and items), LINK_EXPIRED (publishing a draft whose expiresAt has passed), or, on a write, IDEMPOTENCY_KEY_REQUIRED / IDEMPOTENCY_KEY_INVALID (the header is missing or malformed).
401
The key was refused. Nothing ran.
- UNAUTHORIZED: missing, invalid or revoked, or a key on a route that does not accept one.
- KEY_EXPIRED: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated.
- KEY_IP_NOT_ALLOWED: the key is pinned to source addresses and this request came from another.
403
A valid key that may not make this call. Nothing ran.
- FORBIDDEN: the key belongs to a different organization, or your business has not completed verification to accept payments (every checkout call but refund is refused until it has; detail says which).
- ACCOUNT_BLOCKED: API access for your organization is suspended.
404
No such link or product in this organization, or the id belongs to another one.
429
Too many requests. The default ceiling is 100 requests per minute per API credential on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies.

Obey Retry-After; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same Idempotency-Key.

Error body · Error

typestringRequired
Stable machine-readable code.
detailstringRequired
What went wrong, in a sentence. Always a string, so detail.toLowerCase() is safe.
More
This is the field to read on BAD_REQUEST and PROVIDER_REJECTED, where the type alone does not name the condition.
messagestringRequired
The same text as detail, kept for integrations written before detail existed. Read detail.
resolutionstringOptional
What to do about it, when there is a specific answer. It is not on every error (it is absent on BAD_REQUEST, NOT_FOUND, PAYOUT_NOT_CANCELABLE and DESTINATION_ACCOUNT_NOT_FOUND), so treat it as optional and fall back to detail.
statusintegerRequired
HTTP status, repeated in the body.
statusCodeintegerRequired
The same value as status, kept for integrations written before status existed. Read status.
requestIdstringRequired
Quote this to support and we can find the exact request. Also sent as the x-request-id response header, which is the only place it appears on a successful response. Success bodies do not carry it. Send your own x-request-id on the request and we use it, so your trace and ours share one identifier; otherwise we mint one.
errorsarray of stringOptional
Present on VALIDATION_ERROR; names each field that failed.
originalIdempotencyKeystringOptional
On DUPLICATE_REQUEST_DETECTED only. Send the request again with this to receive the original payout instead of making a second one. Without it there is no way to recover except by risking a double payment.
originalPayoutIdstringOptional
On DUPLICATE_REQUEST_DETECTED only. The payout the first request created.
originalBatchIdstringOptional
On a batch DUPLICATE_REQUEST_DETECTED. The run the first request created.
originalRequestIdstringOptional
On a 409 PAYOUT_OUTCOME_UNKNOWN replay. The requestId of the call whose outcome is unknown; quote it to support.
existingRecipientIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The recipient in your organization that already holds this account.
existingMethodIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The payment method on that recipient.

Branch on type, never on the status or the message. Every error type is listed with what to do about it.

Avvio Checkout · Checkout links · operation getCheckoutLink

Try it: Get a checkout link

GET https://api.avvio.xyz/business/api/v1/checkout/organizations/{orgId}/links/{linkId}

API key Required

Test keys only. Sent as x-api-key through this site's proxy to the Avvio API, never saved, and cleared when you close this dialog.

orgId pathRequired

linkId pathRequired

Was this page helpful?