Payment API - Glossary

Payment Attributes

ParametersMeaningType
idToken identifier returned by tokenization (for example, token-1). Reference it as mode.tokenId when paying.string
created_atUTC timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.string
deletedIndicates whether the token or payment record has been deleted.boolean
user_idIdentifier of the user associated with the token or payment.string
merchant_idIdentifier of the merchant associated with the payment.string
business_idIdentifier of the business associated with the payment.string
store_idIdentifier of the store associated with the payment.string
amountPayment amount in minor units of currency (1000 = 10.00 USD).
amount.currencyISO 4217 currency code, for example USD.string
amount.valueAmount in the currency's minor unit.integer
amount.displayHuman-readable formatted amount.string
amount_without_chargesPayment amount before charges are applied.
amount_without_charges.currencyISO 4217 currency code for the pre-charge amount.string
amount_without_charges.valuePre-charge amount in the currency's minor unit.integer
amount_without_charges.displayHuman-readable formatted pre-charge amount.string
chargesCharges applied to the payment.
charges.idIdentifier of the charge.string
charges.productProduct associated with the charge.string
charges.percentagePercentage used to calculate the charge.integer
charges.amountAmount charged.string
charges.amount.currencyISO 4217 currency code for the charge amount.string
charges.amount.valueCharge amount in the currency's minor unit.integer
charges.amount.displayHuman-readable formatted charge amount.string
countryCountry associated with the payment.string
billing_addressBilling address associated with the payment method.
billing_address.countryCountry in the billing address.string
billing_address.cityCity in the billing address.string
billing_address.postal_codePostal or ZIP code in the billing address.string
billing_address.street_nameStreet name in the billing address.string
billing_address.house_numberHouse or building number in the billing address.string
billing_address.state_or_provinceState, province, or region in the billing address.string
card_holder_nameName shown on the card.string
providerPayment service provider that processes the payment.
methodPayment method used for the payment.
statusCard verification result: verified (usable for payments) or failed (not usable).
errorsError details returned when processing or verification fails.string
amount_splitBreakdown of the payment amount by order component.
amount_split.basketValueBasket value in the currency's minor unit.integer
amount_split.taxTax amount in the currency's minor unit.integer
amount_split.deliveryFeeDelivery fee in the currency's minor unit.integer
amount_split.driverTipDriver tip in the currency's minor unit.integer
amount_split.restaurantTipRestaurant tip in the currency's minor unit.integer
amount_after_refundPayment amount remaining after refunds.
amount_after_refund.currencyISO 4217 currency code for the remaining amount.string
amount_after_refund.valueRemaining amount in the currency's minor unit.integer
amount_after_refund.displayHuman-readable formatted remaining amount.integer
provider_idIdentifier assigned by the payment service provider.string
external_idIdentifier assigned by an external system.string
reporting_idIdentifier used for reporting.string
cancellation_referenceReference for the cancellation associated with the payment.string
refund_referenceReference for the refund associated with the payment.string
external_referenceReference assigned by an external system.string
gatewayProfileIdIdentifier of the gateway profile — the configuration that determines which PSP or gateway setup handles the token or payment (for example, gateway-1).string
channelLinkIdIdentifier of the channel link — the connection between a channel and a Deliverect location (for example, channelLink-1).string
customerIdChannel identifier for the end customer. It ties the vaulted token to a customer for reuse (for example, customer-1).string
payment_methodObject containing raw card details: number, expiration_month, expiration_year, and cvc. Send it only to the BasisTheory proxy, never directly to Deliverect Pay.object
modeObject describing how the payment is funded. For this flow, type is token and tokenId references a verified token.object
captureModeimmediate captures funds instantly (default); manual pre-authorizes now and captures later.string
payerObject identifying the paying customer: name (display name) and reference (channel-side customer reference).object
paymentIdIdentifier of the created payment (for example, payment-1).string
paymentStatusStatus of the payment, for example authorized.string