Skip to content

Payments Object



id
string
REQUIRED · 

Unique identifier for the payment

amount
string

Amount of the payment

currency
string

Currency of the payment

transaction_fee
string

Transaction fee on a payment

refund_amount
string

Refund amount of the payment

status
string

Status of the payment. In case there is no clear mapping, the raw status is passed.

All possible enum values:
  • pending
  • authorized
  • paid
  • partial
  • refunded
  • voided
  • cancelled
  • unknown
customer
object
id
string

Unique identifier for the customer

name
string

Name of the customer

email
string

Email of the customer

phone
string

Phone number of the customer

description
string

Description of the payment

payment_method
object
method
string

Method of payment

id
string

Unique identifier for the payment method

created_at
string · date-time

Date and time when the payment was created

expires_on
string · date-time

Date and time when the payment expires

reference_id
string

Reference ID of the payment. This can be used to lookup payments in the system.

order_id
string

Unique identifier for the order related to this payment.

metadata
object
remote_data
object

Raw data returned from the remote API call.