openapi: 3.1.0 info: description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build! title: Increase Account Numbers Card Payments API version: 0.0.1 servers: - url: https://api.increase.com - url: https://sandbox.increase.com security: - bearerAuth: [] tags: - description: Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement. name: Card Payments paths: /card_payments: get: operationId: list_card_payments parameters: - in: query name: cursor required: false schema: description: Return the page of entries after this one. type: string x-documentation-priority: low - in: query name: limit required: false schema: description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. minimum: 1 type: integer x-documentation-priority: low - example: account_in71c4amph0vgo2qllky in: query name: account_id required: false schema: description: Filter Card Payments to ones belonging to the specified Account. type: string x-documentation-priority: default x-id-reference-to: Accounts - in: query name: card_id required: false schema: description: Filter Card Payments to ones belonging to the specified Card. type: string x-documentation-priority: default x-id-reference-to: Cards - in: query name: created_at.after required: false schema: description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: created_at.before required: false schema: description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: created_at.on_or_after required: false schema: description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: created_at.on_or_before required: false schema: description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment_list' description: Card Payment List 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: List Card Payments x-sandbox-only: false x-tag: Card Payments tags: - Card Payments /card_payments/{card_payment_id}: get: operationId: retrieve_a_card_payment parameters: - example: card_payment_nd3k2kacrqjli8482ave in: path name: card_payment_id required: true schema: description: The identifier of the Card Payment. type: string x-documentation-priority: default x-id-reference-to: Card Payments responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: Retrieve a Card Payment x-sandbox-only: false x-tag: Card Payments tags: - Card Payments components: schemas: card_authorization: additionalProperties: true description: Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null direction: settlement expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: null physical_card_id: null presentment_amount: 100 presentment_currency: USD processing_category: purchase real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_authorization verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Authorization AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' direction: description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. enum: - settlement - refund type: string x-documentation-priority: default x-enum-descriptions: - A regular card authorization where funds are debited from the cardholder. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. expires_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization will expire and the pending transaction will be released. format: date-time type: string x-documentation-priority: default id: description: The Card Authorization identifier. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Card Authorization NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Card Authorization NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Card Authorization NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Authorization NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' presentment_amount: description: The pending amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default processing_category: description: The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card authorization. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Authorization Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `card_authorization`. enum: - card_authorization type: string x-documentation-priority: default verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Card Authorization Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Card Authorization Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Card Authorization Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Card Authorization Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - type - id - card_payment_id - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - amount - presentment_amount - presentment_currency - currency - direction - actioner - processing_category - expires_at - real_time_decision_id - pending_transaction_id - scheme_fees title: Card Authorization type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Authorizations card_increment: additionalProperties: true description: Card Increments increase the pending amount of an authorized transaction. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: null total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 20 card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_increment_6ztayc58j1od0rpebp3e network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_amount: 20 presentment_currency: USD real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_increment updated_authorization_amount: 120 properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Increment AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The amount of this increment in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_authorization_id: description: The identifier for the Card Authorization this increments. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Increment identifier. type: string x-documentation-priority: default x-id-reference-to: Card Increments network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Increment NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. type: integer x-documentation-priority: default - type: 'null' pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Card Increment. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' presentment_amount: description: The amount of this increment in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this incremental authorization. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card increment. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Increment Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `card_increment`. enum: - card_increment type: string x-documentation-priority: default updated_authorization_amount: description: The updated authorization amount after this increment, in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - type - id - amount - presentment_amount - updated_authorization_amount - currency - presentment_currency - card_authorization_id - network - actioner - real_time_decision_id - pending_transaction_id - additional_amounts - network_risk_score - network_identifiers - scheme_fees title: Card Increment type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Increments error: anyOf: - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 404 type: integer title: type: string type: enum: - api_method_not_found_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - environment_mismatch_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' resource_id: description: '' type: string x-documentation-priority: default status: enum: - 409 type: integer title: type: string type: enum: - idempotency_key_already_used_error type: string required: - type - title - detail - status - resource_id type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - insufficient_permissions_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 500 type: integer title: type: string type: enum: - internal_server_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' reason: description: '' enum: - deleted_credential - expired_credential - ip_not_allowed - no_credential - no_header - no_api_access - wrong_environment type: string x-documentation-priority: default x-enum-descriptions: - deleted_credential - expired_credential - ip_not_allowed - no_credential - no_header - no_api_access - wrong_environment status: enum: - 401 type: integer title: type: string type: enum: - invalid_api_key_error type: string required: - type - title - detail - status - reason type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 409 type: integer title: type: string type: enum: - invalid_operation_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' errors: description: All errors related to parsing the request parameters. items: additionalProperties: true properties: {} title: ErrorsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ErrorsElements type: array x-documentation-priority: default status: enum: - 400 type: integer title: type: string type: enum: - invalid_parameters_error type: string required: - type - title - detail - status - errors type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 400 type: integer title: type: string type: enum: - malformed_request_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 404 type: integer title: type: string type: enum: - object_not_found_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - private_feature_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' retry_after: anyOf: - description: '' type: integer x-documentation-priority: default - type: 'null' status: enum: - 429 type: integer title: type: string type: enum: - rate_limited_error type: string required: - type - title - detail - status type: object x-event-categories: [] card_fuel_confirmation: additionalProperties: true description: Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. example: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_fuel_confirmation_wuy91qate4judq2la80a network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_fuel_confirmation updated_authorization_amount: 120 properties: card_authorization_id: description: The identifier for the Card Authorization this updates. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Fuel Confirmation identifier. type: string x-documentation-priority: default x-id-reference-to: Card Fuel Confirmations network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Fuel Confirmation NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Card Fuel Confirmation. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' scheme_fees: description: The scheme fees associated with this card fuel confirmation. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Fuel Confirmation Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `card_fuel_confirmation`. enum: - card_fuel_confirmation type: string x-documentation-priority: default updated_authorization_amount: description: The updated authorization amount after this fuel confirmation, in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - type - id - updated_authorization_amount - currency - card_authorization_id - network - pending_transaction_id - network_identifiers - scheme_fees title: Card Fuel Confirmation type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Fuel Confirmations card_refund: additionalProperties: true description: Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction. example: amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave cashback: null currency: USD id: card_refund_imgc2xwplh6t4r3gn16e interchange: amount: '0.137465' code: '271' currency: USD merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_name: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_identifiers: acquirer_business_id: '69650702' acquirer_reference_number: '83163715445437604865089' authorization_identification_response: ABC123 transaction_id: '627199945183184' presentment_amount: 100 presentment_currency: USD purchase_details: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_refund properties: amount: description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments cashback: anyOf: - additionalProperties: false description: Cashback debited for this transaction, if eligible. Cashback is paid out in aggregate, monthly. example: amount: '0.137465' currency: USD properties: amount: description: The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency title: Card Refund Cashback type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cashbacks - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Refund identifier. type: string x-documentation-priority: default x-id-reference-to: Card Refunds interchange: anyOf: - additionalProperties: false description: Interchange assessed as a part of this transaction. example: amount: '0.137465' code: '271' currency: USD properties: amount: description: The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default code: anyOf: - description: The card network specific interchange code. type: string x-documentation-priority: default - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency - code title: Card Refund Card Interchange type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Interchanges - type: 'null' merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The 4-digit MCC describing the merchant's business. type: string x-documentation-priority: default merchant_city: description: The city the merchant resides in. type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_name: description: The name of the merchant. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is always a 5-digit ZIP code. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_identifiers: additionalProperties: false description: Network-specific identifiers for this refund. properties: acquirer_business_id: description: A network assigned business ID that identifies the acquirer that processed this transaction. type: string x-documentation-priority: default acquirer_reference_number: description: A globally unique identifier for this settlement. type: string x-documentation-priority: default authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - acquirer_reference_number - acquirer_business_id - authorization_identification_response title: Card Refund NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: NetworkIdentifiers presentment_amount: description: The amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default purchase_details: anyOf: - additionalProperties: false description: Additional details about the card purchase, such as tax and industry-specific fields. example: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null properties: car_rental: anyOf: - additionalProperties: false description: Fields specific to car rentals. properties: car_class_code: anyOf: - description: Code indicating the vehicle's class. type: string x-documentation-priority: default - type: 'null' checkout_date: anyOf: - description: Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date. format: date type: string x-documentation-priority: default - type: 'null' daily_rental_rate_amount: anyOf: - description: Daily rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' daily_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate. type: string x-documentation-priority: default - type: 'null' days_rented: anyOf: - description: Number of days the vehicle was rented. type: integer x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (gas, late fee, etc.) being billed. enum: - no_extra_charge - gas - extra_mileage - late_return - one_way_service_fee - parking_violation type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Gas - Extra mileage - Late return - One way service fee - Parking violation - type: 'null' fuel_charges_amount: anyOf: - description: Fuel charges for the vehicle. type: integer x-documentation-priority: default - type: 'null' fuel_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed. type: string x-documentation-priority: default - type: 'null' insurance_charges_amount: anyOf: - description: Any insurance being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' insurance_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge). enum: - not_applicable - no_show_for_specialized_vehicle type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show for specialized vehicle - type: 'null' one_way_drop_off_charges_amount: anyOf: - description: Charges for returning the vehicle at a different location than where it was picked up. type: integer x-documentation-priority: default - type: 'null' one_way_drop_off_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed. type: string x-documentation-priority: default - type: 'null' renter_name: anyOf: - description: Name of the person renting the vehicle. type: string x-documentation-priority: default - type: 'null' weekly_rental_rate_amount: anyOf: - description: Weekly rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' weekly_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate. type: string x-documentation-priority: default - type: 'null' required: - extra_charges - days_rented - no_show_indicator - checkout_date - daily_rental_rate_amount - daily_rental_rate_currency - weekly_rental_rate_amount - weekly_rental_rate_currency - insurance_charges_amount - insurance_charges_currency - fuel_charges_amount - fuel_charges_currency - one_way_drop_off_charges_amount - one_way_drop_off_charges_currency - car_class_code - renter_name title: Card Refund Card Purchase Details CarRental type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CarRentals - type: 'null' customer_reference_identifier: anyOf: - description: An identifier from the merchant for the customer or consumer. type: string x-documentation-priority: default - type: 'null' local_tax_amount: anyOf: - description: The state or provincial tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' local_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' lodging: anyOf: - additionalProperties: false description: Fields specific to lodging. properties: check_in_date: anyOf: - description: Date the customer checked in. format: date type: string x-documentation-priority: default - type: 'null' daily_room_rate_amount: anyOf: - description: Daily rate being charged for the room. type: integer x-documentation-priority: default - type: 'null' daily_room_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate. type: string x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (phone, late check-out, etc.) being billed. enum: - no_extra_charge - restaurant - gift_shop - mini_bar - telephone - other - laundry type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Restaurant - Gift shop - Mini bar - Telephone - Other - Laundry - type: 'null' folio_cash_advances_amount: anyOf: - description: Folio cash advances for the room. type: integer x-documentation-priority: default - type: 'null' folio_cash_advances_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances. type: string x-documentation-priority: default - type: 'null' food_beverage_charges_amount: anyOf: - description: Food and beverage charges for the room. type: integer x-documentation-priority: default - type: 'null' food_beverage_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: Indicator that the cardholder is being billed for a reserved room that was not actually used. enum: - not_applicable - no_show type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show - type: 'null' prepaid_expenses_amount: anyOf: - description: Prepaid expenses being charged for the room. type: integer x-documentation-priority: default - type: 'null' prepaid_expenses_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses. type: string x-documentation-priority: default - type: 'null' room_nights: anyOf: - description: Number of nights the room was rented. type: integer x-documentation-priority: default - type: 'null' total_room_tax_amount: anyOf: - description: Total room tax being charged. type: integer x-documentation-priority: default - type: 'null' total_room_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax. type: string x-documentation-priority: default - type: 'null' total_tax_amount: anyOf: - description: Total tax being charged for the room. type: integer x-documentation-priority: default - type: 'null' total_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed. type: string x-documentation-priority: default - type: 'null' required: - no_show_indicator - extra_charges - check_in_date - daily_room_rate_amount - daily_room_rate_currency - total_tax_amount - total_tax_currency - prepaid_expenses_amount - prepaid_expenses_currency - food_beverage_charges_amount - food_beverage_charges_currency - folio_cash_advances_amount - folio_cash_advances_currency - room_nights - total_room_tax_amount - total_room_tax_currency title: Card Refund Card Purchase Details Lodging type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Lodgings - type: 'null' national_tax_amount: anyOf: - description: The national tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' national_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' purchase_identifier: anyOf: - description: An identifier from the merchant for the purchase to the issuer and cardholder. type: string x-documentation-priority: default - type: 'null' purchase_identifier_format: anyOf: - description: The format of the purchase identifier. enum: - free_text - order_number - rental_agreement_number - hotel_folio_number - invoice_number type: string x-documentation-priority: default x-enum-descriptions: - Free text - Order number - Rental agreement number - Hotel folio number - Invoice number - type: 'null' travel: anyOf: - additionalProperties: false description: Fields specific to travel. properties: ancillary: anyOf: - additionalProperties: false description: Ancillary purchases in addition to the airfare. properties: connected_ticket_document_number: anyOf: - description: If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - other type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Other - type: 'null' passenger_name_or_description: anyOf: - description: Name of the passenger or description of the ancillary purchase. type: string x-documentation-priority: default - type: 'null' services: description: Additional travel charges, such as baggage fees. items: additionalProperties: false properties: category: anyOf: - description: Category of the ancillary service. enum: - none - bundled_service - baggage_fee - change_fee - cargo - carbon_offset - frequent_flyer - gift_card - ground_transport - in_flight_entertainment - lounge - medical - meal_beverage - other - passenger_assist_fee - pets - seat_fees - standby - service_fee - store - travel_service - unaccompanied_travel - upgrades - wifi type: string x-documentation-priority: default x-enum-descriptions: - None - Bundled service - Baggage fee - Change fee - Cargo - Carbon offset - Frequent flyer - Gift card - Ground transport - In-flight entertainment - Lounge - Medical - Meal beverage - Other - Passenger assist fee - Pets - Seat fees - Standby - Service fee - Store - Travel service - Unaccompanied travel - Upgrades - Wi-fi - type: 'null' sub_category: anyOf: - description: Sub-category of the ancillary service, free-form. type: string x-documentation-priority: default - type: 'null' required: - category - sub_category title: Card Refund Card Purchase Details Travel Ancillary ServicesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ServicesElements type: array x-documentation-priority: default ticket_document_number: anyOf: - description: Ticket document number. type: string x-documentation-priority: default - type: 'null' required: - ticket_document_number - passenger_name_or_description - connected_ticket_document_number - credit_reason_indicator - services title: Card Refund Card Purchase Details Travel Ancillary type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ancillaries - type: 'null' computerized_reservation_system: anyOf: - description: Indicates the computerized reservation system used to book the ticket. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - airline_ticket_cancellation - other - partial_refund_of_airline_ticket type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Airline ticket cancellation - Other - Partial refund of airline ticket - type: 'null' departure_date: anyOf: - description: Date of departure. format: date type: string x-documentation-priority: default - type: 'null' origination_city_airport_code: anyOf: - description: Code for the originating city or airport. type: string x-documentation-priority: default - type: 'null' passenger_name: anyOf: - description: Name of the passenger. type: string x-documentation-priority: default - type: 'null' restricted_ticket_indicator: anyOf: - description: Indicates whether this ticket is non-refundable. enum: - no_restrictions - restricted_non_refundable_ticket type: string x-documentation-priority: default x-enum-descriptions: - No restrictions - Restricted non-refundable ticket - type: 'null' ticket_change_indicator: anyOf: - description: Indicates why a ticket was changed. enum: - none - change_to_existing_ticket - new_ticket type: string x-documentation-priority: default x-enum-descriptions: - None - Change to existing ticket - New ticket - type: 'null' ticket_number: anyOf: - description: Ticket number. type: string x-documentation-priority: default - type: 'null' travel_agency_code: anyOf: - description: Code for the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' travel_agency_name: anyOf: - description: Name of the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' trip_legs: anyOf: - description: Fields specific to each leg of the journey. items: additionalProperties: false properties: carrier_code: anyOf: - description: Carrier code (e.g., United Airlines, Jet Blue, etc.). type: string x-documentation-priority: default - type: 'null' destination_city_airport_code: anyOf: - description: Code for the destination city or airport. type: string x-documentation-priority: default - type: 'null' fare_basis_code: anyOf: - description: Fare basis code. type: string x-documentation-priority: default - type: 'null' flight_number: anyOf: - description: Flight number. type: string x-documentation-priority: default - type: 'null' service_class: anyOf: - description: Service class (e.g., first class, business class, etc.). type: string x-documentation-priority: default - type: 'null' stop_over_code: anyOf: - description: Indicates whether a stopover is allowed on this ticket. enum: - none - stop_over_allowed - stop_over_not_allowed type: string x-documentation-priority: default x-enum-descriptions: - None - Stop over allowed - Stop over not allowed - type: 'null' required: - flight_number - carrier_code - fare_basis_code - service_class - stop_over_code - destination_city_airport_code title: Card Refund Card Purchase Details Travel TripLegsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TripLegsElements type: array x-documentation-priority: default - type: 'null' required: - ticket_number - passenger_name - departure_date - origination_city_airport_code - travel_agency_code - travel_agency_name - restricted_ticket_indicator - computerized_reservation_system - credit_reason_indicator - ticket_change_indicator - trip_legs - ancillary title: Card Refund Card Purchase Details Travel type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Travels - type: 'null' required: - purchase_identifier - purchase_identifier_format - customer_reference_identifier - local_tax_amount - local_tax_currency - national_tax_amount - national_tax_currency - car_rental - lodging - travel title: Card Refund Card Purchase Details type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Purchase Details - type: 'null' scheme_fees: description: The scheme fees associated with this card refund. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Refund Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default transaction_id: description: The identifier of the Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions type: description: A constant representing the object's type. For this resource it will always be `card_refund`. enum: - card_refund type: string x-documentation-priority: default required: - type - id - card_payment_id - amount - currency - presentment_amount - presentment_currency - merchant_acceptor_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - merchant_name - merchant_category_code - interchange - cashback - purchase_details - scheme_fees - transaction_id - network_identifiers title: Card Refund type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Refunds card_balance_inquiry: additionalProperties: true description: Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM. example: additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null balance: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null id: card_balance_inquiry_pt06vq4e7qzvv01je0yt merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 physical_card_id: null real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_balance_inquiry verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Balance Inquiry AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Balance Inquiry AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s balance: description: The balance amount in the minor unit of the account's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' id: description: The Card Balance Inquiry identifier. type: string x-documentation-priority: default x-id-reference-to: Card Balance Inquiries merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Card Balance Inquiry NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Card Balance Inquiry NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Card Balance Inquiry NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Balance Inquiry NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card balance inquiry. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Balance Inquiry Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `card_balance_inquiry`. enum: - card_balance_inquiry type: string x-documentation-priority: default verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Card Balance Inquiry Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Card Balance Inquiry Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Card Balance Inquiry Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Card Balance Inquiry Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - type - id - card_payment_id - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - balance - currency - real_time_decision_id - scheme_fees title: Card Balance Inquiry type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Balance Inquiries card_settlement: additionalProperties: true description: Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it. example: amount: 100 card_authorization: null card_payment_id: card_payment_nd3k2kacrqjli8482ave cashback: null currency: USD id: card_settlement_khv5kfeu0vndj291omg6 interchange: amount: '0.137465' code: '271' currency: USD merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_name: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: acquirer_business_id: '69650702' acquirer_reference_number: '83163715445437604865089' authorization_identification_response: ABC123 transaction_id: '627199945183184' pending_transaction_id: null presentment_amount: 100 presentment_currency: USD purchase_details: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' surcharge: null transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_settlement properties: amount: description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_authorization: anyOf: - description: The Card Authorization that was created prior to this Card Settlement, if one exists. type: string x-documentation-priority: default - type: 'null' card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments cashback: anyOf: - additionalProperties: false description: Cashback earned on this transaction, if eligible. Cashback is paid out in aggregate, monthly. example: amount: '0.137465' currency: USD properties: amount: description: The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency title: Card Settlement Cashback type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cashbacks - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Settlement identifier. type: string x-documentation-priority: default x-id-reference-to: Card Settlements interchange: anyOf: - additionalProperties: false description: Interchange assessed as a part of this transaction. example: amount: '0.137465' code: '271' currency: USD properties: amount: description: The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default code: anyOf: - description: The card network specific interchange code. type: string x-documentation-priority: default - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency - code title: Card Settlement Card Interchange type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Interchanges - type: 'null' merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The 4-digit MCC describing the merchant's business. type: string x-documentation-priority: default merchant_city: description: The city the merchant resides in. type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_name: description: The name of the merchant. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is always a 5-digit ZIP code. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network: description: The card network on which this transaction was processed. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for this refund. properties: acquirer_business_id: description: A network assigned business ID that identifies the acquirer that processed this transaction. type: string x-documentation-priority: default acquirer_reference_number: description: A globally unique identifier for this settlement. type: string x-documentation-priority: default authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - acquirer_reference_number - acquirer_business_id - authorization_identification_response title: Card Settlement NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: NetworkIdentifiers pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' presentment_amount: description: The amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default purchase_details: anyOf: - additionalProperties: false description: Additional details about the card purchase, such as tax and industry-specific fields. example: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null properties: car_rental: anyOf: - additionalProperties: false description: Fields specific to car rentals. properties: car_class_code: anyOf: - description: Code indicating the vehicle's class. type: string x-documentation-priority: default - type: 'null' checkout_date: anyOf: - description: Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date. format: date type: string x-documentation-priority: default - type: 'null' daily_rental_rate_amount: anyOf: - description: Daily rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' daily_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate. type: string x-documentation-priority: default - type: 'null' days_rented: anyOf: - description: Number of days the vehicle was rented. type: integer x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (gas, late fee, etc.) being billed. enum: - no_extra_charge - gas - extra_mileage - late_return - one_way_service_fee - parking_violation type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Gas - Extra mileage - Late return - One way service fee - Parking violation - type: 'null' fuel_charges_amount: anyOf: - description: Fuel charges for the vehicle. type: integer x-documentation-priority: default - type: 'null' fuel_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed. type: string x-documentation-priority: default - type: 'null' insurance_charges_amount: anyOf: - description: Any insurance being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' insurance_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge). enum: - not_applicable - no_show_for_specialized_vehicle type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show for specialized vehicle - type: 'null' one_way_drop_off_charges_amount: anyOf: - description: Charges for returning the vehicle at a different location than where it was picked up. type: integer x-documentation-priority: default - type: 'null' one_way_drop_off_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed. type: string x-documentation-priority: default - type: 'null' renter_name: anyOf: - description: Name of the person renting the vehicle. type: string x-documentation-priority: default - type: 'null' weekly_rental_rate_amount: anyOf: - description: Weekly rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' weekly_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate. type: string x-documentation-priority: default - type: 'null' required: - extra_charges - days_rented - no_show_indicator - checkout_date - daily_rental_rate_amount - daily_rental_rate_currency - weekly_rental_rate_amount - weekly_rental_rate_currency - insurance_charges_amount - insurance_charges_currency - fuel_charges_amount - fuel_charges_currency - one_way_drop_off_charges_amount - one_way_drop_off_charges_currency - car_class_code - renter_name title: Card Settlement Card Purchase Details CarRental type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CarRentals - type: 'null' customer_reference_identifier: anyOf: - description: An identifier from the merchant for the customer or consumer. type: string x-documentation-priority: default - type: 'null' local_tax_amount: anyOf: - description: The state or provincial tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' local_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' lodging: anyOf: - additionalProperties: false description: Fields specific to lodging. properties: check_in_date: anyOf: - description: Date the customer checked in. format: date type: string x-documentation-priority: default - type: 'null' daily_room_rate_amount: anyOf: - description: Daily rate being charged for the room. type: integer x-documentation-priority: default - type: 'null' daily_room_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate. type: string x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (phone, late check-out, etc.) being billed. enum: - no_extra_charge - restaurant - gift_shop - mini_bar - telephone - other - laundry type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Restaurant - Gift shop - Mini bar - Telephone - Other - Laundry - type: 'null' folio_cash_advances_amount: anyOf: - description: Folio cash advances for the room. type: integer x-documentation-priority: default - type: 'null' folio_cash_advances_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances. type: string x-documentation-priority: default - type: 'null' food_beverage_charges_amount: anyOf: - description: Food and beverage charges for the room. type: integer x-documentation-priority: default - type: 'null' food_beverage_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: Indicator that the cardholder is being billed for a reserved room that was not actually used. enum: - not_applicable - no_show type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show - type: 'null' prepaid_expenses_amount: anyOf: - description: Prepaid expenses being charged for the room. type: integer x-documentation-priority: default - type: 'null' prepaid_expenses_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses. type: string x-documentation-priority: default - type: 'null' room_nights: anyOf: - description: Number of nights the room was rented. type: integer x-documentation-priority: default - type: 'null' total_room_tax_amount: anyOf: - description: Total room tax being charged. type: integer x-documentation-priority: default - type: 'null' total_room_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax. type: string x-documentation-priority: default - type: 'null' total_tax_amount: anyOf: - description: Total tax being charged for the room. type: integer x-documentation-priority: default - type: 'null' total_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed. type: string x-documentation-priority: default - type: 'null' required: - no_show_indicator - extra_charges - check_in_date - daily_room_rate_amount - daily_room_rate_currency - total_tax_amount - total_tax_currency - prepaid_expenses_amount - prepaid_expenses_currency - food_beverage_charges_amount - food_beverage_charges_currency - folio_cash_advances_amount - folio_cash_advances_currency - room_nights - total_room_tax_amount - total_room_tax_currency title: Card Settlement Card Purchase Details Lodging type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Lodgings - type: 'null' national_tax_amount: anyOf: - description: The national tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' national_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' purchase_identifier: anyOf: - description: An identifier from the merchant for the purchase to the issuer and cardholder. type: string x-documentation-priority: default - type: 'null' purchase_identifier_format: anyOf: - description: The format of the purchase identifier. enum: - free_text - order_number - rental_agreement_number - hotel_folio_number - invoice_number type: string x-documentation-priority: default x-enum-descriptions: - Free text - Order number - Rental agreement number - Hotel folio number - Invoice number - type: 'null' travel: anyOf: - additionalProperties: false description: Fields specific to travel. properties: ancillary: anyOf: - additionalProperties: false description: Ancillary purchases in addition to the airfare. properties: connected_ticket_document_number: anyOf: - description: If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - other type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Other - type: 'null' passenger_name_or_description: anyOf: - description: Name of the passenger or description of the ancillary purchase. type: string x-documentation-priority: default - type: 'null' services: description: Additional travel charges, such as baggage fees. items: additionalProperties: false properties: category: anyOf: - description: Category of the ancillary service. enum: - none - bundled_service - baggage_fee - change_fee - cargo - carbon_offset - frequent_flyer - gift_card - ground_transport - in_flight_entertainment - lounge - medical - meal_beverage - other - passenger_assist_fee - pets - seat_fees - standby - service_fee - store - travel_service - unaccompanied_travel - upgrades - wifi type: string x-documentation-priority: default x-enum-descriptions: - None - Bundled service - Baggage fee - Change fee - Cargo - Carbon offset - Frequent flyer - Gift card - Ground transport - In-flight entertainment - Lounge - Medical - Meal beverage - Other - Passenger assist fee - Pets - Seat fees - Standby - Service fee - Store - Travel service - Unaccompanied travel - Upgrades - Wi-fi - type: 'null' sub_category: anyOf: - description: Sub-category of the ancillary service, free-form. type: string x-documentation-priority: default - type: 'null' required: - category - sub_category title: Card Settlement Card Purchase Details Travel Ancillary ServicesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ServicesElements type: array x-documentation-priority: default ticket_document_number: anyOf: - description: Ticket document number. type: string x-documentation-priority: default - type: 'null' required: - ticket_document_number - passenger_name_or_description - connected_ticket_document_number - credit_reason_indicator - services title: Card Settlement Card Purchase Details Travel Ancillary type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ancillaries - type: 'null' computerized_reservation_system: anyOf: - description: Indicates the computerized reservation system used to book the ticket. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - airline_ticket_cancellation - other - partial_refund_of_airline_ticket type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Airline ticket cancellation - Other - Partial refund of airline ticket - type: 'null' departure_date: anyOf: - description: Date of departure. format: date type: string x-documentation-priority: default - type: 'null' origination_city_airport_code: anyOf: - description: Code for the originating city or airport. type: string x-documentation-priority: default - type: 'null' passenger_name: anyOf: - description: Name of the passenger. type: string x-documentation-priority: default - type: 'null' restricted_ticket_indicator: anyOf: - description: Indicates whether this ticket is non-refundable. enum: - no_restrictions - restricted_non_refundable_ticket type: string x-documentation-priority: default x-enum-descriptions: - No restrictions - Restricted non-refundable ticket - type: 'null' ticket_change_indicator: anyOf: - description: Indicates why a ticket was changed. enum: - none - change_to_existing_ticket - new_ticket type: string x-documentation-priority: default x-enum-descriptions: - None - Change to existing ticket - New ticket - type: 'null' ticket_number: anyOf: - description: Ticket number. type: string x-documentation-priority: default - type: 'null' travel_agency_code: anyOf: - description: Code for the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' travel_agency_name: anyOf: - description: Name of the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' trip_legs: anyOf: - description: Fields specific to each leg of the journey. items: additionalProperties: false properties: carrier_code: anyOf: - description: Carrier code (e.g., United Airlines, Jet Blue, etc.). type: string x-documentation-priority: default - type: 'null' destination_city_airport_code: anyOf: - description: Code for the destination city or airport. type: string x-documentation-priority: default - type: 'null' fare_basis_code: anyOf: - description: Fare basis code. type: string x-documentation-priority: default - type: 'null' flight_number: anyOf: - description: Flight number. type: string x-documentation-priority: default - type: 'null' service_class: anyOf: - description: Service class (e.g., first class, business class, etc.). type: string x-documentation-priority: default - type: 'null' stop_over_code: anyOf: - description: Indicates whether a stopover is allowed on this ticket. enum: - none - stop_over_allowed - stop_over_not_allowed type: string x-documentation-priority: default x-enum-descriptions: - None - Stop over allowed - Stop over not allowed - type: 'null' required: - flight_number - carrier_code - fare_basis_code - service_class - stop_over_code - destination_city_airport_code title: Card Settlement Card Purchase Details Travel TripLegsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TripLegsElements type: array x-documentation-priority: default - type: 'null' required: - ticket_number - passenger_name - departure_date - origination_city_airport_code - travel_agency_code - travel_agency_name - restricted_ticket_indicator - computerized_reservation_system - credit_reason_indicator - ticket_change_indicator - trip_legs - ancillary title: Card Settlement Card Purchase Details Travel type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Travels - type: 'null' required: - purchase_identifier - purchase_identifier_format - customer_reference_identifier - local_tax_amount - local_tax_currency - national_tax_amount - national_tax_currency - car_rental - lodging - travel title: Card Settlement Card Purchase Details type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Purchase Details - type: 'null' scheme_fees: description: The scheme fees associated with this card settlement. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Settlement Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default surcharge: anyOf: - additionalProperties: false description: Surcharge amount details, if applicable. The amount is positive if the surcharge is added to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount). properties: amount: description: The surcharge amount in the minor unit of the transaction's settlement currency. type: integer x-documentation-priority: default presentment_amount: description: The surcharge amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default required: - amount - presentment_amount title: Card Settlement Surcharge type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Surcharges - type: 'null' transaction_id: description: The identifier of the Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions type: description: A constant representing the object's type. For this resource it will always be `card_settlement`. enum: - card_settlement type: string x-documentation-priority: default required: - type - id - card_payment_id - card_authorization - amount - currency - presentment_amount - presentment_currency - merchant_acceptor_id - merchant_city - merchant_state - merchant_country - merchant_name - merchant_postal_code - merchant_category_code - transaction_id - pending_transaction_id - interchange - cashback - purchase_details - surcharge - scheme_fees - network - network_identifiers title: Card Settlement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Settlements card_authorization_expiration: additionalProperties: true description: Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer. example: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD expired_amount: 20 id: card_authorization_expiration_9xxbjtmixs8sfluzux2e network: visa type: card_authorization_expiration properties: card_authorization_id: description: The identifier for the Card Authorization this reverses. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) expired_amount: description: The amount of this authorization expiration in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default id: description: The Card Authorization Expiration identifier. type: string x-documentation-priority: default x-id-reference-to: Card Authorization Expirations network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse type: description: A constant representing the object's type. For this resource it will always be `card_authorization_expiration`. enum: - card_authorization_expiration type: string x-documentation-priority: default required: - type - id - expired_amount - currency - card_authorization_id - network title: Card Authorization Expiration type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Authorization Expirations inbound_card_validation: additionalProperties: true description: Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null id: card_validation_yi4e59jiaz6n9hx8tczv merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 physical_card_id: null real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: inbound_card_validation verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Inbound Card Validation AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' id: description: The Card Validation identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Card Validations merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Inbound Card Validation NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Inbound Card Validation NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Inbound Card Validation NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Inbound Card Validation NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card validation. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Inbound Card Validation Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `inbound_card_validation`. enum: - inbound_card_validation type: string x-documentation-priority: default verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Inbound Card Validation Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Inbound Card Validation Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Inbound Card Validation Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Inbound Card Validation Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - type - id - card_payment_id - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - currency - real_time_decision_id - actioner - scheme_fees title: Inbound Card Validation type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Card Validations card_financial: additionalProperties: true description: Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null direction: settlement id: card_financial_di5b98i72ppomo268zfk merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 physical_card_id: null presentment_amount: 100 presentment_currency: USD processing_category: purchase real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_financial verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this financial was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Financial AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' direction: description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. enum: - settlement - refund type: string x-documentation-priority: default x-enum-descriptions: - A regular card authorization where funds are debited from the cardholder. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. id: description: The Card Financial identifier. type: string x-documentation-priority: default x-id-reference-to: Card Financials merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Card Financial NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Card Financial NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Card Financial NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Financial NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' presentment_amount: description: The pending amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default processing_category: description: The processing category describes the intent behind the financial, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card financial. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Financial Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' transaction_id: description: The identifier of the Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions type: description: A constant representing the object's type. For this resource it will always be `card_financial`. enum: - card_financial type: string x-documentation-priority: default verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Card Financial Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Card Financial Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Card Financial Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Card Financial Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - type - id - card_payment_id - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - amount - presentment_amount - presentment_currency - currency - direction - actioner - processing_category - real_time_decision_id - transaction_id - scheme_fees title: Card Financial type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Financials card_payment_list: additionalProperties: true description: A list of Card Payment objects. example: data: - account_id: account_in71c4amph0vgo2qllky card_id: card_oubs0hwk5rn6knuecxg2 created_at: '2020-01-31T23:59:59Z' digital_wallet_token_id: null elements: - card_authorization: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null direction: settlement expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: null physical_card_id: null presentment_amount: 100 presentment_currency: USD processing_category: purchase real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_authorization verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null category: card_authorization created_at: '2020-01-31T23:59:59Z' - card_reversal: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_reversal_8vr9qy60cgf5d0slpb68 merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_currency: USD reversal_amount: 20 reversal_presentment_amount: 20 reversal_reason: reversed_by_customer scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_reversal updated_authorization_amount: 80 updated_authorization_presentment_amount: 80 category: card_reversal created_at: '2020-01-31T23:59:59Z' - card_increment: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: null total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 20 card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_increment_6ztayc58j1od0rpebp3e network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_amount: 20 presentment_currency: USD real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_increment updated_authorization_amount: 120 category: card_increment created_at: '2020-01-31T23:59:59Z' - card_settlement: amount: 100 card_authorization: null card_payment_id: card_payment_nd3k2kacrqjli8482ave cashback: null currency: USD id: card_settlement_khv5kfeu0vndj291omg6 interchange: amount: '0.137465' code: '271' currency: USD merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_name: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: acquirer_business_id: '69650702' acquirer_reference_number: '83163715445437604865089' authorization_identification_response: ABC123 transaction_id: '627199945183184' pending_transaction_id: null presentment_amount: 100 presentment_currency: USD purchase_details: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' surcharge: null transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_settlement category: card_settlement created_at: '2020-01-31T23:59:59Z' id: card_payment_nd3k2kacrqjli8482ave physical_card_id: null state: authorized_amount: 100 fuel_confirmed_amount: 0 incremented_amount: 20 refund_authorized_amount: 0 refunded_amount: 0 reversed_amount: 20 settled_amount: 100 type: card_payment next_cursor: v57w5d properties: data: description: The contents of the list. items: $ref: '#/components/schemas/card_payment' type: array x-documentation-priority: default next_cursor: anyOf: - description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`. type: string x-documentation-priority: default - type: 'null' required: - data - next_cursor title: Card Payment List type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Payment Lists card_authentication: additionalProperties: true description: Card Authentications are attempts to authenticate a transaction or a card with 3DS. example: access_control_server_transaction_identifier: 1a628378-4d43-4438-a31f-25c0e1bf2537 billing_address_city: New York billing_address_country: US billing_address_line1: 33 Liberty Street billing_address_line2: null billing_address_line3: null billing_address_postal_code: '10045' billing_address_state: NY card_id: card_oubs0hwk5rn6knuecxg2 card_payment_id: card_payment_nd3k2kacrqjli8482ave cardholder_email: user@example.com cardholder_name: Ian Crease challenge: attempts: - created_at: '2020-01-31T23:59:59Z' outcome: successful created_at: '2020-01-31T23:59:59Z' one_time_code: '123456' real_time_decision_id: real_time_decision_j76n2e810ezcg3zh5qtn verification_method: text_message verification_value: '+16505046304' created_at: '2020-01-31T23:59:59Z' deny_reason: null device_channel: browser: accept_header: text/html ip_address: 203.0.113.0 javascript_enabled: enabled language: en-US user_agent: Mozilla/5.0 category: browser merchant_initiated: null directory_server_transaction_identifier: 8990a978-5eb2-4440-8539-5619e24b0b0d id: card_authentication_xft30xjdubptlgrxboch merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_country: US merchant_name: AMAZON.COM message_category: category: payment_authentication non_payment: null payment: purchase_amount: 861 purchase_amount_cardholder_estimated: 1000 purchase_currency: EUR transaction_type: goods_service_purchase prior_authenticated_card_payment_id: null real_time_decision_id: null requestor_authentication_indicator: payment_transaction requestor_challenge_indicator: no_preference requestor_name: Example Requestor requestor_url: https://example.com shipping_address_city: New York shipping_address_country: US shipping_address_line1: 33 Liberty Street shipping_address_line2: null shipping_address_line3: null shipping_address_postal_code: '10045' shipping_address_state: NY status: validating_challenge three_d_secure_server_transaction_identifier: 6839e1b0-dcae-482d-8166-40e44dd0d8cd type: card_authentication properties: access_control_server_transaction_identifier: description: A unique identifier assigned by the Access Control Server (us) for this transaction. type: string x-documentation-priority: default billing_address_city: anyOf: - description: The city of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_country: anyOf: - description: The country of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_line1: anyOf: - description: The first line of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_line2: anyOf: - description: The second line of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_line3: anyOf: - description: The third line of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_postal_code: anyOf: - description: The postal code of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_state: anyOf: - description: The US state of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' card_id: description: The identifier of the Card. type: string x-documentation-priority: default x-id-reference-to: Cards card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments cardholder_email: anyOf: - description: The email address of the cardholder. type: string x-documentation-priority: default - type: 'null' cardholder_name: anyOf: - description: The name of the cardholder. type: string x-documentation-priority: default - type: 'null' challenge: anyOf: - additionalProperties: false description: Details about the challenge, if one was requested. properties: attempts: description: Details about the challenge verification attempts, if any happened. items: additionalProperties: false properties: created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card Authentication Challenge Attempt. format: date-time type: string x-documentation-priority: default outcome: description: The outcome of the Card Authentication Challenge Attempt. enum: - successful - failed type: string x-documentation-priority: default x-enum-descriptions: - The attempt was successful. - The attempt was unsuccessful. required: - created_at - outcome title: Card Authentication Challenge AttemptsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: AttemptsElements type: array x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication Challenge was started. format: date-time type: string x-documentation-priority: default one_time_code: description: The one-time code used for the Card Authentication Challenge. type: string x-documentation-priority: default real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision used to deliver this challenge. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' verification_method: description: The method used to verify the Card Authentication Challenge. enum: - text_message - email - none_available type: string x-documentation-priority: default x-enum-descriptions: - The one-time code was sent via text message. - The one-time code was sent via email. - The one-time code was not successfully delivered. verification_value: anyOf: - description: E.g., the email address or phone number used for the Card Authentication Challenge. type: string x-documentation-priority: default - type: 'null' required: - created_at - one_time_code - verification_method - verification_value - real_time_decision_id - attempts title: Card Authentication Challenge type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Challenges - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication was attempted. format: date-time type: string x-documentation-priority: default deny_reason: anyOf: - description: The reason why this authentication attempt was denied, if it was. enum: - group_locked - card_not_active - entity_not_active - transaction_not_allowed - webhook_denied - webhook_timed_out type: string x-documentation-priority: default x-enum-descriptions: - The group was locked. - The card was not active. - The entity was not active. - The transaction was not allowed. - The webhook was denied. - The webhook timed out. - type: 'null' device_channel: additionalProperties: false description: The device channel of the card authentication attempt. properties: browser: anyOf: - additionalProperties: false description: Fields specific to the browser device channel. properties: accept_header: anyOf: - description: The accept header from the cardholder's browser. type: string x-documentation-priority: default - type: 'null' ip_address: anyOf: - description: The IP address of the cardholder's browser. type: string x-documentation-priority: default - type: 'null' javascript_enabled: anyOf: - description: Whether JavaScript is enabled in the cardholder's browser. enum: - enabled - disabled type: string x-documentation-priority: default x-enum-descriptions: - JavaScript is enabled in the cardholder's browser. - JavaScript is not enabled in the cardholder's browser. - type: 'null' language: anyOf: - description: The language of the cardholder's browser. type: string x-documentation-priority: default - type: 'null' user_agent: anyOf: - description: The user agent of the cardholder's browser. type: string x-documentation-priority: default - type: 'null' required: - accept_header - ip_address - javascript_enabled - language - user_agent title: Card Authentication DeviceChannel Browser type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Browsers - type: 'null' category: description: The category of the device channel. enum: - app - browser - three_ds_requestor_initiated type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt was made from an app. - The authentication attempt was made from a browser. - The authentication attempt was initiated by the 3DS Requestor. merchant_initiated: anyOf: - additionalProperties: false description: Fields specific to merchant initiated transactions. properties: indicator: description: The merchant initiated indicator for the transaction. enum: - recurring_transaction - installment_transaction - add_card - maintain_card_information - account_verification - split_delayed_shipment - top_up - mail_order - telephone_order - whitelist_status_check - other_payment - billing_agreement - device_binding_status_check - card_security_code_status_check - delayed_shipment - split_payment - fido_credential_deletion - fido_credential_registration - decoupled_authentication_fallback type: string x-documentation-priority: default x-enum-descriptions: - Recurring transaction. - Installment transaction. - Add card. - Maintain card information. - Account verification. - Split or delayed shipment. - Top up. - Mail order. - Telephone order. - Whitelist status check. - Other payment. - Billing agreement. - Device binding status check. - Card security code status check. - Delayed shipment. - Split payment. - FIDO credential deletion. - FIDO credential registration. - Decoupled authentication fallback. required: - indicator title: Card Authentication DeviceChannel MerchantInitiated type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: MerchantInitiateds - type: 'null' required: - category - merchant_initiated - browser title: Card Authentication DeviceChannel type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s directory_server_transaction_identifier: description: A unique identifier assigned by the Directory Server (the card network) for this transaction. type: string x-documentation-priority: default id: description: The Card Authentication identifier. type: string x-documentation-priority: default x-id-reference-to: Card Authentications merchant_acceptor_id: anyOf: - description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default - type: 'null' merchant_category_code: anyOf: - description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default - type: 'null' merchant_country: anyOf: - description: The country the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_name: anyOf: - description: The name of the merchant. type: string x-documentation-priority: default - type: 'null' message_category: additionalProperties: false description: The message category of the card authentication attempt. properties: category: description: The category of the card authentication attempt. enum: - payment_authentication - non_payment_authentication type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt is for a payment. - The authentication attempt is not for a payment. non_payment: anyOf: - additionalProperties: false description: Fields specific to non-payment authentication attempts. properties: {} title: Card Authentication MessageCategory NonPayment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: NonPayments - type: 'null' payment: anyOf: - additionalProperties: false description: Fields specific to payment authentication attempts. properties: purchase_amount: description: The purchase amount in minor units. type: integer x-documentation-priority: default purchase_amount_cardholder_estimated: anyOf: - description: The purchase amount in the cardholder's currency (i.e., USD) estimated using daily conversion rates from the card network. type: integer x-documentation-priority: default - type: 'null' purchase_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt's purchase currency. type: string x-documentation-priority: default transaction_type: anyOf: - description: The type of transaction being authenticated. enum: - goods_service_purchase - check_acceptance - account_funding - quasi_cash_transaction - prepaid_activation_and_load type: string x-documentation-priority: default x-enum-descriptions: - Purchase of goods or services. - Check acceptance. - Account funding. - Quasi-cash transaction. - Prepaid activation and load. - type: 'null' required: - purchase_amount - purchase_currency - purchase_amount_cardholder_estimated - transaction_type title: Card Authentication MessageCategory Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Payments - type: 'null' required: - category - payment - non_payment title: Card Authentication MessageCategory type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s prior_authenticated_card_payment_id: anyOf: - description: The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction. type: string x-documentation-priority: default x-id-reference-to: Card Authentications - type: 'null' real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this authentication attempt. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' requestor_authentication_indicator: anyOf: - description: The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction. enum: - payment_transaction - recurring_transaction - installment_transaction - add_card - maintain_card - emv_token_cardholder_verification - billing_agreement type: string x-documentation-priority: default x-enum-descriptions: - The authentication is for a payment transaction. - The authentication is for a recurring transaction. - The authentication is for an installment transaction. - The authentication is for adding a card. - The authentication is for maintaining a card. - The authentication is for EMV token cardholder verification. - The authentication is for a billing agreement. - type: 'null' requestor_challenge_indicator: anyOf: - description: Indicates whether a challenge is requested for this transaction. enum: - no_preference - no_challenge_requested - challenge_requested_3ds_requestor_preference - challenge_requested_mandate - no_challenge_requested_transactional_risk_analysis_already_performed - no_challenge_requested_data_share_only - no_challenge_requested_strong_consumer_authentication_already_performed - no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required - challenge_requested_whitelist_prompt_requested_if_challenge_required type: string x-documentation-priority: default x-enum-descriptions: - No preference. - No challenge requested. - Challenge requested, 3DS Requestor preference. - Challenge requested, mandate. - No challenge requested, transactional risk analysis already performed. - No challenge requested, data share only. - No challenge requested, strong consumer authentication already performed. - No challenge requested, utilize whitelist exemption if no challenge required. - Challenge requested, whitelist prompt requested if challenge required. - type: 'null' requestor_name: description: The name of the 3DS requestor. type: string x-documentation-priority: default requestor_url: description: The URL of the 3DS requestor. type: string x-documentation-priority: default shipping_address_city: anyOf: - description: The city of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_country: anyOf: - description: The country of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_line1: anyOf: - description: The first line of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_line2: anyOf: - description: The second line of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_line3: anyOf: - description: The third line of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_postal_code: anyOf: - description: The postal code of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_state: anyOf: - description: The US state of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' status: description: The status of the card authentication. enum: - denied - authenticated_with_challenge - authenticated_without_challenge - awaiting_challenge - validating_challenge - canceled - timed_out_awaiting_challenge - errored - exceeded_attempt_threshold type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt was denied. - The authentication attempt was authenticated with a challenge. - The authentication attempt was authenticated without a challenge. - The authentication attempt is awaiting a challenge. - The authentication attempt is validating a challenge. - The authentication attempt was canceled. - The authentication attempt timed out while awaiting a challenge. - The authentication attempt errored. - The authentication attempt exceeded the attempt threshold. three_d_secure_server_transaction_identifier: description: A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction. type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `card_authentication`. enum: - card_authentication type: string x-documentation-priority: default required: - type - id - created_at - card_payment_id - card_id - prior_authenticated_card_payment_id - message_category - access_control_server_transaction_identifier - three_d_secure_server_transaction_identifier - directory_server_transaction_identifier - device_channel - cardholder_name - cardholder_email - requestor_authentication_indicator - requestor_challenge_indicator - requestor_name - requestor_url - merchant_category_code - merchant_acceptor_id - merchant_name - merchant_country - billing_address_line1 - billing_address_line2 - billing_address_line3 - billing_address_city - billing_address_state - billing_address_postal_code - billing_address_country - shipping_address_line1 - shipping_address_line2 - shipping_address_line3 - shipping_address_city - shipping_address_state - shipping_address_postal_code - shipping_address_country - status - deny_reason - real_time_decision_id - challenge title: Card Authentication type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Authentications card_payment: additionalProperties: false description: Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement. example: account_id: account_in71c4amph0vgo2qllky card_id: card_oubs0hwk5rn6knuecxg2 created_at: '2020-01-31T23:59:59Z' digital_wallet_token_id: null elements: - card_authorization: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null direction: settlement expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: null physical_card_id: null presentment_amount: 100 presentment_currency: USD processing_category: purchase real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_authorization verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null category: card_authorization created_at: '2020-01-31T23:59:59Z' - card_reversal: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_reversal_8vr9qy60cgf5d0slpb68 merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_currency: USD reversal_amount: 20 reversal_presentment_amount: 20 reversal_reason: reversed_by_customer scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_reversal updated_authorization_amount: 80 updated_authorization_presentment_amount: 80 category: card_reversal created_at: '2020-01-31T23:59:59Z' - card_increment: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: null total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 20 card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_increment_6ztayc58j1od0rpebp3e network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_amount: 20 presentment_currency: USD real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_increment updated_authorization_amount: 120 category: card_increment created_at: '2020-01-31T23:59:59Z' - card_settlement: amount: 100 card_authorization: null card_payment_id: card_payment_nd3k2kacrqjli8482ave cashback: null currency: USD id: card_settlement_khv5kfeu0vndj291omg6 interchange: amount: '0.137465' code: '271' currency: USD merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_name: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: acquirer_business_id: '69650702' acquirer_reference_number: '83163715445437604865089' authorization_identification_response: ABC123 transaction_id: '627199945183184' pending_transaction_id: null presentment_amount: 100 presentment_currency: USD purchase_details: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' surcharge: null transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_settlement category: card_settlement created_at: '2020-01-31T23:59:59Z' id: card_payment_nd3k2kacrqjli8482ave physical_card_id: null state: authorized_amount: 100 fuel_confirmed_amount: 0 incremented_amount: 20 refund_authorized_amount: 0 refunded_amount: 0 reversed_amount: 20 settled_amount: 100 type: card_payment properties: account_id: description: The identifier for the Account the Transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Accounts card_id: description: The Card identifier for this payment. type: string x-documentation-priority: default x-id-reference-to: Cards created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Payment was created. format: date-time type: string x-documentation-priority: default digital_wallet_token_id: anyOf: - description: The Digital Wallet Token identifier for this payment. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' elements: description: The interactions related to this card payment. items: additionalProperties: false example: card_authorization: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null direction: settlement expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: null physical_card_id: null presentment_amount: 100 presentment_currency: USD processing_category: purchase real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_authorization verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null category: card_authorization created_at: '2020-01-31T23:59:59Z' properties: card_authentication: anyOf: - $ref: '#/components/schemas/card_authentication' description: A Card Authentication object. This field will be present in the JSON response if and only if `category` is equal to `card_authentication`. Card Authentications are attempts to authenticate a transaction or a card with 3DS. x-documentation-priority: default - type: 'null' card_authorization: anyOf: - $ref: '#/components/schemas/card_authorization' description: A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`. Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction. x-documentation-priority: default - type: 'null' card_authorization_expiration: anyOf: - $ref: '#/components/schemas/card_authorization_expiration' description: A Card Authorization Expiration object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization_expiration`. Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer. x-documentation-priority: default - type: 'null' card_balance_inquiry: anyOf: - $ref: '#/components/schemas/card_balance_inquiry' description: A Card Balance Inquiry object. This field will be present in the JSON response if and only if `category` is equal to `card_balance_inquiry`. Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM. x-documentation-priority: default - type: 'null' card_decline: anyOf: - additionalProperties: true description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: -1000 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8 digital_wallet_token_id: null direction: settlement id: card_decline_bx3o8zd7glq8yvtwg25v incremented_card_authorization_id: null merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: null network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 physical_card_id: null presentment_amount: -1000 presentment_currency: USD processing_category: purchase real_time_decision_id: null real_time_decision_reason: null reason: insufficient_funds scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Payment Card Payment Element Card Decline AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the declined transaction created for this Card Decline. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' direction: description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. enum: - settlement - refund type: string x-documentation-priority: default x-enum-descriptions: - A regular card authorization where funds are debited from the cardholder. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. id: description: The Card Decline identifier. type: string x-documentation-priority: default x-id-reference-to: Card Declines incremented_card_authorization_id: anyOf: - description: The identifier of the card authorization this request attempted to incrementally authorize. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations - type: 'null' merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Card Payment Card Payment Element Card Decline NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Card Payment Card Payment Element Card Decline NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Card Payment Card Payment Element Card Decline NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Payment Card Payment Element Card Decline NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' presentment_amount: description: The declined amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default processing_category: description: The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' real_time_decision_reason: anyOf: - description: This is present if a specific decline reason was given in the real-time decision. enum: - insufficient_funds - transaction_never_allowed - exceeds_approval_limit - card_temporarily_disabled - suspected_fraud - other type: string x-documentation-priority: default x-enum-descriptions: - The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. - This type of transaction is not allowed for this card. This transaction should not be retried. - The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again. - The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again. - The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again. - The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. - type: 'null' reason: description: Why the transaction was declined. enum: - account_closed - card_not_active - card_canceled - physical_card_not_active - entity_not_active - group_locked - insufficient_funds - cvv2_mismatch - pin_mismatch - card_expiration_mismatch - transaction_not_allowed - breaches_limit - webhook_declined - webhook_timed_out - declined_by_stand_in_processing - invalid_physical_card - missing_original_authorization - invalid_cryptogram - failed_3ds_authentication - suspected_card_testing - suspected_fraud type: string x-documentation-priority: default x-enum-descriptions: - The account has been closed. - The Card was not active. - The Card has been canceled. - The Physical Card was not active. - The account's entity was not active. - The account was inactive. - The Card's Account did not have a sufficient available balance. - The given CVV2 did not match the card's value. - The given PIN did not match the card's value. - The given expiration date did not match the card's value. Only applies when a CVV2 is present. - The attempted card transaction is not allowed per Increase's terms. - The transaction was blocked by a Limit. - Your application declined the transaction via webhook. - Your application webhook did not respond without the required timeout. - Declined by stand-in processing. - The card read had an invalid CVV or dCVV. - The original card authorization for this incremental authorization does not exist. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The transaction was declined because the 3DS authentication failed. - The transaction was suspected to be used by a card tester to test for valid card numbers. - The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. scheme_fees: description: The scheme fees associated with this card decline. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Payment Card Payment Element Card Decline Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Card Payment Card Payment Element Card Decline Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Card Payment Card Payment Element Card Decline Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Card Payment Card Payment Element Card Decline Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Card Payment Card Payment Element Card Decline Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - id - card_payment_id - amount - presentment_amount - presentment_currency - currency - processing_category - reason - real_time_decision_reason - incremented_card_authorization_id - actioner - direction - real_time_decision_id - scheme_fees - declined_transaction_id title: Card Payment Card Payment Element Card Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Declines - type: 'null' card_financial: anyOf: - $ref: '#/components/schemas/card_financial' description: A Card Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_financial`. Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction. x-documentation-priority: default - type: 'null' card_fuel_confirmation: anyOf: - $ref: '#/components/schemas/card_fuel_confirmation' description: A Card Fuel Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. x-documentation-priority: default - type: 'null' card_increment: anyOf: - $ref: '#/components/schemas/card_increment' description: A Card Increment object. This field will be present in the JSON response if and only if `category` is equal to `card_increment`. Card Increments increase the pending amount of an authorized transaction. x-documentation-priority: default - type: 'null' card_refund: anyOf: - $ref: '#/components/schemas/card_refund' description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`. Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction. x-documentation-priority: default - type: 'null' card_reversal: anyOf: - $ref: '#/components/schemas/card_reversal' description: A Card Reversal object. This field will be present in the JSON response if and only if `category` is equal to `card_reversal`. Card Reversals cancel parts of or the entirety of an existing Card Authorization. x-documentation-priority: default - type: 'null' card_settlement: anyOf: - $ref: '#/components/schemas/card_settlement' description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`. Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it. x-documentation-priority: default - type: 'null' card_validation: anyOf: - $ref: '#/components/schemas/inbound_card_validation' description: An Inbound Card Validation object. This field will be present in the JSON response if and only if `category` is equal to `card_validation`. Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid. x-documentation-priority: default - type: 'null' category: description: The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - card_authorization - card_authentication - card_balance_inquiry - card_validation - card_decline - card_reversal - card_authorization_expiration - card_increment - card_settlement - card_refund - card_fuel_confirmation - card_financial - other type: string x-documentation-priority: default x-enum-descriptions: - 'Card Authorization: details will be under the `card_authorization` object.' - 'Card Authentication: details will be under the `card_authentication` object.' - 'Card Balance Inquiry: details will be under the `card_balance_inquiry` object.' - 'Inbound Card Validation: details will be under the `card_validation` object.' - 'Card Decline: details will be under the `card_decline` object.' - 'Card Reversal: details will be under the `card_reversal` object.' - 'Card Authorization Expiration: details will be under the `card_authorization_expiration` object.' - 'Card Increment: details will be under the `card_increment` object.' - 'Card Settlement: details will be under the `card_settlement` object.' - 'Card Refund: details will be under the `card_refund` object.' - 'Card Fuel Confirmation: details will be under the `card_fuel_confirmation` object.' - 'Card Financial: details will be under the `card_financial` object.' - Unknown card payment element. created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card payment element was created. format: date-time type: string x-documentation-priority: default other: anyOf: - additionalProperties: false description: If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null. properties: {} title: Card Payment Card Payment Element Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' required: - category - created_at title: Card Payment Card Payment Element type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Payment Elements type: array x-documentation-priority: default id: description: The Card Payment identifier. type: string x-documentation-priority: default x-id-reference-to: Card Payments physical_card_id: anyOf: - description: The Physical Card identifier for this payment. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' state: additionalProperties: false description: The summarized state of this card payment. example: authorized_amount: 100 fuel_confirmed_amount: 0 incremented_amount: 20 refund_authorized_amount: 0 refunded_amount: 0 reversed_amount: 20 settled_amount: 100 properties: authorized_amount: description: The total authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default fuel_confirmed_amount: description: The total amount from fuel confirmations in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default incremented_amount: description: The total incrementally updated authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default refund_authorized_amount: description: The total refund authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default refunded_amount: description: The total refunded amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default reversed_amount: description: The total reversed amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default settled_amount: description: The total settled amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - authorized_amount - refund_authorized_amount - incremented_amount - reversed_amount - fuel_confirmed_amount - settled_amount - refunded_amount title: Card Payment Card Payment State type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Payment States type: description: A constant representing the object's type. For this resource it will always be `card_payment`. enum: - card_payment type: string x-documentation-priority: default required: - type - id - created_at - account_id - card_id - physical_card_id - digital_wallet_token_id - elements - state title: Card Payment type: object x-event-categories: - card_payment.created - card_payment.updated x-stainless-empty-object: false x-tag: Card Payments x-title-plural: Card Payments card_reversal: additionalProperties: true description: Card Reversals cancel parts of or the entirety of an existing Card Authorization. example: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_reversal_8vr9qy60cgf5d0slpb68 merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_currency: USD reversal_amount: 20 reversal_presentment_amount: 20 reversal_reason: reversed_by_customer scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS type: card_reversal updated_authorization_amount: 80 updated_authorization_presentment_amount: 80 properties: card_authorization_id: description: The identifier for the Card Authorization this reverses. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Reversal identifier. type: string x-documentation-priority: default x-id-reference-to: Card Reversals merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: anyOf: - description: The country the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Reversal NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Card Reversal. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's presentment currency. type: string x-documentation-priority: default reversal_amount: description: The amount of this reversal in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default reversal_presentment_amount: description: The amount of this reversal in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default reversal_reason: anyOf: - description: Why this reversal was initiated. enum: - reversed_by_customer - reversed_by_network_or_acquirer - reversed_by_point_of_sale - partial_reversal type: string x-documentation-priority: default x-enum-descriptions: - The Card Reversal was initiated at the customer's request. - The Card Reversal was initiated by the network or acquirer. - The Card Reversal was initiated by the point of sale device. - The Card Reversal was a partial reversal, for any reason. - type: 'null' scheme_fees: description: The scheme fees associated with this card reversal. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Reversal Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `card_reversal`. enum: - card_reversal type: string x-documentation-priority: default updated_authorization_amount: description: The amount left pending on the Card Authorization in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default updated_authorization_presentment_amount: description: The amount left pending on the Card Authorization in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - type - id - reversal_amount - reversal_presentment_amount - updated_authorization_amount - updated_authorization_presentment_amount - currency - presentment_currency - card_authorization_id - network - pending_transaction_id - network_identifiers - reversal_reason - merchant_acceptor_id - merchant_descriptor - merchant_category_code - merchant_city - merchant_state - merchant_postal_code - merchant_country - terminal_id - scheme_fees title: Card Reversal type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Reversals responses: errorResponse: content: application/json: schema: allOf: - $ref: '#/components/schemas/error' description: Error securitySchemes: bearerAuth: scheme: bearer type: http x-tagGroups: - name: Accounts tags: - Accounts - Account Numbers - Account Transfers - name: Transactions tags: - Transactions - Pending Transactions - Declined Transactions - name: Ach Transfers tags: - ACH Transfers - Inbound ACH Transfers - ACH Prenotifications - name: Check Transfers tags: - Check Transfers - Inbound Check Deposits - name: Real Time Payments Transfers tags: - Real-Time Payments Transfers - Inbound Real-Time Payments Transfers - name: Fednow Transfers tags: - FedNow Transfers - Inbound FedNow Transfers - name: Swift Transfers tags: - Swift Transfers - name: Wire Transfers tags: - Wire Transfers - Inbound Wire Transfers - Wire Drawdown Requests - Inbound Wire Drawdown Requests - name: Card Transfers tags: - Card Tokens - Card Push Transfers - Card Validations - name: Check Deposits tags: - Check Deposits - Lockbox Addresses - Lockbox Recipients - Inbound Mail Items - name: Cards tags: - Cards - Card Payments - Card Purchase Supplements - Card Disputes - Physical Cards - Digital Card Profiles - Physical Card Profiles - Digital Wallet Tokens - name: Compliance tags: - Entities - Beneficial Owners - Supplemental Documents - Entity Onboarding Sessions - Programs - name: Events and Webhooks tags: - Events - Event Subscriptions - Real-Time Decisions - name: External Accounts tags: - Routing Numbers - External Accounts - name: Files and Exports tags: - Account Statements - Files - File Links - Exports - name: OAuth tags: - Groups - OAuth Applications - OAuth Connections - OAuth Tokens - name: Intrafi tags: - IntraFi Account Enrollments - IntraFi Balances - IntraFi Exclusions