View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.

API reference Models

DualPricingChannels

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The payment channels a merchant's dual pricing program applies to. A bit flag, the shape `SurchargeChannelFlags` uses, so a merchant can run the program on any combination of the phase 1 channels. Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
None No channel.
VirtualTerminal The merchant-operated Virtual Terminal.
HostedPaymentPage The Hosted Payment Page, both forms, and the payment links that open it.
Api Direct API integrations.
DigitalWallet Digital wallet payments on the channels above.
Invoicing Invoices: the invoice document states both prices, and an automatic charge of the balance and a payment link for the balance or a deposit are charged the card price. A partial payment (an installment or a payment link amount the payer chooses) is charged the cash price.
RecurringBilling Recurring charges, from any source: a scheduled charge of a recurring contract, a merchant-initiated recurring or installment charge, a Hosted Payment Page enrollment's first payment, and a repeat or retry of any of these. A card is charged the card price only when the cardholder's stored-credential consent stated it, and never at a rate above the one the consent stated.
SplitTender Split-tender legs: each payment of a split tender is priced on its own share of the order, a card charged the card price for its share and a cash or bank payment the cash price, while the group balance is kept in cash-price terms. A leg is still priced on the channel it arrived on (the Virtual Terminal or the API), so the merchant names that channel too.
Terminal Card-present sales: a card read at a point of sale (a swipe, a chip read or a tap, or a declared card-present cardholder), whichever source submitted it. The payer saw the merchant's own signage, so naming this channel needs the merchant's attestation that both prices are posted at every card-present point of sale (terminalSignageAttested).

Fields

Field Type Description

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.