--- title: "Get Charge" method: GET path: "/charges/{chargeKey}" tags: ["Retrieve Charges"] --- # Get Charge `GET /charges/{chargeKey}` ## Request - Base URL: `https://eu-west-1.api.silverflow.com/v1` - URL: `https://eu-west-1.api.silverflow.com/v1/charges/{chargeKey}` - Auth: one of: - HTTP basic - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the charge identified by the charge key. Requires `charges:Get` permission. ## Path parameters - `chargeKey` string, required: Uniquely identifies a charge. ## Response `200` The charge - union - GenericCharge: A charge - `key` string, required: Uniquely identifies a charge. - `refundedChargeKey` string: The charge key of the refunded charge. **This field is only available for charges created on the [Refund endpoint](#operation/refund) with `createRefundCharge` set to `true`.** - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `tokenDetails` union: Further details about the token that was used. Required if `type.cardEntry` is `token` or `token-on-file`. - StoredTokenDetailsNetwork - `type` 'network', required: Details about a token from one of the card networks - `eci` string: Zero-padded e-commerce indicator. - StoredChargeTokenDetailsDigitalWallet - `type` 'apple-pay' | 'google-pay' | 'paze', required: Details about a digital wallet token. `paze` is only supported for VISAMASTERCARD and is EXPERIMENTAL. - `eci` string: Zero-padded e-commerce indicator. - `amount` ComponentsSchemasAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `cardholderBillingAmount` CardholderBillingAmount: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `conversionRate` object, required - `cardholderBillingConversionRate` number, required - `decimalIndicator` number, required - `type` GetResponseChargeType, required: Describes the kind of charge the merchant wants to submit. - `intent` 'purchase' | 'reservation' | 'account-status' | 'refund', required: The intention of the cardholder. - `cardEntry` 'e-commerce' | 'manual' | 'card-on-file' | 'terminal' | 'token' | 'token-on-file', required: The method used to capture the card details. - `order` 'checkout' | 'unspecified' | 'mail' | 'phone' | 'one-click' | 'recurring' | 'ucof' | 'installment' | 'standing-order' | 'counter', required: The method used to place the order. - `sequence` union - 'initial': Setting this to `initial` flags the charge as the initial charge in a sequence of payments. - 'subsequent': For older charges created on the [`POST /charges`](#operation/createCharge) endpoint, this field can have a value of `subsequent`. - `clearingMode` 'auto' | 'manual': The clearing method for the charge. - `auto`: The charge is cleared automatically as soon as possible. To delay clearing, provide a `clearAfter` timestamp. - `manual`: The charge must be manually cleared later. - `status` ChargeStatus, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'none' | 'authenticated' | 'non-authenticated', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'none' | 'approved' | 'declined' | 'reversed' | 'approved-partial', required: Authorization status of the charge - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `authentication` ChargeAuthentication, required: Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used. - `sca` union, required - ThreeDsAuthentication: Object container for strong customer authentication. - `method` '3ds1' | '3ds2' | 'device', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated' | 'mit' | 'exemption', required - `complianceReason` 'mandated' | 'none' | 'ucof' | 'recurring' | 'installment' | 'incremental' | 'delayed-charges' | 'no-show' | 'reauthorization' | 'resubmission' | 'whitelist' | 'auto' | 'mit' | 'tra' | 'low-value' | 'delegation' | 'scp', required: Indicates the reason for the SCA compliance. - `result` ThreeDsAuthenticationResultResponse, required: Object containing the information of a 3DS transaction. - `version` '2.2.0': The 3DS protocol version which has been used to perform 3DS. This information is only available when it has been provided in the request. - `directoryServerTransId` string: Transaction ID retrieved from the Directory Server - ScaBEP: Object container for strong customer authentication. - `method` 'bep', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated', required: Indicates SCA compliance of the charges - `complianceReason` 'mandated', required: Indicates the reason for the SCA compliance. - `result` BEPAuthenticationResult, required: Object containing the information of a BEP transaction. - `trm` '50' | '51', required: The method of initiating the BEP authentication. Stands for Transaction Routing Means. - AuthenticationOutOfScope - `method` 'none', required - `compliance` 'out-of-scope', required - `complianceReason` 'none' | 'moto' | 'one-leg' | 'anonymous-prepaid' | 'recurring', required - AuthenticationExempt - `method` 'none', required - `compliance` 'exemption', required - `complianceReason` 'whitelist' | 'auto' | 'mit' | 'tra' | 'recurring' | 'low-value' | 'delegation' | 'scp' | 'wip', required - ScaMit - `method` 'none', required - `compliance` 'mit', required - `complianceReason` 'installment' | 'ucof', required - `cvc` 'none' | 'match' | 'no-match' | 'not-processed', required: The result of cvc verification - `avs` 'none' | 'match' | 'partial-match' | 'no-match' | 'not-processed', required: The result of the AVS verification - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `transactionType` 'cryptocurrency' | 'high-risk-securities' | 'central-bank-digital-currency' | 'stablecoin' | 'blockchain-native-coin' | 'non-fungible-token': In case of a special transaction type, this allows you to specify which one. `type.intent` needs to be `purchase`. - `cryptocurrency`: A transaction involving the purchasing of cryptocurrencies. Use this for Visa only if specific type of digital asset cannot be determined. - `high-risk-securities`: A transaction involving the purchasing of high-risk securities. Only supported for Mastercard. - `central-bank-digital-currency`: A transaction involving purchase of a Central Bank Digital Currency (CBDC). Only supported for Visa. - `stablecoin`: A transaction involving purchase of stablecoins. - `blockchain-native-coin`: A transaction involving purchase of a non fiat backed blockchain coin. Only supported for Visa. - `non-fungible-token`: A transaction involving purchase of a Non Fungible Token (NFT). Only supported for Visa. Not supported for Diners. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `fraudLiability` 'acquirer' | 'issuer', required: Which party is liable in case of fraud. - `authorizationIsoFields` union, required: Object containing the raw values from the ISO8583 response message received from the network. - AuthorizationIsoFieldsAmericanExpress - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required: Not applicable for American Express transactions. - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` AmexSpecificFields, required: American Express-specific ISO8583 raw values - `acquirerReferenceData` string, required: Contents of field 31. - `cvcResult` string: Contents of field 44, first byte. - `avsResult` string: Contents of field 44, second byte. - AuthorizationIsoFieldsBancontact: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'none', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` 'none', required - `networkSpecificFields` BancontactSpecificFields, required: Bancontact specific ISO8583 raw values - `iban` string: The International Bank Account Number (IBAN) returned from the bancontact authorization response. - AuthorizationIsoFieldsDiners - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DinersSpecificFields, required: Diners specific ISO8583 raw values - `network` 'diners', required: Card network providing these fields - `cvvIndicator` string: Contents field 44, subfield 2 - `networkReferenceId` string: Contents field 123 - AuthorizationIsoFieldsDiscover - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DiscoverSpecificFields, required: Discover specific ISO8583 raw values - `network` 'discover', required: Card network providing these fields - `avsResponseCode` string: Contents field 44, usage 2, position 1. - `cidResultCode` string: Contents field 44, usage 2, position 2. - `networkReferenceId` string: Contents field 48, position 11-25. - AuthorizationIsoFieldsMastercard - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator". - `networkSpecificFields` MastercardSpecificFields, required: Mastercard specific ISO8583 raw values - `banknetReference` string, required: Contents of field 63, subfield 2 - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces. - `merchantAdviceCode` string: Contents of field 48, subelement 84 - `cvcResult` string: Contents of field 48, subelement 87 - `nameValidationResult` string: Contents of field 108, subelement 08, subfield 02. Result of Mastercard name validation check. To request name validation set `type.intent` = `account-status` and provide `card.holderName`. - `avsResponse` string: Contents of field 48, subelement 83 - `paymentAccountReference` string: Contents of field 56, subelement 1, subfield 1 - `transactionLinkId` string: Contents of field 105, subelement 1 - `digitalCommerceProgramType` string: Contents of field 48, subelement 48, subfield 2. Identifies the specific digital commerce program used. - `onBehalfServices` object[]: Contents of field 48, subelement 71. - `onBehalfService` string, required: Contents of field 48, subelement 71, subfield 1. - `onBehalfResult1` string, required: Contents of field 48, subelement 71, subfield 2. - `onBehalfResult2` string, required: Contents of field 48, subelement 71, subfield 3. - AuthorizationIsoFieldsUnionPay - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 60, subfield 2, subfield 8 of the authorization request. - `networkSpecificFields` UnionPaySpecificFields, required: UnionPay specific ISO8583 raw values - `network` 'unionpay', required: Card network providing these fields - `pvnCheckResult` string: Contents of field 61, subfield 3. Result of PIN Verification Value check. - AuthorizationIsoFieldsVisa - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` VisaSpecificFields, required: Visa specific ISO8583 raw values - `transactionIdentifier` string, required: Contents of field 62, subfield 2 - `cvv2ResultCode` string: Contents of field 44, subfield 10 - `avsResultCode` string: Contents of field 44, subfield 2 - `paymentAccountReference` string: Contents of field 56, dataset 1, tag 1 - `aniResults` object: Contents of field 34, dataset 4. Result of Visa Account Name Inquiry (ANI) check. To request ANI set `type.intent` = `account-status` and provide `card.holderName` - `status` string, required: Contents of field 34, dataset 4, tag C0 - `fullNameMatch` string: Contents of field 34, dataset 4, tag C4 - `firstNameMatch` string: Contents of field 34, dataset 4, tag CA - `middleNameMatch` string: Contents of field 34, dataset 4, tag C9 - `lastNameMatch` string: Contents of field 34, dataset 4, tag C8 - `vaaiScore` string: Contents of field 104, dataset 5b, tag 85 - `tokenRequestorId` string: Contents of field 123, dataset 68, tag 03. Identifies the Token Requestor Id (TRID) - `billingAddress` BillingAddress: The billing address of the cardholder - `countryCode` SchemasCountryCode - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string: The city of the address. - `line1` string: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `shippingAddress` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `clearAfter` string, iso-8601-date-time: If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the future from when the charge was created. - `dynamicDescriptor` SchemasDynamicDescriptor: Field supports the merchant customizing the DBA name and city on a per-transaction basis, to allow the cardholder to recognize the business name and city on their card or bank statement. - `merchantName` string: Recognizable business name that will appear on the customer's card or bank statement. - `merchantCity` string: City from which the transaction originated - `foreignRetailer` union: Used for transactions fulfilled partly or fully by end seller that is in a different country than the Marketplace or Ramp Provider. VISA EXPERIMENTAL - ForeignRetailerDisabled: Transaction does not involve a foreign retailer - `indicator` false, required: Specifies if end seller in the transaction is a foreign retailer - ForeignRetailerEnabled: Transaction involves a foreign retailer - `indicator` true, required: Specifies if end seller in the transaction is a foreign retailer - `amount` integer: Specifies the exact amount corresponding to the foreign retailer. Cannot be more than the total charge amount (amount.value). - `subMerchant` SubMerchantResponse: Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor. - `id` string: Unique ID assigned to the subMerchant. - `address` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `riskCheckResult` RiskCheckResult: Result of the risk check. The field is always present on a charge if a risk check was requested. - `provider` 'fraudio', required: Provider for the risk check. - `fraudioResult` FraudioResult: The result of the fraudio risk assessment. - `score` number, required: The score of the fraudio risk assessment. - `recommendation` 'green' | 'amber' | 'red', required: The recommendation of the fraudio risk assessment. - `requestId` string, required: The request id of the fraudio risk assessment. - `transactionId` string, required: The transaction id of the fraudio risk assessment. - `actionTaken` 'proceeded' | 'aborted', required: The action taken on the charge after risk assessment. - `result` 'success' | 'error', required: The result of the risk check. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - AtmCharge: An ATM charge (withdrawal transaction) - `key` string, required: Uniquely identifies a charge. - `type` object, required: Describes the kind of ATM charge. - `intent` 'withdrawal', required: The intention of the cardholder for ATM transactions - `terminalEntryMode` 'chip' | 'contactless' | 'contactless-magstripe' | 'magstripe' | 'magstripe-fallback', required: This field indicates the method used for PAN entry on the ATM terminal to initiate the transaction. - `accountSource` 'unspecified' | 'savings' | 'checking' | 'credit', required: Indicates the type of account from which the funds should be withdrawn. - `amount` object, required: The amount for ATM transactions - `value` integer, required: The amount in minor units. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `authorizationIsoFields` object, required: Object containing the raw values from the ISO8583 response message received from the network for ATM transactions. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `networkSpecificFields` union, required - MastercardSpecificFields: Mastercard specific ISO8583 raw values - `banknetReference` string, required: Contents of field 63, subfield 2 - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces. - `merchantAdviceCode` string: Contents of field 48, subelement 84 - `cvcResult` string: Contents of field 48, subelement 87 - `nameValidationResult` string: Contents of field 108, subelement 08, subfield 02. Result of Mastercard name validation check. To request name validation set `type.intent` = `account-status` and provide `card.holderName`. - `avsResponse` string: Contents of field 48, subelement 83 - `paymentAccountReference` string: Contents of field 56, subelement 1, subfield 1 - `transactionLinkId` string: Contents of field 105, subelement 1 - `digitalCommerceProgramType` string: Contents of field 48, subelement 48, subfield 2. Identifies the specific digital commerce program used. - `onBehalfServices` object[]: Contents of field 48, subelement 71. - `onBehalfService` string, required: Contents of field 48, subelement 71, subfield 1. - `onBehalfResult1` string, required: Contents of field 48, subelement 71, subfield 2. - `onBehalfResult2` string, required: Contents of field 48, subelement 71, subfield 3. - VisaSpecificFields: Visa specific ISO8583 raw values - `transactionIdentifier` string, required: Contents of field 62, subfield 2 - `cvv2ResultCode` string: Contents of field 44, subfield 10 - `avsResultCode` string: Contents of field 44, subfield 2 - `paymentAccountReference` string: Contents of field 56, dataset 1, tag 1 - `aniResults` object: Contents of field 34, dataset 4. Result of Visa Account Name Inquiry (ANI) check. To request ANI set `type.intent` = `account-status` and provide `card.holderName` - `status` string, required: Contents of field 34, dataset 4, tag C0 - `fullNameMatch` string: Contents of field 34, dataset 4, tag C4 - `firstNameMatch` string: Contents of field 34, dataset 4, tag CA - `middleNameMatch` string: Contents of field 34, dataset 4, tag C9 - `lastNameMatch` string: Contents of field 34, dataset 4, tag C8 - `vaaiScore` string: Contents of field 104, dataset 5b, tag 85 - `tokenRequestorId` string: Contents of field 123, dataset 68, tag 03. Identifies the Token Requestor Id (TRID) - `card` object, required: Card data for ATM transactions. ATM transactions do not support processor tokenization. - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `clearingMode` 'auto' | 'manual', required: The clearing method for the charge. - `auto`: The charge is cleared automatically as soon as possible. To delay clearing, provide a `clearAfter` timestamp. - `manual`: The charge must be manually cleared later. - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `status` object, required: The status property provides a high-level representation of the lifecycle of an ATM charge. ATM charges do not support authentication (no 3DS). - `authorization` 'approved' | 'declined' | 'reversed', required: Authorization status of the ATM charge. - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `terminal` object, required: Details about the ATM terminal. - `id` string, required: ATM terminal's ID - `capabilities` AtmTerminalCapability[], required: The capabilities of the ATM terminal. This can be one or multiple. - `clearAfter` string, iso-8601-date-time: If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the future from when the charge was created. - `dcc` union: Dynamic Currency Conversion (DCC) allows cardholders to see the transaction amount in their home currency at the ATM. - object: DCC is not enabled for this transaction - `enabled` false, required: Specifies if DCC is enabled for this transaction - object: DCC is enabled for this transaction - `enabled` true, required: Specifies if DCC is enabled for this transaction - `preConversionAmount` object, required: The amount before currency conversion, in the cardholder's home currency - `value` integer, required: The amount in minor units. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - BepCharge: A BEP charge - `key` string, required: Uniquely identifies a charge. - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `amount` ComponentsSchemasAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `type` BepChargeType, required: Describes the kind of charge the merchant wants to submit. - `intent` 'purchase', required: The intention of the cardholder - `cardEntry` 'e-commerce', required: The method used to capture the card details. - `order` 'checkout', required: The method used to place the order. - `sequence` 'initial': Setting this to `initial` flags the charge as the initial charge in a sequence of payments. **From November 22, 2026 this field will be removed since it currently does not have any effect on the charge creation.** - `status` StatusBep, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'authenticated', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'approved' | 'declined', required: Authorization status of the charge - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `authentication` ChargeAuthenticationBEP, required: Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used. - `sca` ScaBEP, required: Object container for strong customer authentication. - `method` 'bep', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated', required: Indicates SCA compliance of the charges - `complianceReason` 'mandated', required: Indicates the reason for the SCA compliance. - `result` BEPAuthenticationResult, required: Object containing the information of a BEP transaction. - `trm` '50' | '51', required: The method of initiating the BEP authentication. Stands for Transaction Routing Means. - `cvc` 'none', required: The result of cvc verification - `avs` 'none', required: The result of the AVS verification - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `fraudLiability` 'acquirer' | 'issuer', required: Which party is liable in case of fraud. - `clearingMode` 'auto' - `authorizationIsoFields` AuthorizationIsoFieldsBancontact, required: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'none', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` 'none', required - `networkSpecificFields` BancontactSpecificFields, required: Bancontact specific ISO8583 raw values - `iban` string: The International Bank Account Number (IBAN) returned from the bancontact authorization response. - `billingAddress` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - FundingCharge: A funding charge - `key` string, required: Uniquely identifies a charge. - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `tokenDetails` union: Further details about the token that was used. Required if `type.cardEntry` is `token` or `token-on-file`. - StoredTokenDetailsNetwork - `type` 'network', required: Details about a token from one of the card networks - `eci` string: Zero-padded e-commerce indicator. - StoredTokenDetailsDigitalWallet - `type` 'apple-pay' | 'google-pay', required: Details about a token from Apple Pay or Google Pay - `eci` string: Zero-padded e-commerce indicator. - `amount` ComponentsSchemasAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `type` FundingChargeType, required: Describes the kind of charge the merchant wants to submit. - `intent` 'funding', required: The intention of the cardholder - `cardEntry` 'e-commerce' | 'token' | 'token-on-file' | 'card-on-file', required: The method used to capture the card details. - `order` 'checkout' | 'recurring' | 'ucof' | 'standing-order' | 'one-click', required - `fundingType` 'account-to-account' | 'general-funds-disbursement' | 'liquid-assets' | 'wallet-transfer' | 'person-to-person' | 'me-to-me' | 'me-to-me-debit-prepaid', required: Describes the type of funding charge. - `account-to-account`: Transfer funds to a specific type of account. This can be specified in the `receiver`. - `general-funds-disbursement`: Funding transaction used to enable a payout disbursement for various use cases. - `liquid-assets`: Funding type used for direct acquisition of liquid and cryptocurrency assets or to prefund a wallet primarily used for such assets (e.g., stocks, shares, foreign currency exchange, or cryptocurrency). Currently only supported for **Visa.** - `wallet-transfer`: Transfer funds to a wallet. Currently only supported for **Visa.** - `person-to-person`: Transaction that uses funds from the sender’s account to fund a subsequent and linked transaction to the receiver's account. Currently only supported for **Mastercard.** - `me-to-me`: Transaction that debits a card account of a consumer or organization for the purpose of transferring funds to the same consumer or organization. Currently only supported for **Mastercard.** EXPERIMENTAL - `me-to-me-debit-prepaid`: Transaction that debits a card account of a consumer or organization for the purpose of transferring funds to a Debit or Prepaid account of the same consumer or organization. Currently only supported for **Mastercard.** EXPERIMENTAL - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `receiver` FundingReceiver, required: Required when `type.intent` is `funding`. Details of the recipient of the funds. - `firstName` string, required: Recipient's first name. - `middleName` string: Recipient's middle name. - `lastName` string, required: Recipient's last name. - `accountNumber` string, required: The masked account number. - `accountNumberType` 'card-account' | 'iban-bank-account' | 'bic-bank-account' | 'rtn-bank-account' | 'email' | 'phone-number' | 'wallet-id' | 'social-network-id', required: The type of the `accountNumber`. - `address` object, required: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `sender` FundingSender, required: Details of the sender of the funds. - `firstName` string, required: Sender's first name. - `middleName` string: Sender's middle name. - `lastName` string, required: Sender's last name. - `accountNumber` string, required: The masked account number. - `accountNumberType` 'card-account' | 'iban-bank-account' | 'bic-bank-account' | 'rtn-bank-account' | 'email' | 'phone-number' | 'wallet-id' | 'social-network-id', required: The type of the `accountNumber`. - `address` object, required: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `riskCheckResult` RiskCheckResult: Result of the risk check. The field is always present on a charge if a risk check was requested. - `provider` 'fraudio', required: Provider for the risk check. - `fraudioResult` FraudioResult: The result of the fraudio risk assessment. - `score` number, required: The score of the fraudio risk assessment. - `recommendation` 'green' | 'amber' | 'red', required: The recommendation of the fraudio risk assessment. - `requestId` string, required: The request id of the fraudio risk assessment. - `transactionId` string, required: The transaction id of the fraudio risk assessment. - `actionTaken` 'proceeded' | 'aborted', required: The action taken on the charge after risk assessment. - `result` 'success' | 'error', required: The result of the risk check. - `fraudLiability` 'acquirer' | 'issuer', required: Which party is liable in case of fraud. - `status` Status, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'none' | 'authenticated' | 'non-authenticated', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'none' | 'approved' | 'approved-partial' | 'declined' | 'reversed', required: Authorization status of the charge. - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `authentication` FundingPayoutChargeAuthentication, required: Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used. - `sca` union, required - FundingPayoutThreeDsAuthentication: Object container for strong customer authentication. - `method` '3ds1' | '3ds2' | 'device', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated' | 'mit' | 'exemption', required - `complianceReason` 'mandated' | 'none' | 'ucof' | 'recurring' | 'installment' | 'incremental' | 'delayed-charges' | 'no-show' | 'reauthorization' | 'resubmission' | 'whitelist' | 'auto' | 'mit' | 'tra' | 'low-value' | 'delegation' | 'scp', required: Indicates the reason for the SCA compliance. - `result` FundingPayoutThreeDsAuthenticationResultResponse, required: Object containing the information of a 3DS transaction. - `type` 'full-auth' | 'attempt', required: Type of 3DS authentication result. - `version` '2.2.0': The 3DS protocol version which has been used to perform 3DS. This information is only available when it has been provided in the request. - `directoryServerTransId` string: Transaction ID retrieved from the Directory Server - ScaBEP: Object container for strong customer authentication. - `method` 'bep', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated', required: Indicates SCA compliance of the charges - `complianceReason` 'mandated', required: Indicates the reason for the SCA compliance. - `result` BEPAuthenticationResult, required: Object containing the information of a BEP transaction. - `trm` '50' | '51', required: The method of initiating the BEP authentication. Stands for Transaction Routing Means. - AuthenticationOutOfScope - `method` 'none', required - `compliance` 'out-of-scope', required - `complianceReason` 'none' | 'moto' | 'one-leg' | 'anonymous-prepaid' | 'recurring', required - AuthenticationExempt - `method` 'none', required - `compliance` 'exemption', required - `complianceReason` 'whitelist' | 'auto' | 'mit' | 'tra' | 'recurring' | 'low-value' | 'delegation' | 'scp' | 'wip', required - ScaMit - `method` 'none', required - `compliance` 'mit', required - `complianceReason` 'installment' | 'ucof', required - `cvc` 'none' | 'match' | 'no-match' | 'not-processed', required: The result of cvc verification - `avs` 'none' | 'match' | 'partial-match' | 'no-match' | 'not-processed', required: The result of the AVS verification - `clearingMode` 'none': The clearing mode of the charge. For funding charges it is always `none`. - `authorizationIsoFields` union, required: Object containing the raw values from the ISO8583 response message received from the network. - AuthorizationIsoFieldsAmericanExpress - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required: Not applicable for American Express transactions. - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` AmexSpecificFields, required: American Express-specific ISO8583 raw values - `acquirerReferenceData` string, required: Contents of field 31. - `cvcResult` string: Contents of field 44, first byte. - `avsResult` string: Contents of field 44, second byte. - AuthorizationIsoFieldsBancontact: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'none', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` 'none', required - `networkSpecificFields` BancontactSpecificFields, required: Bancontact specific ISO8583 raw values - `iban` string: The International Bank Account Number (IBAN) returned from the bancontact authorization response. - AuthorizationIsoFieldsDiners - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DinersSpecificFields, required: Diners specific ISO8583 raw values - `network` 'diners', required: Card network providing these fields - `cvvIndicator` string: Contents field 44, subfield 2 - `networkReferenceId` string: Contents field 123 - AuthorizationIsoFieldsDiscover - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DiscoverSpecificFields, required: Discover specific ISO8583 raw values - `network` 'discover', required: Card network providing these fields - `avsResponseCode` string: Contents field 44, usage 2, position 1. - `cidResultCode` string: Contents field 44, usage 2, position 2. - `networkReferenceId` string: Contents field 48, position 11-25. - AuthorizationIsoFieldsMastercard - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator". - `networkSpecificFields` MastercardSpecificFields, required: Mastercard specific ISO8583 raw values - `banknetReference` string, required: Contents of field 63, subfield 2 - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces. - `merchantAdviceCode` string: Contents of field 48, subelement 84 - `cvcResult` string: Contents of field 48, subelement 87 - `nameValidationResult` string: Contents of field 108, subelement 08, subfield 02. Result of Mastercard name validation check. To request name validation set `type.intent` = `account-status` and provide `card.holderName`. - `avsResponse` string: Contents of field 48, subelement 83 - `paymentAccountReference` string: Contents of field 56, subelement 1, subfield 1 - `transactionLinkId` string: Contents of field 105, subelement 1 - `digitalCommerceProgramType` string: Contents of field 48, subelement 48, subfield 2. Identifies the specific digital commerce program used. - `onBehalfServices` object[]: Contents of field 48, subelement 71. - `onBehalfService` string, required: Contents of field 48, subelement 71, subfield 1. - `onBehalfResult1` string, required: Contents of field 48, subelement 71, subfield 2. - `onBehalfResult2` string, required: Contents of field 48, subelement 71, subfield 3. - AuthorizationIsoFieldsUnionPay - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 60, subfield 2, subfield 8 of the authorization request. - `networkSpecificFields` UnionPaySpecificFields, required: UnionPay specific ISO8583 raw values - `network` 'unionpay', required: Card network providing these fields - `pvnCheckResult` string: Contents of field 61, subfield 3. Result of PIN Verification Value check. - AuthorizationIsoFieldsVisa - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` VisaSpecificFields, required: Visa specific ISO8583 raw values - `transactionIdentifier` string, required: Contents of field 62, subfield 2 - `cvv2ResultCode` string: Contents of field 44, subfield 10 - `avsResultCode` string: Contents of field 44, subfield 2 - `paymentAccountReference` string: Contents of field 56, dataset 1, tag 1 - `aniResults` object: Contents of field 34, dataset 4. Result of Visa Account Name Inquiry (ANI) check. To request ANI set `type.intent` = `account-status` and provide `card.holderName` - `status` string, required: Contents of field 34, dataset 4, tag C0 - `fullNameMatch` string: Contents of field 34, dataset 4, tag C4 - `firstNameMatch` string: Contents of field 34, dataset 4, tag CA - `middleNameMatch` string: Contents of field 34, dataset 4, tag C9 - `lastNameMatch` string: Contents of field 34, dataset 4, tag C8 - `vaaiScore` string: Contents of field 104, dataset 5b, tag 85 - `tokenRequestorId` string: Contents of field 123, dataset 68, tag 03. Identifies the Token Requestor Id (TRID) - `purposeOfPayment` string: A code that describes the purpose of payment to classify and report the nature and purpose of the transaction. Refer to Visa documentation for country specific requirements for this field. - `subMerchant` SubMerchantResponse: Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor. - `id` string: Unique ID assigned to the subMerchant. - `address` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - PayoutCharge: A payout charge - `key` string, required: Uniquely identifies a charge. - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `amount` ComponentsSchemasAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `type` PayoutChargeType, required: Describes the kind of charge the merchant wants to submit. - `intent` 'payout', required: The intention of the cardholder. - `cardEntry` 'e-commerce', required: The method used to capture the card details. - `order` 'checkout', required: The method used to place the order. - `payoutType` 'account-to-account' | 'fast-refund' | 'general-funds-disbursement' | 'liquid-assets' | 'merchant-disbursement' | 'online-gambling' | 'person-to-person' | 'wallet-transfer', required: - `account-to-account`: Payout transaction for moving money from one account to another account, both of which are owned by the sender. Currently only supported for **Visa** EXPERIMENTAL and **Mastercard**. - `fast-refund`: Transaction that returns funds to the same card used in the original purchase. MASTERCARD EXPERIMENTAL - `general-funds-disbursement`: Generic funds disbursement transaction used to push funds from a business to an individual cardholder for various purposes. Currently only supported for **Visa** and **Mastercard**. - `liquid-assets`: Payout of liquid or cryptocurrency asset proceeds to a card account, e.g., from a sale or cash out. Currently only supported for **Visa**. - `merchant-disbursement`: Merchant payments for purchase transaction processing where the settlement payment is sent directly to a card account. Currently only supported for **Visa** and **Mastercard**. - `online-gambling`: Payouts of online casino winnings. Currently only supported for **Visa** and **Mastercard**. - `person-to-person`: Payout transaction moving funds from the sender's account to the receiver's account. Currently only supported for **Mastercard**. - `wallet-transfer`: Payout transaction for adding funds to a digital wallet, the direct acquisition of cryptocurrency, or the acquisition of liquid assets (for example, stocks, shares, foreign currency). Currently only supported for **Visa**. - `clearingMode` 'auto' | 'manual': The clearing method for the charge. - `auto`: The charge is cleared automatically as soon as possible. To delay clearing, provide a `clearAfter` timestamp. - `manual`: The charge must be manually cleared later. - `status` StatusWithoutPartialApproval, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'none' | 'authenticated' | 'non-authenticated', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'none' | 'approved' | 'declined' | 'reversed', required: Authorization status of the charge. - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `authentication` FundingPayoutChargeAuthentication, required: Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used. - `sca` union, required - FundingPayoutThreeDsAuthentication: Object container for strong customer authentication. - `method` '3ds1' | '3ds2' | 'device', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated' | 'mit' | 'exemption', required - `complianceReason` 'mandated' | 'none' | 'ucof' | 'recurring' | 'installment' | 'incremental' | 'delayed-charges' | 'no-show' | 'reauthorization' | 'resubmission' | 'whitelist' | 'auto' | 'mit' | 'tra' | 'low-value' | 'delegation' | 'scp', required: Indicates the reason for the SCA compliance. - `result` FundingPayoutThreeDsAuthenticationResultResponse, required: Object containing the information of a 3DS transaction. - `type` 'full-auth' | 'attempt', required: Type of 3DS authentication result. - `version` '2.2.0': The 3DS protocol version which has been used to perform 3DS. This information is only available when it has been provided in the request. - `directoryServerTransId` string: Transaction ID retrieved from the Directory Server - ScaBEP: Object container for strong customer authentication. - `method` 'bep', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated', required: Indicates SCA compliance of the charges - `complianceReason` 'mandated', required: Indicates the reason for the SCA compliance. - `result` BEPAuthenticationResult, required: Object containing the information of a BEP transaction. - `trm` '50' | '51', required: The method of initiating the BEP authentication. Stands for Transaction Routing Means. - AuthenticationOutOfScope - `method` 'none', required - `compliance` 'out-of-scope', required - `complianceReason` 'none' | 'moto' | 'one-leg' | 'anonymous-prepaid' | 'recurring', required - AuthenticationExempt - `method` 'none', required - `compliance` 'exemption', required - `complianceReason` 'whitelist' | 'auto' | 'mit' | 'tra' | 'recurring' | 'low-value' | 'delegation' | 'scp' | 'wip', required - ScaMit - `method` 'none', required - `compliance` 'mit', required - `complianceReason` 'installment' | 'ucof', required - `cvc` 'none' | 'match' | 'no-match' | 'not-processed', required: The result of cvc verification - `avs` 'none' | 'match' | 'partial-match' | 'no-match' | 'not-processed', required: The result of the AVS verification - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `fraudLiability` 'acquirer' | 'issuer': Which party is liable in case of fraud. - `authorizationIsoFields` union, required: Object containing the raw values from the ISO8583 response message received from the network. - AuthorizationIsoFieldsAmericanExpress - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required: Not applicable for American Express transactions. - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` AmexSpecificFields, required: American Express-specific ISO8583 raw values - `acquirerReferenceData` string, required: Contents of field 31. - `cvcResult` string: Contents of field 44, first byte. - `avsResult` string: Contents of field 44, second byte. - AuthorizationIsoFieldsBancontact: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'none', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` 'none', required - `networkSpecificFields` BancontactSpecificFields, required: Bancontact specific ISO8583 raw values - `iban` string: The International Bank Account Number (IBAN) returned from the bancontact authorization response. - AuthorizationIsoFieldsDiners - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DinersSpecificFields, required: Diners specific ISO8583 raw values - `network` 'diners', required: Card network providing these fields - `cvvIndicator` string: Contents field 44, subfield 2 - `networkReferenceId` string: Contents field 123 - AuthorizationIsoFieldsDiscover - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DiscoverSpecificFields, required: Discover specific ISO8583 raw values - `network` 'discover', required: Card network providing these fields - `avsResponseCode` string: Contents field 44, usage 2, position 1. - `cidResultCode` string: Contents field 44, usage 2, position 2. - `networkReferenceId` string: Contents field 48, position 11-25. - AuthorizationIsoFieldsMastercard - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator". - `networkSpecificFields` MastercardSpecificFields, required: Mastercard specific ISO8583 raw values - `banknetReference` string, required: Contents of field 63, subfield 2 - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces. - `merchantAdviceCode` string: Contents of field 48, subelement 84 - `cvcResult` string: Contents of field 48, subelement 87 - `nameValidationResult` string: Contents of field 108, subelement 08, subfield 02. Result of Mastercard name validation check. To request name validation set `type.intent` = `account-status` and provide `card.holderName`. - `avsResponse` string: Contents of field 48, subelement 83 - `paymentAccountReference` string: Contents of field 56, subelement 1, subfield 1 - `transactionLinkId` string: Contents of field 105, subelement 1 - `digitalCommerceProgramType` string: Contents of field 48, subelement 48, subfield 2. Identifies the specific digital commerce program used. - `onBehalfServices` object[]: Contents of field 48, subelement 71. - `onBehalfService` string, required: Contents of field 48, subelement 71, subfield 1. - `onBehalfResult1` string, required: Contents of field 48, subelement 71, subfield 2. - `onBehalfResult2` string, required: Contents of field 48, subelement 71, subfield 3. - AuthorizationIsoFieldsUnionPay - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 60, subfield 2, subfield 8 of the authorization request. - `networkSpecificFields` UnionPaySpecificFields, required: UnionPay specific ISO8583 raw values - `network` 'unionpay', required: Card network providing these fields - `pvnCheckResult` string: Contents of field 61, subfield 3. Result of PIN Verification Value check. - AuthorizationIsoFieldsVisa - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` VisaSpecificFields, required: Visa specific ISO8583 raw values - `transactionIdentifier` string, required: Contents of field 62, subfield 2 - `cvv2ResultCode` string: Contents of field 44, subfield 10 - `avsResultCode` string: Contents of field 44, subfield 2 - `paymentAccountReference` string: Contents of field 56, dataset 1, tag 1 - `aniResults` object: Contents of field 34, dataset 4. Result of Visa Account Name Inquiry (ANI) check. To request ANI set `type.intent` = `account-status` and provide `card.holderName` - `status` string, required: Contents of field 34, dataset 4, tag C0 - `fullNameMatch` string: Contents of field 34, dataset 4, tag C4 - `firstNameMatch` string: Contents of field 34, dataset 4, tag CA - `middleNameMatch` string: Contents of field 34, dataset 4, tag C9 - `lastNameMatch` string: Contents of field 34, dataset 4, tag C8 - `vaaiScore` string: Contents of field 104, dataset 5b, tag 85 - `tokenRequestorId` string: Contents of field 123, dataset 68, tag 03. Identifies the Token Requestor Id (TRID) - `sender` PayoutSender, required: The details of the sender of the payout. - `firstName` string: Sender's first name. - `middleName` string: Sender's middle name. - `lastName` string: Sender's last name. - `accountNumber` string: The masked account number. - `accountNumberType` 'card-account' | 'iban-bank-account' | 'bic-bank-account' | 'rtn-bank-account' | 'email' | 'phone-number' | 'wallet-id' | 'social-network-id' | 'other': The type of the `accountNumber`. - `address` object: A physical postal address. - `countryCode` union, required - ComponentsSchemasCountryCodeAlpha3 - `alpha3` string, required - ComponentsSchemasCountryCodeAlpha2 - `alpha2` string, required - ComponentsSchemasCountryCodeNumeric - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `identification` object: Identification used to verify sender or receiver. - `type` 'date-of-birth' | 'national-identification' | 'passport-number' | 'driver-license' | 'tax-identification' | 'company-registration-number' | 'social-security-number' | 'other', required: Type of identification: - `date-of-birth` - Date of birth according to [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) - `national-identification` - National identification - `passport-number` - Passport number - `driver-license` - Driver license - `tax-identification` - Tax identification - `company-registration-number` - Company registration number - `social-security-number` - Social security number - `other` - Customer identification (unspecified) - `value` string, required: The value used for identification of the sender or receiver. For BTHD (date of birth) the format should be [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - `issuingCountry` string: Issuing country of the identification, according to [ISO 3166-3](https://en.wikipedia.org/wiki/ISO_3166-3) - `receiver` PayoutReceiver: Details of the recipient of the payout. - `firstName` string: Recipient's first name. - `middleName` string: Recipient's middle name. - `lastName` string: Recipient's last name. - `accountNumber` string: The masked account number. - `accountNumberType` 'card-account' | 'iban-bank-account' | 'bic-bank-account' | 'rtn-bank-account' | 'email' | 'phone-number' | 'wallet-id' | 'social-network-id' | 'other': The type of the `accountNumber`. - `address` object: A physical postal address. - `countryCode` union, required - ComponentsSchemasCountryCodeAlpha3 - `alpha3` string, required - ComponentsSchemasCountryCodeAlpha2 - `alpha2` string, required - ComponentsSchemasCountryCodeNumeric - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `identification` object: Identification used to verify sender or receiver. - `type` 'date-of-birth' | 'national-identification' | 'passport-number' | 'driver-license' | 'tax-identification' | 'company-registration-number' | 'social-security-number' | 'other', required: Type of identification: - `date-of-birth` - Date of birth according to [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) - `national-identification` - National identification - `passport-number` - Passport number - `driver-license` - Driver license - `tax-identification` - Tax identification - `company-registration-number` - Company registration number - `social-security-number` - Social security number - `other` - Customer identification (unspecified) - `value` string, required: The value used for identification of the sender or receiver. For BTHD (date of birth) the format should be [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - `issuingCountry` string: Issuing country of the identification, according to [ISO 3166-3](https://en.wikipedia.org/wiki/ISO_3166-3) - `riskCheckResult` RiskCheckResult: Result of the risk check. The field is always present on a charge if a risk check was requested. - `provider` 'fraudio', required: Provider for the risk check. - `fraudioResult` FraudioResult: The result of the fraudio risk assessment. - `score` number, required: The score of the fraudio risk assessment. - `recommendation` 'green' | 'amber' | 'red', required: The recommendation of the fraudio risk assessment. - `requestId` string, required: The request id of the fraudio risk assessment. - `transactionId` string, required: The transaction id of the fraudio risk assessment. - `actionTaken` 'proceeded' | 'aborted', required: The action taken on the charge after risk assessment. - `result` 'success' | 'error', required: The result of the risk check. - `purposeOfPayment` string: A code that describes the purpose of payment to classify and report the nature and purpose of the transaction. Refer to Visa documentation for country specific requirements for this field. - `subMerchant` SubMerchantResponse: Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor. - `id` string: Unique ID assigned to the subMerchant. - `address` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - PosCharge: A POS charge - `key` string, required: Uniquely identifies a charge. - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `amount` object, required: The amount encoded as an object with a `value` in minor units and a `currency` code. An optional `breakdown` can be provided to indicate specific sub-amounts. - `value` integer, required: An amount in minor units. For example `$12.34` should be encoded as `1234`. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `breakdown` ResponseAmountBreakdown: A breakdown of the transaction `value`. All provided amounts must exactly add up to `value`. Providing a breakdown is only required if any other amounts besides the `baseAmount` are included. - `baseAmount` integer, required: An amount in minor units. For example `$12.34` should be encoded as `1234`. - `cashback` integer: An amount in minor units. For example `$12.34` should be encoded as `1234`. - `type` ChargePosType, required: Describes the kind of POS charge the merchant wants to submit. - `intent` 'purchase' | 'reservation' | 'refund', required: The intention of the cardholder - `cardEntry` 'terminal', required: The method used to capture the card details. - `order` 'counter', required: The method used to place the order. - `terminalEntryMode` 'contactless' | 'manual-entry' | 'chip' | 'magstripe' | 'magstripe-fallback', required: This field indicates the method used for PAN entry on the terminal to initiate the transaction. - `sequence` 'subsequent': This property indicates that the cardholder has entered Online PIN, when required by the issuer for a Mastercard Single Tap transaction. - `status` StatusPos, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'none', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'none' | 'approved' | 'approved-partial' | 'declined' | 'reversed' | 'approved-purchase-amount-only', required: Authorization status of the charge. Value 'approved-purchase-amount-only' is only returned for Mastercard charges using 'amount.breakdown.cashback'. In this case, only the 'amount.breakdown.baseAmount' was approved, but not the cashback. - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `authorizationIsoFields` PosAuthorizationIsoFields, required: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` '00', required - `networkSpecificFields` union, required - VisaSpecificFields: Visa specific ISO8583 raw values - `transactionIdentifier` string, required: Contents of field 62, subfield 2 - `cvv2ResultCode` string: Contents of field 44, subfield 10 - `avsResultCode` string: Contents of field 44, subfield 2 - `paymentAccountReference` string: Contents of field 56, dataset 1, tag 1 - `aniResults` object: Contents of field 34, dataset 4. Result of Visa Account Name Inquiry (ANI) check. To request ANI set `type.intent` = `account-status` and provide `card.holderName` - `status` string, required: Contents of field 34, dataset 4, tag C0 - `fullNameMatch` string: Contents of field 34, dataset 4, tag C4 - `firstNameMatch` string: Contents of field 34, dataset 4, tag CA - `middleNameMatch` string: Contents of field 34, dataset 4, tag C9 - `lastNameMatch` string: Contents of field 34, dataset 4, tag C8 - `vaaiScore` string: Contents of field 104, dataset 5b, tag 85 - `tokenRequestorId` string: Contents of field 123, dataset 68, tag 03. Identifies the Token Requestor Id (TRID) - MastercardSpecificFields: Mastercard specific ISO8583 raw values - `banknetReference` string, required: Contents of field 63, subfield 2 - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces. - `merchantAdviceCode` string: Contents of field 48, subelement 84 - `cvcResult` string: Contents of field 48, subelement 87 - `nameValidationResult` string: Contents of field 108, subelement 08, subfield 02. Result of Mastercard name validation check. To request name validation set `type.intent` = `account-status` and provide `card.holderName`. - `avsResponse` string: Contents of field 48, subelement 83 - `paymentAccountReference` string: Contents of field 56, subelement 1, subfield 1 - `transactionLinkId` string: Contents of field 105, subelement 1 - `digitalCommerceProgramType` string: Contents of field 48, subelement 48, subfield 2. Identifies the specific digital commerce program used. - `onBehalfServices` object[]: Contents of field 48, subelement 71. - `onBehalfService` string, required: Contents of field 48, subelement 71, subfield 1. - `onBehalfResult1` string, required: Contents of field 48, subelement 71, subfield 2. - `onBehalfResult2` string, required: Contents of field 48, subelement 71, subfield 3. - `clearingMode` 'auto' | 'manual': The clearing method for the charge. - `auto`: The charge is cleared automatically as soon as possible. To delay clearing, provide a `clearAfter` timestamp. - `manual`: The charge must be manually cleared later. - `clearAfter` string, iso-8601-date-time: If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the future from when the charge was created. - `terminal` union, required: Details about the terminal. - object - `type` 'pos', required - `id` string, required: Terminal's ID - `attended` boolean, required: Whether the terminal is attended or not. - `capabilities` TerminalCapability[], required: The capabilities of the terminal. This can be one or multiple, and if more than one is specified it means that it is capable of all of those things. #### Restrictions If `capabilities` include `keyEntry` or `signature` then `attended` must be set to `true`. - object - `type` 'mpos', required - `id` string, required: Terminal's ID - `attended` true, required: Whether the terminal is attended or not. - `capabilities` TerminalCapability[], required: The capabilities of the terminal. This can be one or multiple, and if more than one is specified it means that it is capable of all of those things. - object - `type` 'softpos', required - `id` string, required: Terminal's ID - `attended` true, required: Whether the terminal is attended or not. - `capabilities` SoftPosTerminalCapability[], required: The capabilities of the terminal. This can be one or multiple, and if more than one is specified it means that it is capable of all of those things. - `subMerchant` SubMerchantResponse: Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor. - `id` string: Unique ID assigned to the subMerchant. - `address` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `pointOfSaleAddress` PointOfSaleAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - MitChargeFromInitialCharge: A charge - `key` string, required: Uniquely identifies a charge. - `refundedChargeKey` string: The charge key of the refunded charge. **This field is only available for charges created on the [Refund endpoint](#operation/refund) with `createRefundCharge` set to `true`.** - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `tokenDetails` union: Further details about the token that was used. Required if `type.cardEntry` is `token` or `token-on-file`. - StoredTokenDetailsNetwork - `type` 'network', required: Details about a token from one of the card networks - `eci` string: Zero-padded e-commerce indicator. - StoredChargeTokenDetailsDigitalWallet - `type` 'apple-pay' | 'google-pay' | 'paze', required: Details about a digital wallet token. `paze` is only supported for VISAMASTERCARD and is EXPERIMENTAL. - `eci` string: Zero-padded e-commerce indicator. - `amount` ComponentsSchemasAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `cardholderBillingAmount` CardholderBillingAmount: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `conversionRate` object, required - `cardholderBillingConversionRate` number, required - `decimalIndicator` number, required - `type` GetResponseChargeType, required: Describes the kind of charge the merchant wants to submit. - `intent` 'purchase' | 'reservation' | 'account-status' | 'refund', required: The intention of the cardholder. - `cardEntry` 'e-commerce' | 'manual' | 'card-on-file' | 'terminal' | 'token' | 'token-on-file', required: The method used to capture the card details. - `order` 'checkout' | 'unspecified' | 'mail' | 'phone' | 'one-click' | 'recurring' | 'ucof' | 'installment' | 'standing-order' | 'counter', required: The method used to place the order. - `sequence` union - 'initial': Setting this to `initial` flags the charge as the initial charge in a sequence of payments. - 'subsequent': For older charges created on the [`POST /charges`](#operation/createCharge) endpoint, this field can have a value of `subsequent`. - `clearingMode` 'auto' | 'manual': The clearing method for the charge. - `auto`: The charge is cleared automatically as soon as possible. To delay clearing, provide a `clearAfter` timestamp. - `manual`: The charge must be manually cleared later. - `status` ChargeStatus, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'none' | 'authenticated' | 'non-authenticated', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'none' | 'approved' | 'declined' | 'reversed' | 'approved-partial', required: Authorization status of the charge - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `authentication` ChargeAuthentication, required: Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used. - `sca` union, required - ThreeDsAuthentication: Object container for strong customer authentication. - `method` '3ds1' | '3ds2' | 'device', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated' | 'mit' | 'exemption', required - `complianceReason` 'mandated' | 'none' | 'ucof' | 'recurring' | 'installment' | 'incremental' | 'delayed-charges' | 'no-show' | 'reauthorization' | 'resubmission' | 'whitelist' | 'auto' | 'mit' | 'tra' | 'low-value' | 'delegation' | 'scp', required: Indicates the reason for the SCA compliance. - `result` ThreeDsAuthenticationResultResponse, required: Object containing the information of a 3DS transaction. - `version` '2.2.0': The 3DS protocol version which has been used to perform 3DS. This information is only available when it has been provided in the request. - `directoryServerTransId` string: Transaction ID retrieved from the Directory Server - ScaBEP: Object container for strong customer authentication. - `method` 'bep', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated', required: Indicates SCA compliance of the charges - `complianceReason` 'mandated', required: Indicates the reason for the SCA compliance. - `result` BEPAuthenticationResult, required: Object containing the information of a BEP transaction. - `trm` '50' | '51', required: The method of initiating the BEP authentication. Stands for Transaction Routing Means. - AuthenticationOutOfScope - `method` 'none', required - `compliance` 'out-of-scope', required - `complianceReason` 'none' | 'moto' | 'one-leg' | 'anonymous-prepaid' | 'recurring', required - AuthenticationExempt - `method` 'none', required - `compliance` 'exemption', required - `complianceReason` 'whitelist' | 'auto' | 'mit' | 'tra' | 'recurring' | 'low-value' | 'delegation' | 'scp' | 'wip', required - ScaMit - `method` 'none', required - `compliance` 'mit', required - `complianceReason` 'installment' | 'ucof', required - `cvc` 'none' | 'match' | 'no-match' | 'not-processed', required: The result of cvc verification - `avs` 'none' | 'match' | 'partial-match' | 'no-match' | 'not-processed', required: The result of the AVS verification - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `transactionType` 'cryptocurrency' | 'high-risk-securities' | 'central-bank-digital-currency' | 'stablecoin' | 'blockchain-native-coin' | 'non-fungible-token': In case of a special transaction type, this allows you to specify which one. `type.intent` needs to be `purchase`. - `cryptocurrency`: A transaction involving the purchasing of cryptocurrencies. Use this for Visa only if specific type of digital asset cannot be determined. - `high-risk-securities`: A transaction involving the purchasing of high-risk securities. Only supported for Mastercard. - `central-bank-digital-currency`: A transaction involving purchase of a Central Bank Digital Currency (CBDC). Only supported for Visa. - `stablecoin`: A transaction involving purchase of stablecoins. - `blockchain-native-coin`: A transaction involving purchase of a non fiat backed blockchain coin. Only supported for Visa. - `non-fungible-token`: A transaction involving purchase of a Non Fungible Token (NFT). Only supported for Visa. Not supported for Diners. - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `fraudLiability` 'acquirer' | 'issuer', required: Which party is liable in case of fraud. - `authorizationIsoFields` union, required: Object containing the raw values from the ISO8583 response message received from the network. - AuthorizationIsoFieldsAmericanExpress - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required: Not applicable for American Express transactions. - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` AmexSpecificFields, required: American Express-specific ISO8583 raw values - `acquirerReferenceData` string, required: Contents of field 31. - `cvcResult` string: Contents of field 44, first byte. - `avsResult` string: Contents of field 44, second byte. - AuthorizationIsoFieldsBancontact: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'none', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` 'none', required - `networkSpecificFields` BancontactSpecificFields, required: Bancontact specific ISO8583 raw values - `iban` string: The International Bank Account Number (IBAN) returned from the bancontact authorization response. - AuthorizationIsoFieldsDiners - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DinersSpecificFields, required: Diners specific ISO8583 raw values - `network` 'diners', required: Card network providing these fields - `cvvIndicator` string: Contents field 44, subfield 2 - `networkReferenceId` string: Contents field 123 - AuthorizationIsoFieldsDiscover - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DiscoverSpecificFields, required: Discover specific ISO8583 raw values - `network` 'discover', required: Card network providing these fields - `avsResponseCode` string: Contents field 44, usage 2, position 1. - `cidResultCode` string: Contents field 44, usage 2, position 2. - `networkReferenceId` string: Contents field 48, position 11-25. - AuthorizationIsoFieldsMastercard - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator". - `networkSpecificFields` MastercardSpecificFields, required: Mastercard specific ISO8583 raw values - `banknetReference` string, required: Contents of field 63, subfield 2 - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces. - `merchantAdviceCode` string: Contents of field 48, subelement 84 - `cvcResult` string: Contents of field 48, subelement 87 - `nameValidationResult` string: Contents of field 108, subelement 08, subfield 02. Result of Mastercard name validation check. To request name validation set `type.intent` = `account-status` and provide `card.holderName`. - `avsResponse` string: Contents of field 48, subelement 83 - `paymentAccountReference` string: Contents of field 56, subelement 1, subfield 1 - `transactionLinkId` string: Contents of field 105, subelement 1 - `digitalCommerceProgramType` string: Contents of field 48, subelement 48, subfield 2. Identifies the specific digital commerce program used. - `onBehalfServices` object[]: Contents of field 48, subelement 71. - `onBehalfService` string, required: Contents of field 48, subelement 71, subfield 1. - `onBehalfResult1` string, required: Contents of field 48, subelement 71, subfield 2. - `onBehalfResult2` string, required: Contents of field 48, subelement 71, subfield 3. - AuthorizationIsoFieldsUnionPay - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: Contents of field 60, subfield 2, subfield 8 of the authorization request. - `networkSpecificFields` UnionPaySpecificFields, required: UnionPay specific ISO8583 raw values - `network` 'unionpay', required: Card network providing these fields - `pvnCheckResult` string: Contents of field 61, subfield 3. Result of PIN Verification Value check. - AuthorizationIsoFieldsVisa - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` VisaSpecificFields, required: Visa specific ISO8583 raw values - `transactionIdentifier` string, required: Contents of field 62, subfield 2 - `cvv2ResultCode` string: Contents of field 44, subfield 10 - `avsResultCode` string: Contents of field 44, subfield 2 - `paymentAccountReference` string: Contents of field 56, dataset 1, tag 1 - `aniResults` object: Contents of field 34, dataset 4. Result of Visa Account Name Inquiry (ANI) check. To request ANI set `type.intent` = `account-status` and provide `card.holderName` - `status` string, required: Contents of field 34, dataset 4, tag C0 - `fullNameMatch` string: Contents of field 34, dataset 4, tag C4 - `firstNameMatch` string: Contents of field 34, dataset 4, tag CA - `middleNameMatch` string: Contents of field 34, dataset 4, tag C9 - `lastNameMatch` string: Contents of field 34, dataset 4, tag C8 - `vaaiScore` string: Contents of field 104, dataset 5b, tag 85 - `tokenRequestorId` string: Contents of field 123, dataset 68, tag 03. Identifies the Token Requestor Id (TRID) - `billingAddress` BillingAddress: The billing address of the cardholder - `countryCode` SchemasCountryCode - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string: The city of the address. - `line1` string: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `shippingAddress` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `clearAfter` string, iso-8601-date-time: If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the future from when the charge was created. - `dynamicDescriptor` SchemasDynamicDescriptor: Field supports the merchant customizing the DBA name and city on a per-transaction basis, to allow the cardholder to recognize the business name and city on their card or bank statement. - `merchantName` string: Recognizable business name that will appear on the customer's card or bank statement. - `merchantCity` string: City from which the transaction originated - `foreignRetailer` union: Used for transactions fulfilled partly or fully by end seller that is in a different country than the Marketplace or Ramp Provider. VISA EXPERIMENTAL - ForeignRetailerDisabled: Transaction does not involve a foreign retailer - `indicator` false, required: Specifies if end seller in the transaction is a foreign retailer - ForeignRetailerEnabled: Transaction involves a foreign retailer - `indicator` true, required: Specifies if end seller in the transaction is a foreign retailer - `amount` integer: Specifies the exact amount corresponding to the foreign retailer. Cannot be more than the total charge amount (amount.value). - `subMerchant` SubMerchantResponse: Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor. - `id` string: Unique ID assigned to the subMerchant. - `address` ComponentsSchemasAddress: A physical postal address - `countryCode` SchemasCountryCode, required - `alpha3` string, required - `alpha2` string, required - `numeric` string, required - `stateOrProvince` string: The state (US) or province (non-US) of the address. - `city` string, required: The city of the address. - `line1` string, required: Address line 1 - `line2` string: Address line 2 - `postalCode` string, required: The postal code of the address, allowing a single separating space. - `riskCheckResult` RiskCheckResult: Result of the risk check. The field is always present on a charge if a risk check was requested. - `provider` 'fraudio', required: Provider for the risk check. - `fraudioResult` FraudioResult: The result of the fraudio risk assessment. - `score` number, required: The score of the fraudio risk assessment. - `recommendation` 'green' | 'amber' | 'red', required: The recommendation of the fraudio risk assessment. - `requestId` string, required: The request id of the fraudio risk assessment. - `transactionId` string, required: The transaction id of the fraudio risk assessment. - `actionTaken` 'proceeded' | 'aborted', required: The action taken on the charge after risk assessment. - `result` 'success' | 'error', required: The result of the risk check. - `created` string, iso-8601-date-time, required: The date and time this object was created - `lastModified` string, iso-8601-date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `recurringExpiry` string, date: Date at which the recurring authorization expires. Required for recurring charges. Format: YYYY-MM-DD - `recurringFrequency` integer: Number of days between recurring authorizations. Required for recurring charges. - `initialChargeKey` string: Uniquely identifies a charge. - MitCharge: The created charge. - `key` string, required: Uniquely identifies a charge. - `merchantAcceptorRef` ComponentsSchemasAcceptorRef, required: Reference key and status of the acceptor - `key` string, required: Uniquely identifies a merchant acceptor. - `version` integer, required: The version of this object - `card` OutputCard, required: Card data - `maskedNumber` string, required: The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible. - `processorTokenKey` string: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `amount` ComponentsSchemasAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code. - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code. - `type` MitResponseChargeType, required: Describes the kind of charge the merchant wants to submit. - `intent` 'purchase' | 'reservation' | 'account-status', required: The intention of the cardholder. To perform an `account-status` for AMEX, `avs` has to be set to `true`. - `cardEntry` 'card-on-file' | 'token-on-file', required: The method used to capture the card details. - `order` 'recurring' | 'ucof' | 'installment' | 'standing-order', required: The method used to place the order. - `sequence` 'subsequent': This endpoint only allows subsequent transaction of an initial charge which can be created through the `/charges` endpoint. - `status` Status, required: The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used. - `authentication` 'none' | 'authenticated' | 'non-authenticated', required: Strong Customer Authentication (SCA) status of the charge - `authorization` 'none' | 'approved' | 'approved-partial' | 'declined' | 'reversed', required: Authorization status of the charge. - `clearing` 'none' | 'manual' | 'pending' | 'completed' | 'cancelled' | 'abandoned', required: Clearing status of the charge - `authentication` ChargeAuthenticationMit, required: Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used. - `sca` union, required - ThreeDsAuthentication: Object container for strong customer authentication. - `method` '3ds1' | '3ds2' | 'device', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated' | 'mit' | 'exemption', required - `complianceReason` 'mandated' | 'none' | 'ucof' | 'recurring' | 'installment' | 'incremental' | 'delayed-charges' | 'no-show' | 'reauthorization' | 'resubmission' | 'whitelist' | 'auto' | 'mit' | 'tra' | 'low-value' | 'delegation' | 'scp', required: Indicates the reason for the SCA compliance. - `result` ThreeDsAuthenticationResultResponse, required: Object containing the information of a 3DS transaction. - `version` '2.2.0': The 3DS protocol version which has been used to perform 3DS. This information is only available when it has been provided in the request. - `directoryServerTransId` string: Transaction ID retrieved from the Directory Server - ScaBEP: Object container for strong customer authentication. - `method` 'bep', required: Indicates the method that was used to comply to SCA. - `compliance` 'mandated', required: Indicates SCA compliance of the charges - `complianceReason` 'mandated', required: Indicates the reason for the SCA compliance. - `result` BEPAuthenticationResult, required: Object containing the information of a BEP transaction. - `trm` '50' | '51', required: The method of initiating the BEP authentication. Stands for Transaction Routing Means. - AuthenticationOutOfScope - `method` 'none', required - `compliance` 'out-of-scope', required - `complianceReason` 'none' | 'moto' | 'one-leg' | 'anonymous-prepaid' | 'recurring', required - AuthenticationExempt - `method` 'none', required - `compliance` 'exemption', required - `complianceReason` 'whitelist' | 'auto' | 'mit' | 'tra' | 'recurring' | 'low-value' | 'delegation' | 'scp' | 'wip', required - ScaMit - `method` 'none', required - `compliance` 'mit', required - `complianceReason` 'installment' | 'ucof', required - `cvc` 'none', required: The result of cvc verification - `avs` 'none' | 'match' | 'partial-match' | 'no-match' | 'not-processed', required: The result of the AVS verification - `localTransactionDateTime` string, iso-8601-date-time, required: Date and time of the transaction in the local timezone. - `authorizationIsoFields` union, required: Object containing the raw values from the ISO8583 response message received from the network. - AuthorizationIsoFieldsAmericanExpress - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'not-applicable', required: Not applicable for American Express transactions. - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` AmexSpecificFields, required: American Express-specific ISO8583 raw values - `acquirerReferenceData` string, required: Contents of field 31. - `cvcResult` string: Contents of field 44, first byte. - `avsResult` string: Contents of field 44, second byte. - AuthorizationIsoFieldsBancontact: Object containing the raw values from the ISO8583 response message received from the network. - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` 'none', required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` 'none', required - `networkSpecificFields` BancontactSpecificFields, required: Bancontact specific ISO8583 raw values - `iban` string: The International Bank Account Number (IBAN) returned from the bancontact authorization response. - AuthorizationIsoFieldsDiners - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DinersSpecificFields, required: Diners specific ISO8583 raw values - `network` 'diners', required: Card network providing these fields - `cvvIndicator` string: Contents field 44, subfield 2 - `networkReferenceId` string: Contents field 123 - AuthorizationIsoFieldsDiscover - `responseCode` string, required: Contents of field 39 - `responseCodeDescription` string, required: The description of the `responseCode` - `authorizationCode` string: Contents of field 38 - `networkCode` string, required: Contents of field 63, subfield 1 - `systemTraceAuditNumber` string, required: Contents of field 11 - `retrievalReferenceNumber` string, required: Contents of field 37 - `eci` string, required: E-commerce Indicator - `networkSpecificFields` DiscoverSpecificFields, required: Discover specific ISO8583 raw values - `network` 'discover', required: Card network providing these fields - `avsResponseCode` string: Contents field 44, usage 2, position 1. - `cidResultCode` string: Contents field 44, usage 2, position 2. - … truncated; see the full OpenAPI document linked below ## Other responses - `400`: The request body was malformed - `401`: Authentication information is missing or invalid - `403`: The authenticated client is forbidden to make the request for the resource identified. - `404`: The requested resource was not found - `429`: Too Many Requests - `500`: Internal Server Error --- [API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)