Skip to main content
GET
Get PayOrder

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API key for authentication

Path Parameters

payorder_id
string
required

Response

PayOrder details

id
string
required
Example:

"cuidjkhg3e289y74u5t6v"

created_at
string<date-time>
required
Example:

"2023-01-01T00:00:00Z"

updated_at
string<date-time>
required
Example:

"2023-01-01T00:00:00Z"

organization_id
string
required
Example:

"org_1234567890abcdef"

mode
enum<string>
required
Available options:
SALE,
DEPOSIT,
REFUND,
SWAP,
FEE_CLAIM
Example:

"DEPOSIT"

status
enum<string>
required
Available options:
PENDING,
EXPIRED,
FAILED,
AWAITING_PAYMENT,
OPTIMISTIC_CONFIRMED,
AWAITING_CONFIRMATION,
EXECUTING_ORDER,
COMPLETED,
REFUNDED,
PARTIAL_PAYMENT
Example:

"PENDING"

fulfillment
object
required
Example:
hosted_url
string
required
Example:

"https://pay.coinvoyage.io/pay/cuidjkhg3e289y74u5t6v"

payment
object | null
Example:
metadata
object | null
Example:
settings
object

Widget/client UI settings configured on the organization. Known fields are documented here; arbitrary extra JSON settings are also allowed.

Example: