Checkout

List the ways a payer may fund this intent

Every asset the payer may send, priced by the routing engine: what they would send, the fees that would be charged including Useroutr’s own, and how long the route usually takes. Nothing here is binding: the amounts are estimates until an option is selected. Assets that cannot be routed are returned as unavailable with a reason rather than omitted. Requires no credential; the funding page token is the capability.

GET

public

funding-intents

{token}

payment-options

Node.js SDK

import { HttpCheckoutApi } from "@useroutr/checkout-core";

const checkout = new HttpCheckoutApi({
  baseUrl: "https://api.sandbox.useroutr.com/v1/public",
  token: "8sf6B570T1UkUIPhcltW2CTdnhHtRLDK",
});
const { options } = await checkout.paymentOptions();

{
  "object": "public_payment_options",
  "funding_intent_id": "<string>",
  "application_name": "<string>",
  "branding": {
    "brand_color": "<string>",
    "logo_url": "<string>"
  },
  "requirement": {
    "amount": "<string>",
    "asset": {
      "id": "<string>",
      "symbol": "<string>",
      "decimals": 0
    }
  },
  "payment_methods": [
    {
      "type": "CRYPTO",
      "available": true,
      "unavailable_reason": "<string>"
    }
  ],
  "options": [
    {
      "network": "<string>",
      "asset": {
        "id": "<string>",
        "symbol": "<string>",
        "decimals": 0
      },
      "estimated_send_amount": "<string>",
      "fees": {
        "total": "<string>",
        "asset": "<string>",
        "items": [
          {
            "type": "NETWORK",
            "asset": "<string>",
            "amount": "<string>"
          }
        ]
      },
      "estimated_duration_seconds": 0,
      "available": true,
      "unavailable_reason": "<string>"
    }
  ],
  "expires_at": "<string>"
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Path Parameters

token

string

required

Pattern: ^[A-Za-z0-9_-]{16,128}$

Response

Default Response

object

enum<string>

required

Available options:

public_payment_options

funding_intent_id

string

required

application_name

string

required

branding

object

required

Show child attributes

requirement

object

required

Show child attributes

payment_methods

object[]

required

Show child attributes

options

object[]

required

Show child attributes

expires_at

string

required

Node.js SDK

import { HttpCheckoutApi } from "@useroutr/checkout-core";

const checkout = new HttpCheckoutApi({
  baseUrl: "https://api.sandbox.useroutr.com/v1/public",
  token: "8sf6B570T1UkUIPhcltW2CTdnhHtRLDK",
});
const { options } = await checkout.paymentOptions();

{
  "object": "public_payment_options",
  "funding_intent_id": "<string>",
  "application_name": "<string>",
  "branding": {
    "brand_color": "<string>",
    "logo_url": "<string>"
  },
  "requirement": {
    "amount": "<string>",
    "asset": {
      "id": "<string>",
      "symbol": "<string>",
      "decimals": 0
    }
  },
  "payment_methods": [
    {
      "type": "CRYPTO",
      "available": true,
      "unavailable_reason": "<string>"
    }
  ],
  "options": [
    {
      "network": "<string>",
      "asset": {
        "id": "<string>",
        "symbol": "<string>",
        "decimals": 0
      },
      "estimated_send_amount": "<string>",
      "fees": {
        "total": "<string>",
        "asset": "<string>",
        "items": [
          {
            "type": "NETWORK",
            "asset": "<string>",
            "amount": "<string>"
          }
        ]
      },
      "estimated_duration_seconds": 0,
      "available": true,
      "unavailable_reason": "<string>"
    }
  ],
  "expires_at": "<string>"
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Overview

Endpoints

List the ways a payer may fund this intent

Path Parameters

Response