id | The token identifier returned by tokenization (e.g. token-1). Referenced as mode.tokenId when paying | string |
created_at | Timestamp is in UTC yyyy-MM-ddTHH:mm:ssZ all time values in our API are in UTC time as per ISO8601 | string |
deleted | | boolean |
user_id | | string |
merchant_id | | string |
business_id | | string |
store_id | | string |
| amount | Payment amount in minor units of currency (1000 = 10.00 USD) | |
amount.currency | ISO 4217 currency code, e.g. USD | string |
amount.value | 0 | integer |
amount.display | | string |
| amount_without_charges | | |
amount_without_charges.currency | | string |
amount_without_charges.value | 0 | integer |
amount_without_charges.display | | string |
| charges | | |
charges.id | | string |
charges.product | | |
charges.percentage | | integer |
| charges.amount | | string |
charges.amount.currency | | |
charges.amount.value | | integer |
charges.amount.display | | string |
country | | string |
| billing_address | | |
billing_address.country | | string |
billing_address.city | | string |
billing_address.postal_code | | string |
billing_address.street_name | | string |
billing_address.house_number | | string |
billing_address.state_or_province | | string |
card_holder_name | | string |
provider | | |
method | | |
status | Card verification result: verified (usable for payments) or failed (not usable) | |
errors | string | string |
| amount_split | | |
amount_split.basketValue | | integer |
amount_split.tax | | integer |
amount_split.deliveryFee | | integer |
amount_split.driverTip | | integer |
amount_split.restaurantTip | | integer |
| amount_after_refund | | |
amount_after_refund.currency | | string |
amount_after_refund.value | | integer |
amount_after_refund.display | | integer |
provider_id | | string |
external_id | | string |
reporting_id | | string |
cancellation_reference | | string |
refund_reference | | string |
external_reference | | string |
gatewayProfileId | Identifier of the gateway profile — the configuration that determines which PSP/gateway setup handles the token or payment (e.g. gateway-1) | string |
channelLinkId | Identifier of the channel link — the connection between a channel and a Deliverect location (e.g. channelLink-1) | string |
customerId | The channel's identifier for the end customer. Ties the vaulted token to a customer for reuse (e.g. customer-1) | string |
| payment_method | Object containing raw card details (number, expiration_month, expiration_year, cvc). Sent only to the BasisTheory proxy, never to Deliverect Pay directly | object |
| mode | Object describing how the payment is funded. For this flow, type is token and tokenId references a verified token | object |
captureMode | immediate — capture funds instantly (default); manual — pre-authorize now, capture later | string |
| payer | Object identifying the paying customer: name (display name) and reference (channel-side customer reference) | object |
paymentId | Identifier of the created payment (e.g. payment-1) | string |
paymentStatus | Status of the payment, e.g. authorized | string |
