--- title: "Create Payout Charge" method: POST path: "/charges/payout" tags: ["Create Charges"] --- # Create Payout Charge `POST /charges/payout` ## Request - Base URL: `https://eu-west-1.api.silverflow.com/v1` - URL: `https://eu-west-1.api.silverflow.com/v1/charges/payout` - Auth: one of: - HTTP basic - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Create a new payout charge. For more information on use-cases, [see here](https://docs.silverflow.com/guides/payouts-and-funding#tag/Payouts). **NOTE:** This endpoint requires configuration on a per client basis and may be subject to additional approvals and implementation with the card schemes. Contact your Silverflow representative before integrating with this endpoint. **Currently only supported for Visa and Mastercard.** Requires the `charges:CreatePayout` or `charges:Create` permission. ## Headers - `Idempotency-Key` string: This key is used to deduplicate requests that are retried. For more information see the section on [Idempotency](https://docs.silverflow.com/guides/idempotency). ## Request body - PayoutChargeRequest: Create a payout charge - `merchantAcceptorResolver` union, required: The resolver is used to select the appropriate merchant acceptor for creating the charge. It can accept either a `merchantAcceptorKey` or a combination of `merchantKey` and an optional `route`. If the optional property for `route` is not provided the default one generated when creating an acceptor will be used. - object: Used to select a merchant acceptor by key. - `merchantAcceptorKey` string, required: Uniquely identifies a merchant acceptor. - object: Used to select a merchant acceptor by merchant key and an optional route. - `merchantKey` string, required: Uniquely identifies a merchant. - `route` string: Route key used to uniquely reference an acceptor when used in combination with its card network and merchant key. - `card` union, required: This field represents the card or token information. The card credentials can either be passed directly in the request or be referenced using a `key`. - CardInputWithOptionalExpiryDate - `number` string, password, required: Full digits of a card - `expiryMonth` integer: The month the card expires. January is 1 - `expiryYear` integer: The year the card expires including the century - `cvc` string: The CVC of the card For Mastercard, Visa, Discover, Bancontact, and Diners the length must be 3. For American Express the length must be 4. - `holderName` string: The name of the cardholder. In case of AVS, it will be truncated by the scheme if longer than 26 characters (Visa) or 22 characters (Mastercard). More information here: [Cardholder name restrictions](charges.html#section/Appendix-A-Cardholder-Name-Restrictions) - SchemasCardByProcessorTokenKey - `processorTokenKey` string, required: The key to a card tokenized in the [Processor Tokenization](#tag/Processor-Tokenization). - `cvc` string: The CVC of the card For Mastercard, Visa, Discover, Bancontact, and Diners the length must be 3. For American Express the length must be 4. - `amount` CommonAmount, 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' | '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. - `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**. - `initialTransactionReferences` VisaPayoutInitialTransactionReference - `initialTransactionIdentifier` string, required: The Visa transaction identifier of the initial transaction - `threeDsAuthenticationResult` FundingPayoutThreeDsAuthenticationResult: A 3DS result from either the [3DS Authentication endpoint](#operation/create3dsAuthentication) or an external party. - `type` 'full-auth' | 'attempt', required: Type of 3DS authentication result. - `version` '2.2.0': The version of the 3DS protocol used for authentication. **Required for AMEX transactions.** - `authenticationValue` string, required: Base64 encoded result value from the 3DS transaction. Note that Mastercard and Visa use a different underlying format. - `directoryServerTransId` string, required: Transaction ID retrieved from the Directory Server (DS). - `eci` string: ECI value from the 3DS provider. Use this to explicitly override the ECI value in Visa authorization messages. This field has no impact for any other network. VISA - `localTransactionDateTime` string, iso-8601-date-time: 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. - `fundingSource` 'credit' | 'debit' | 'prepaid' | 'deposit-account' | 'mobile-money-account' | 'cash' | 'other': The source of the funds for the payout. `mobile-money-account` is specific to Mastercard transactions. The rest are common to both networks. **Required for all Mastercard Payouts.** - `sender` PayoutSenderInput: The details of the sender of the payout. If not provided or partially provided, the missing sender information will be filled in with the details taken from the merchant acceptor. **Must be provided for Mastercard transactions.** - `type` 'consumer' | 'organization' | 'not-applicable': The type of the sender. **Mastercard only.** EXPERIMENTAL - `organizationName` string: The name of the organization. - `firstName` string: Sender's first name. - `middleName` string: Sender's middle name. - `lastName` string: Sender's last name. - `accountNumber` string: The 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` PayoutReceiverInput: Details of the recipient of the payout. **Must be provided for Mastercard transactions.** - `type` 'consumer' | 'organization' | 'not-applicable': The type of the receiver. **Mastercard only.** EXPERIMENTAL - `organizationName` string: The name of the organization. - `firstName` string: Recipient's first name. **Must be provided for Mastercard transactions.** - `middleName` string: Recipient's middle name. - `lastName` string: Recipient's last name. **Must be provided for Mastercard transactions.** - `accountNumber` string: The 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) - `transactionType` 'tax-refund' | 'cryptocurrency' | '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. - `tax-refund`: A transaction involving a tax rebate. Only allowed for `payoutType` of `general-funds-disbursement`. Required for USA cardholders. VISA - `cryptocurrency`: A transaction involving the purchasing of cryptocurrencies. Use this for Visa only if specific type of digital asset cannot be determined. Only allowed for Mastercard when `payoutType` is `account-to-account`. VISAMASTERCARD - `central-bank-digital-currency`: A transaction involving purchase of a Central Bank Digital Currency (CBDC). VISA - `stablecoin`: A transaction involving purchase of stablecoins. VISA - `blockchain-native-coin`: A transaction involving purchase of a non fiat backed blockchain coin. VISA - `non-fungible-token`: A transaction involving purchase of a Non Fungible Token (NFT). VISA - `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. - `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 - `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. - `riskAssessmentKey` string: Key that was returned by the transaction risk assessment. - `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` SubMerchant: Submerchant information used in the Payment Facilitator set-up. If present, will override any subMerchant information present on the Merchant Acceptor. DISCOVER MASTERCARD VISA - `id` string: Unique ID assigned to the subMerchant. When provided, overrides `merchantAcceptor.subMerchantId`. - `address` SchemasAddressInput: 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. ## Response `201` The created charge - PayoutChargeResponse: The created 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` CommonAmount, 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' | '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. - `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` 'none' | 'auto' | 'manual', required: The clearing mode of the charge. - `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. - `transactionType` 'tax-refund' | 'cryptocurrency' | '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. - `tax-refund`: A transaction involving a tax rebate. Only allowed for `payoutType` of `general-funds-disbursement`. Required for USA cardholders. VISA - `cryptocurrency`: A transaction involving the purchasing of cryptocurrencies. Use this for Visa only if specific type of digital asset cannot be determined. Only allowed for Mastercard when `payoutType` is `account-to-account`. VISAMASTERCARD - `central-bank-digital-currency`: A transaction involving purchase of a Central Bank Digital Currency (CBDC). VISA - `stablecoin`: A transaction involving purchase of stablecoins. VISA - `blockchain-native-coin`: A transaction involving purchase of a non fiat backed blockchain coin. VISA - `non-fungible-token`: A transaction involving purchase of a Non Fungible Token (NFT). VISA - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction. - `fundingSource` 'credit' | 'debit' | 'prepaid' | 'deposit-account' | 'mobile-money-account' | 'cash' | 'other': The source of the funds for the payout. `mobile-money-account` is specific to Mastercard transactions. The rest are common to both networks. **Required for all Mastercard Payouts.** - `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` ChargesPayoutPayoutSender: The details of the sender of the payout. - `type` 'consumer' | 'organization' | 'not-applicable': The type of the sender. - `organizationName` string: The name of the organization. - `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 returned in payout sender responses. Fields are typed as strings without pattern validation, as payout sender address may originate from the merchant (set to the merchant's registered address when the field was not set in the request). - `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. - `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` ChargesPayoutPayoutReceiver: Details of the recipient of the payout. - `type` 'consumer' | 'organization' | 'not-applicable': The type of the receiver. - `organizationName` string: The name of the organization. - `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` 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. - `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) - `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. - `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. - `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. - `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 ## Other responses - `400`: Bad Request - `401`: Authentication information is missing or invalid - `403`: The authenticated client is forbidden to make the request for the resource identified. - `409`: Conflict - `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)