Skip to main content
POST
Node.js SDK

Path Parameters

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

Body

application/json
network
string
required
Required string length: 1 - 32
asset
string
required
Required string length: 1 - 100

Response

Default Response

id
string
required
object
enum<string>
required
Available options:
public_funding_intent
application_name
string
required
branding
object
required
status
enum<string>
required
Available options:
CREATED,
AWAITING_PAYMENT,
PARTIALLY_FUNDED,
PAYMENT_DETECTED,
PAYMENT_CONFIRMED,
ROUTING,
SETTLING,
SETTLED,
CREDITED,
FAILED,
REFUND_PENDING,
REFUNDED,
EXPIRED,
CANCELLED
stellar_network
enum<string>
required
Available options:
testnet,
mainnet,
local
expired
boolean
required
requirement
object
required
received_amount
string
required
asset
object | null
required
destination
object
required
funding_instructions
object
required
selected_payment_option
object | null
required
payment
object | null
required
settlement_status
enum<string> | null
required
Available options:
PENDING,
SUBMITTED,
CONFIRMING,
CONFIRMED,
FAILED
failure
object | null
required
expires_at
string
required
created_at
string
required
updated_at
string
required