# Models

Base URL: `https://api.omni.integratedcommerce.io/v1`. Authenticate every request with your API key in the `x-api-key` header (see [Authentication](https://doura.ca/docs/get-started/authentication.md)). Shared types are defined under [Models](https://doura.ca/docs/api-reference/models.md). The machine-readable OpenAPI 3.1 spec is at https://doura.ca/docs/openapi.json.

Every schema used by the API, one Markdown page each.

## Models

- [ResponseCode](https://doura.ca/docs/api-reference/models/responsecode.md): The outcome of the payment, and the field that tells you whether the transaction succeeded. The HTTP status, `resultCode`, and `status` do not. A transaction su
- [CardType](https://doura.ca/docs/api-reference/models/cardtype.md): The type of card used for this transaction: * `UNKNOWN` - The card type is unknown * `DEBIT` - Debit Card * `VISA` - Visa Credit Card * `MASTERCARD` - MasterCar
- [CVVResult](https://doura.ca/docs/api-reference/models/cvvresult.md): The CVV verification result. Typically returned on Card Not Present transactions. * `M` - CVV Match * `N` - CVV No Match * `P` - Not Processed * `S` - CVV shoul
- [AVSResult](https://doura.ca/docs/api-reference/models/avsresult.md): The AVS (Address Verification Service) result. Typically returned on Card Not Present transactions. * `A` - Address matches, ZIP does not. The first five numeri
- [BillingInfoCaptureLevel](https://doura.ca/docs/api-reference/models/billinginfocapturelevel.md): Controls how much billing information is collected in the hosted payment form. * `Minimal` - Collects country and ZIP/postal code in a compact layout below the 
- [FormConfig](https://doura.ca/docs/api-reference/models/formconfig.md): Optional form configuration. If omitted, the payment method defaults apply. With no configured default, billing capture is `Full` and 3D Secure is disabled. Whe
- [ErrorDetail](https://doura.ca/docs/api-reference/models/errordetail.md): Represents a validation error that occurred during the request.
- [Receipt](https://doura.ca/docs/api-reference/models/receipt.md): Receipt lines for this transaction response. Card-present responses can contain printable receipt lines; other responses can return an empty lines array.
- [ApprovedAmountBreakdown](https://doura.ca/docs/api-reference/models/approvedamountbreakdown.md): A breakdown of approvedAmount, where each amounts approved on the payment terminal are returned separately. Only returned on Sale, Auth and Capture transactions
- [ReferenceIdForTransactions](https://doura.ca/docs/api-reference/models/referenceidfortransactions.md): An optional custom reference ID for this transaction. Include this if you want to use your own reference system for linking transactions together (for example, 
- [ReferenceIdForVoid](https://doura.ca/docs/api-reference/models/referenceidforvoid.md): An optional custom reference ID for this void transaction. Include this if you want to use your own reference system for linking transactions together. Use a un
- [ReferenceIdForTokens](https://doura.ca/docs/api-reference/models/referenceidfortokens.md): An optional custom reference ID to tag and track this token operation. Use a unique value per merchant. This field is not an idempotency key and reusing it does
- [ReferenceIdForResponse](https://doura.ca/docs/api-reference/models/referenceidforresponse.md): The reference ID for this transaction. This will either be the reference ID provided in the transaction request or, if no value was provided, a value generated 
- [OriginalTransactionId](https://doura.ca/docs/api-reference/models/originaltransactionid.md): The transaction ID (`trx_`) of the original authorization to capture, or sale/capture to refund. Supply exactly one of originalTransactionId and originalReferen
- [OriginalTransactionIdForVoid](https://doura.ca/docs/api-reference/models/originaltransactionidforvoid.md): The unique transaction ID of the original transaction to be voided. This is the 'id' value returned from a previous sale, authorization, or capture transaction.
- [OriginalReferenceId](https://doura.ca/docs/api-reference/models/originalreferenceid.md): The reference ID of the original transaction to be captured or refunded. This should match the referenceId from a previous sale, authorization, or capture trans
- [OriginalReferenceIdForVoid](https://doura.ca/docs/api-reference/models/originalreferenceidforvoid.md): The reference ID of the original transaction to be voided. This should match the referenceId from a previous sale, authorization, or capture transaction (either
- [InvoiceNumber](https://doura.ca/docs/api-reference/models/invoicenumber.md): An optional alphanumeric invoice number for this transaction. If provided in the request, the same value will be populated in the response.
- [InvoiceNumberCardPresent](https://doura.ca/docs/api-reference/models/invoicenumbercardpresent.md): An optional alphanumeric invoice number for this transaction. If provided in the request, the same value will be populated in the response and will appear on th
- [OrderNumber](https://doura.ca/docs/api-reference/models/ordernumber.md): An optional alphanumeric order number for this transaction. If provided, the same value will be populated in the response.
- [Amount](https://doura.ca/docs/api-reference/models/amount.md): The total transaction amount. This is the full amount that will be processed in the transaction. Transaction amounts are positive integers representing the amou
- [AmountBreakdown](https://doura.ca/docs/api-reference/models/amountbreakdown.md): Optional fields to specify the portion of the total transaction amount that represents goods/services, tax, cashback and/or tip. These values are for reporting 
- [AmountToCapture](https://doura.ca/docs/api-reference/models/amounttocapture.md): The amount to capture. Must be less than or equal to the original authorization amount. If not specified, the full authorized amount will be captured. If you ha
- [AmountToRefund](https://doura.ca/docs/api-reference/models/amounttorefund.md): The requested amount to refund or void. If not specified, the full transaction amount will be refunded or voided. For partial refunds, must be less than the ori
- [AmountToRefundUnreferenced](https://doura.ca/docs/api-reference/models/amounttorefundunreferenced.md): The requested amount to refund.
- [ResultCode](https://doura.ca/docs/api-reference/models/resultcode.md): Result codes: * `0` - Successful transaction request. (Check each transactionResponse's responseCode to determine if a transaction was approved or declined, car
- [ResultText](https://doura.ca/docs/api-reference/models/resulttext.md): A message describing the result code in more detail. On a stored transaction it is uppercase, such as `APPROVED`, `DECLINED`, or the gateway's reason, except fo
- [PaymentMethodDetails](https://doura.ca/docs/api-reference/models/paymentmethoddetails.md): The payment method used for this transaction.
- [TransactionResponse](https://doura.ca/docs/api-reference/models/transactionresponse.md): A single Sale Transaction may result in multiple Responses.
- [ThreeDsStatus](https://doura.ca/docs/api-reference/models/threedsstatus.md): Outcome classification of the 3D Secure check performed on a card transaction. Only present on transactions initiated with `formConfig.enable3DSecure: true`. Us
- [ThreeDsAuthentication](https://doura.ca/docs/api-reference/models/threedsauthentication.md): 3D Secure (EMV 3DS2) authentication outcome. Populated on transactions initiated with `formConfig.enable3DSecure: true`. All fields (other than `status`) are op
- [Error](https://doura.ca/docs/api-reference/models/error.md): Represents an error that occurred during the request.
- [CardPresentRequest](https://doura.ca/docs/api-reference/models/cardpresentrequest.md): Represents the request to process a Card Present transaction using a physical payment terminal.
- [CardNotPresentRequest](https://doura.ca/docs/api-reference/models/cardnotpresentrequest.md): Represents the request to process a Card Not Present transaction using a hosted payment form/iframe.
- [CardOnFileRequest](https://doura.ca/docs/api-reference/models/cardonfilerequest.md): Represents the request to process a Card On File transaction using a token. The token may hold a card or an ACH bank account; an ACH token is accepted for sales
- [CaptureRequest](https://doura.ca/docs/api-reference/models/capturerequest.md): Represents the request to capture a previously authorized transaction.
- [RefundRequest](https://doura.ca/docs/api-reference/models/refundrequest.md): Represents the request to refund or void a previously completed transaction.
- [VoidRequest](https://doura.ca/docs/api-reference/models/voidrequest.md): Represents the request to void a previously completed transaction. The amount is always the full original transaction amount; an amount supplied in this request
- [UnreferencedPhysicalRefundRequest](https://doura.ca/docs/api-reference/models/unreferencedphysicalrefundrequest.md): Represents the request to process a Card Present unreferenced refund without a matching completed sale or capture transaction.
- [UnreferencedVirtualRefundRequest](https://doura.ca/docs/api-reference/models/unreferencedvirtualrefundrequest.md): Represents the request to process a Card Not Present unreferenced refund without a matching completed sale or capture transaction.
- [CardOnFileAddRequest](https://doura.ca/docs/api-reference/models/cardonfileaddrequest.md): Represents the request to tokenize a card using a physical terminal.
- [CardOnFileVirtualAddRequest](https://doura.ca/docs/api-reference/models/cardonfilevirtualaddrequest.md): Represents the request to tokenize a card using a hosted payment form / iframe.
- [CNPVirtualResponse](https://doura.ca/docs/api-reference/models/cnpvirtualresponse.md): Represents the response to a Card Not Present sale or authorization using a hosted payment form / iframe.
- [PaymentMethodsListResponse](https://doura.ca/docs/api-reference/models/paymentmethodslistresponse.md): Paginated response containing payment methods
- [AccountHolderPaymentMethodsListResponse](https://doura.ca/docs/api-reference/models/accountholderpaymentmethodslistresponse.md): Paginated response containing account holder payment methods
- [AccountHolder](https://doura.ca/docs/api-reference/models/accountholder.md): Account holder information associated with the transaction
- [AccountHolderRequest](https://doura.ca/docs/api-reference/models/accountholderrequest.md): Account holder information for associating a transaction or tokenized payment method with a customer. When you provide an `externalId`, the system will either f
- [BillingContact](https://doura.ca/docs/api-reference/models/billingcontact.md): Billing contact information associated with the payment method. Not returned on card present transactions or on refunds, captures, etc. of card present transact
- [TransactionsListResponse](https://doura.ca/docs/api-reference/models/transactionslistresponse.md): Paginated response containing transactions
- [TransactionResponseObject](https://doura.ca/docs/api-reference/models/transactionresponseobject.md): Represents the response to a sale or authorization transaction.
- [CNPTransactionResponse](https://doura.ca/docs/api-reference/models/cnptransactionresponse.md): Represents the response to a Card Not Present sale or authorization using a previously tokenized card.
- [CaptureResponse](https://doura.ca/docs/api-reference/models/captureresponse.md): Represents the response to a capture request.
- [RefundResponse](https://doura.ca/docs/api-reference/models/refundresponse.md): Represents the response to a refund request.
- [VoidResponse](https://doura.ca/docs/api-reference/models/voidresponse.md): Represents the response to a void request.
- [CardOnFileAddResponse](https://doura.ca/docs/api-reference/models/cardonfileaddresponse.md): Represents the response to a physical card tokenization request.
- [CardOnFileVirtualAddResponse](https://doura.ca/docs/api-reference/models/cardonfilevirtualaddresponse.md): Represents the response to a hosted payment form / iframe card tokenization request.
- [CardOnFileRemoveResponse](https://doura.ca/docs/api-reference/models/cardonfileremoveresponse.md): Represents the response to a tokenized card removal request.
- [WebhookEvent](https://doura.ca/docs/api-reference/models/webhookevent.md): Webhook event details.
- [SaleCompletedWebhook](https://doura.ca/docs/api-reference/models/salecompletedwebhook.md): Represents the webhook triggered when a financial transaction is processed and completed.
- [AuthCompletedWebhook](https://doura.ca/docs/api-reference/models/authcompletedwebhook.md): Represents the webhook triggered when a transaction authorization is completed.
- [CaptureCompletedWebhook](https://doura.ca/docs/api-reference/models/capturecompletedwebhook.md): Represents the webhook triggered when a transaction capture for a previously authorized transaction is completed.
- [RefundCompletedWebhook](https://doura.ca/docs/api-reference/models/refundcompletedwebhook.md): Represents the webhook triggered when a transaction void or refund for a previously completed transaction is completed.
- [VoidCompletedWebhook](https://doura.ca/docs/api-reference/models/voidcompletedwebhook.md): Represents the webhook triggered when a transaction void for a previously completed transaction is completed.
- [ChargebackCompletedWebhook](https://doura.ca/docs/api-reference/models/chargebackcompletedwebhook.md): Represents the webhook triggered when an ACH chargeback is recorded. The payload is the chargeback transaction, with `type` `Chargeback` and `originalTransactio
- [TokenCreatedWebhook](https://doura.ca/docs/api-reference/models/tokencreatedwebhook.md): Represents the webhook triggered when a card is tokenized and stored as a payment method.
- [TokenRemovedWebhook](https://doura.ca/docs/api-reference/models/tokenremovedwebhook.md): Represents the webhook triggered when a previously tokenized card is removed from the system.
- [MerchantLifecycleWebhookEvent](https://doura.ca/docs/api-reference/models/merchantlifecyclewebhookevent.md): Webhook event details for merchant lifecycle events. Extends the standard event envelope with the merchant the event relates to, once a merchant record exists.
- [MerchantLifecycleWebhookData](https://doura.ca/docs/api-reference/models/merchantlifecyclewebhookdata.md): Details for a merchant lifecycle event. Every field is always present; fields that do not apply to the event type are null. Payloads are PII-safe by design - th
- [MerchantApplicationStartedWebhook](https://doura.ca/docs/api-reference/models/merchantapplicationstartedwebhook.md): Represents the webhook triggered when a merchant begins filling out their onboarding application.
- [MerchantApplicationSubmittedWebhook](https://doura.ca/docs/api-reference/models/merchantapplicationsubmittedwebhook.md): Represents the webhook triggered when a merchant submits their onboarding application for review.
- [MerchantApplicationStatusChangedWebhook](https://doura.ca/docs/api-reference/models/merchantapplicationstatuschangedwebhook.md): Represents the webhook triggered when a merchant application moves between review stages (e.g. into Underwriting or Onboarding).
- [MerchantApplicationRequiresActionWebhook](https://doura.ca/docs/api-reference/models/merchantapplicationrequiresactionwebhook.md): Represents the webhook triggered when a merchant application needs more information or documents from the merchant before review can continue.
- [MerchantApplicationInfoUploadedWebhook](https://doura.ca/docs/api-reference/models/merchantapplicationinfouploadedwebhook.md): Represents the webhook triggered when a merchant provides the requested information or documents on an application that required action.
- [MerchantApprovedWebhook](https://doura.ca/docs/api-reference/models/merchantapprovedwebhook.md): Represents the webhook triggered when a merchant application is approved and the merchant account is created.
- [MerchantRejectedWebhook](https://doura.ca/docs/api-reference/models/merchantrejectedwebhook.md): Represents the webhook triggered when a merchant application is rejected during review.
- [PricingTemplateApprovedWebhook](https://doura.ca/docs/api-reference/models/pricingtemplateapprovedwebhook.md): Represents the webhook triggered when a submitted pricing template is approved in review and its onboarding links become active.
- [PricingTemplateRejectedWebhook](https://doura.ca/docs/api-reference/models/pricingtemplaterejectedwebhook.md): Represents the webhook triggered when a submitted pricing template is declined in review.
- [SettlementFeeBreakdown](https://doura.ca/docs/api-reference/models/settlementfeebreakdown.md): Optional breakdown of the components of a fee charge. Only the components that apply to a given fee are present. Components are signed integers in minor units; 
- [SettlementSummary](https://doura.ca/docs/api-reference/models/settlementsummary.md): A summary of a processor-reported transfer of payment proceeds to the merchant's bank account. It identifies the activity grouped into one deposit and reports i
- [SettlementLineItem](https://doura.ca/docs/api-reference/models/settlementlineitem.md): A processor-reported line showing how payment or dispute activity contributes to a merchant deposit. It records the activity's amount and processor identifiers,
- [SettlementDetailResponse](https://doura.ca/docs/api-reference/models/settlementdetailresponse.md): A summary of a processor-reported transfer of payment proceeds to the merchant's bank account. It identifies the activity grouped into one deposit and reports i
- [SettlementsListResponse](https://doura.ca/docs/api-reference/models/settlementslistresponse.md): Paginated response containing settlements
- [SettlementTransaction](https://doura.ca/docs/api-reference/models/settlementtransaction.md): A processor-reported line showing how payment or dispute activity contributes to a merchant deposit. This list representation includes the parent settlement's s
- [SettledTransactionsListResponse](https://doura.ca/docs/api-reference/models/settledtransactionslistresponse.md): Paginated response containing settled transactions
- [SettledTransactionReference](https://doura.ca/docs/api-reference/models/settledtransactionreference.md): The settled transaction a per-transaction fee applies to, mirroring that transaction's identity. Present only on per-transaction fees. Combine `gatewayTransacti
- [FeeCharge](https://doura.ca/docs/api-reference/models/feecharge.md): A record of a merchant cost, a pending monthly rollup, or an informational component of that rollup. Its status states whether it has been billed. See [Fee char
- [FeeChargesListResponse](https://doura.ca/docs/api-reference/models/feechargeslistresponse.md): Paginated response containing merchant fee charges
- [TransactionStatus](https://doura.ca/docs/api-reference/models/transactionstatus.md): The processing lifecycle, separate from approval or decline. `Pending` waits for customer input; `Submitted`, `Acknowledged`, and `Processing` are in flight; `A
- [ThreeDsChallenge](https://doura.ca/docs/api-reference/models/threedschallenge.md): Present when a token payment requires a cardholder challenge (`resultCode: 4100`).