Skip to main content
GET
Get a payment

Authorizations

x-spacepay-secret-key
string
header
required

Secret key for authentication of external API.

Path Parameters

paymentId
string
required

Response

Payment retrieved successfully

id
string<uuid>
required

Payment ID

merchantId
string<uuid>
required

Merchant ID

merchantShortName
string
required

Merchant short name

merchantLogoUrl
string | null
required

Merchant logo URL

type
enum<string>
required

Payment type

Available options:
payment,
deposit
amountInCents
number
required

Payment amount in cents

amountDueCents
number
required

Amount due in cents. Provisional until a quote is paid, then finalized to the paid quote (chain-specific convenience fee).

convenienceFeeCents
number | null
required

Convenience fee in cents charged to the buyer. Null until the payment settles.

merchantFeeCents
number | null
required

Merchant fee in cents deducted from the merchant. Null until the payment settles.

swapFeeCents
number | null
required

Swap fee in cents deducted from the merchant. Null until the payment settles.

currency
enum<string>
required

Currency of the payment

Available options:
USD
status
enum<string>
required

Payment status

Available options:
pending,
processing,
completed,
failed,
expired,
cancelled
quotes
object[]
required

Quotes

receipt
object | null
required

Receipt

orderId
string | null
required

Order ID

redirectUrl
string | null
required

Redirect URL

createdAt
string<date-time>
required

Created at

amountMerchantNetCents
number
required

Amount the merchant receives after fees, in cents