--- updatedAt: 2026-08-30T18:12:15.000Z agentTools: projectIndex: https://developers.deliverect.com/llms.txt --- # Payment API - Glossary # Payment Attributes | Parameters | Meaning | Type | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | | `id` | Token identifier returned by tokenization (for example, `token-1`). Reference it as `mode.tokenId` when paying. | string | | `created_at` | UTC timestamp in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. | string | | `deleted` | Indicates whether the token or payment record has been deleted. | boolean | | `user_id` | Identifier of the user associated with the token or payment. | string | | `merchant_id` | Identifier of the merchant associated with the payment. | string | | `business_id` | Identifier of the business associated with the payment. | string | | `store_id` | Identifier of the store associated with the payment. | string | | **amount** | Payment amount in minor units of `currency` (`1000` = 10.00 USD). | | | amount.`currency` | ISO 4217 currency code, for example `USD`. | string | | amount.`value` | Amount in the currency's minor unit. | integer | | amount.`display` | Human-readable formatted amount. | string | | **amount\_without\_charges** | Payment amount before charges are applied. | | | amount\_without\_charges.`currency` | ISO 4217 currency code for the pre-charge amount. | string | | amount\_without\_charges.`value` | Pre-charge amount in the currency's minor unit. | integer | | amount\_without\_charges.`display` | Human-readable formatted pre-charge amount. | string | | **charges** | Charges applied to the payment. | | | charges.`id` | Identifier of the charge. | string | | charges.`product` | Product associated with the charge. | string | | charges.`percentage` | Percentage used to calculate the charge. | integer | | **charges.amount** | Amount charged. | string | | charges.amount.`currency` | ISO 4217 currency code for the charge amount. | string | | charges.amount.`value` | Charge amount in the currency's minor unit. | integer | | charges.amount.`display` | Human-readable formatted charge amount. | string | | `country` | Country associated with the payment. | string | | **billing\_address** | Billing address associated with the payment method. | | | billing\_address.`country` | Country in the billing address. | string | | billing\_address.`city` | City in the billing address. | string | | billing\_address.`postal_code` | Postal or ZIP code in the billing address. | string | | billing\_address.`street_name` | Street name in the billing address. | string | | billing\_address.`house_number` | House or building number in the billing address. | string | | billing\_address.`state_or_province` | State, province, or region in the billing address. | string | | `card_holder_name` | Name shown on the card. | string | | `provider` | Payment service provider that processes the payment. | | | `method` | Payment method used for the payment. | | | `status` | Card verification result: `verified` (usable for payments) or `failed` (not usable). | | | `errors` | Error details returned when processing or verification fails. | string | | **amount\_split** | Breakdown of the payment amount by order component. | | | amount\_split.`basketValue` | Basket value in the currency's minor unit. | integer | | amount\_split.`tax` | Tax amount in the currency's minor unit. | integer | | amount\_split.`deliveryFee` | Delivery fee in the currency's minor unit. | integer | | amount\_split.`driverTip` | Driver tip in the currency's minor unit. | integer | | amount\_split.`restaurantTip` | Restaurant tip in the currency's minor unit. | integer | | **amount\_after\_refund** | Payment amount remaining after refunds. | | | amount\_after\_refund.`currency` | ISO 4217 currency code for the remaining amount. | string | | amount\_after\_refund.`value` | Remaining amount in the currency's minor unit. | integer | | amount\_after\_refund.`display` | Human-readable formatted remaining amount. | integer | | `provider_id` | Identifier assigned by the payment service provider. | string | | `external_id` | Identifier assigned by an external system. | string | | `reporting_id` | Identifier used for reporting. | string | | `cancellation_reference` | Reference for the cancellation associated with the payment. | string | | `refund_reference` | Reference for the refund associated with the payment. | string | | `external_reference` | Reference assigned by an external system. | string | | `gatewayProfileId` | Identifier of the gateway profile — the configuration that determines which PSP or gateway setup handles the token or payment (for example, `gateway-1`). | string | | `channelLinkId` | Identifier of the channel link — the connection between a channel and a Deliverect location (for example, `channelLink-1`). | string | | `customerId` | Channel identifier for the end customer. It ties the vaulted token to a customer for reuse (for example, `customer-1`). | string | | **payment\_method** | Object containing raw card details: `number`, `expiration_month`, `expiration_year`, and `cvc`. Send it only to the BasisTheory proxy, never directly to Deliverect Pay. | object | | **mode** | Object describing how the payment is funded. For this flow, `type` is `token` and `tokenId` references a verified token. | object | | `captureMode` | `immediate` captures funds instantly (default); `manual` pre-authorizes now and captures later. | string | | **payer** | Object identifying the paying customer: `name` (display name) and `reference` (channel-side customer reference). | object | | `paymentId` | Identifier of the created payment (for example, `payment-1`). | string | | `paymentStatus` | Status of the payment, for example `authorized`. | string |