Skip to main content
GET
Retrieve a payment

Authorizations

Authorization
string
header
required

API key from the Payoes dashboard (pk_test_... or pk_live_...)

Path Parameters

id
string
required

Public payment ID

Example:

"pay_nLU2gUDk-v3tdyd6"

Response

Payment details

id
string
required
Example:

"pay_nLU2gUDk-v3tdyd6"

object
enum<string>
required
Available options:
payment_intent
amount
string
required
Example:

"2.0000000"

settlement_asset
object
required
allowed_assets
object[]
required
status
enum<string>
required
Available options:
pending,
completed,
failed,
expired
checkout_url
string<uri>
required
created_at
string<date-time>
required
paid_asset
object | null

Asset the customer actually paid with (set after checkout)

description
string | null
metadata
object | null
source_type
enum<string>
Available options:
direct,
checkout_session,
payment_link,
invoice
customer_id
string | null
payer_address
string | null
tx_hash
string | null
confirmed_at
string<date-time> | null
expires_at
string<date-time> | null