Skip to content

Payments Object

Relationships

Schema relationships 
graph LR
    Payments -->|"customer"| Customers
    Payments -->|"order_id"| Orders

Properties

idstring
required·

Unique identifier for the payment

amountstring

Amount of the payment

created_atstring · date-time

Date and time when the payment was created

currencystring

Currency of the payment

customerobject
References: Customers → id
emailstring

Email of the customer

idstring

Unique identifier for the customer

namestring

Name of the customer

phonestring

Phone number of the customer

descriptionstring

Description of the payment

expires_onstring · date-time

Date and time when the payment expires

metadataobject
order_idstring

Unique identifier for the order related to this payment.

References: Orders → id
payment_methodobject
idstring

Unique identifier for the payment method

methodstring

Method of payment

reference_idstring

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

refund_amountstring

Refund amount of the payment

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

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

Possible values:
pendingauthorizedpaidpartialrefundedvoidedcancelledunknown
transaction_feestring

Transaction fee on a payment