Skip to main content
GET
Get a payment

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Payment ID

Example:

"pay_abc123"

Response

Payment retrieved successfully

id
string
required

Payment ID

Example:

"d4e5f6a7-b8c9-4d0e-a1f2-3b4c5d6e7f8a"

type
enum<string>
required

Payment type

Available options:
PAYOUT,
PAYIN
Example:

"PAYOUT"

status
enum<string>
required

Payment status

Available options:
AWAITING_FUNDS,
PENDING,
PROCESSING,
SENT,
COMPLETED,
CANCELED,
FAILED,
EXPIRED,
REFUNDED,
SCHEDULED,
UNDER_REVIEW
Example:

"COMPLETED"

source
object
required

Source payment details

destination
object
required

Destination payment details

created_at
string
required

Payment creation timestamp

Example:

"2026-01-20T15:20:00.000Z"

updated_at
string
required

Payment last update timestamp

Example:

"2026-01-20T15:20:30.000Z"

settlement_request_id
object | null

Associated settlement request ID

Example:

"d4e5f6a7-b8c9-4d0e-a1f2-3b4c5d6e7f8a"

fee
object | null

Fee amount

Example:

"0.50"

metadata
object | null

Custom metadata attached to the payment

Example:
failure_reason
object | null

Failure reason if payment failed

Example:

"Insufficient funds"

completed_at
object | null

Payment completion timestamp

Example:

"2026-01-20T15:20:30.000Z"