Skip to main content
POST
Node.js SDK

Authorizations

Authorization
string
header
required

Application API authentication for developer backends: Authorization: Bearer ur_test_... or ur_live_.... Resolves the application, its environment and the key's status. Never a dashboard login.

Headers

idempotency-key
string
Required string length: 1 - 255

Body

application/json
amount
string
required
Maximum string length: 60
Pattern: ^\d+(\.\d+)?$
asset
string
required
Required string length: 1 - 100
destination
object
reference
string
Maximum string length: 255
metadata
object
expires_at
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Default Response

id
string
required
object
enum<string>
required
Available options:
funding_intent
application_id
string
required
requirement
object
required
destination
object
required
source
object | null
required
quote
object | null
required
route
object | null
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
received_amount
string
required
deposit_account
object | null
required
reference
string | null
required
metadata
object
required
protocol
object
required
funding_instructions
object
required
payment
object | null
required
settlement
object | null
required
failure
object | null
required
hosted_funding_url
string | null
required
expires_at
string
required
created_at
string
required
updated_at
string
required