--- title: "Get all chargebacks" method: GET path: "/merchant/chargebacks" tags: ["merchant"] --- # Get all chargebacks `GET /merchant/chargebacks` ## Query parameters - `limit` number, double - `page` number, double - `status` string - `search` string - `sortBy` string - `sortDirection` number, double - `responded` boolean - `discrepancy` boolean - `processor` string - `protection` string - `threeDSecure` string - `merchantId` string - `since` string - `until` string - `reasonCode` string - `method` string ## Headers - `Authorization` string, required ## Response `200` Ok - AllChargebackResponse[] - `chargebackFeeCents` number, double - `createdAt` string, date-time, required - `merchant` string, required - `invoiceId` string, required - `outstanding` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `updatedAt` string, date-time, required - `payment` IPayment, required - `_id` string, required - `paymentId` string, required - `paymentIntentId` string - `totals` TotalsResponse, required - `subtotal` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `creditCardFees` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `chargebackProtectionFees` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `gasFees` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `fxFees` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `networkFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `payInFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `total` CurrencyCents, required - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `reserve` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `merchantPaidCreditCardFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `merchantPaidChargebackProtectionFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `merchantPaidGasFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `merchantPaidFxFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `merchantPaidNetworkFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `invoicedCreditCardFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `invoicedChargebackProtectionFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `invoicedGasFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `invoicedFxFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `invoicedNetworkFees` CurrencyCents - `cents` integer, required - `currency` 'USD' | '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' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `customer` union, required - string - ICustomerString - `_id` string, required - `customerId` string, required - `blockchain` 'solana' | 'eth' | 'polygon' | 'base' | 'user' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' - `email` string, required - `availability` IAvailability, required - `status` 'Functional' | 'Blocked' | 'Override', required - `reason` string, required - `editor` string, required - `updatedAt` string, date-time, required - `createdAt` string, date-time, required - `verification` Verification - `reference` string, required - `status` 'pending' | 'partial-approval' | 'approved' | 'rejected' | 'expired', required - `vendor` 'middesk' | 'sumsub' | 'sumsub_docv' | 'persona' | 'persona_kyb', required - `name` string - `attested` boolean - `shareToken` string - `shareTokenStatus` string - `sessionToken` string - `rejectionReasons` string[] - `ubos` UboEntry[] - `reference` string, required - `status` 'pending' | 'partial-approval' | 'approved' | 'rejected' | 'expired', required - `vendor` 'middesk' | 'sumsub' | 'sumsub_docv' | 'persona' | 'persona_kyb', required - `name` string - `attested` boolean - `shareToken` string - `shareTokenStatus` string - `sessionToken` string - `rejectionReasons` string[] - `ownershipPct` number, double - `isControllingPerson` boolean - `customerInfo` union - SplitNameCustomerInfo - `verificationId` string - `displayName` string - `address` string - `city` string - `state` string - `zip` string - `country` string - `ip` string - `lat` string - `lng` string - `dob` string — Date of birth in YYYY-MM-DD format - `email` string - `firstName` string, required - `lastName` string, required - NameCustomerInfo - `verificationId` string - `displayName` string - `address` string - `city` string - `state` string - `zip` string - `country` string - `ip` string - `lat` string - `lng` string - `dob` string — Date of birth in YYYY-MM-DD format - `email` string - `name` string - `chargebackProtectionEnabled` boolean, required - `merchant` union, required - string - IMerchantString - `_id` string, required - `merchantId` string, required - `verification` Verification, required - … - `brand` MerchantBrandSettings - … - `colors` MerchantTheme - … - `url` string - `withdrawFees` IMerchantStringWithdrawFees, required - … - `customWithdrawFees` CustomWithdrawFeesConfig — Make all properties in T optional - … - `customPayInFees` CustomPayInFeeConfig[] - … - `wallets` IMerchantStringWallets, required - … - `apiKey` string, required - `webhookValidationKey` string - `nmiWebhookValidationKey` string - `apiKeys` IMerchantStringApiKeysItems[], required - … - `kycType` 'person' | 'business' | 'both', required - `settlementToken` 'USDC' | 'SBC' | 'EUROe' | 'FXUSD' | 'HSUSD' | 'CFUSD' | 'YPUSD', required - `settlementAddresses` IMerchantStringSettlementAddresses - … - `users` IMerchantUser[], required - … - `ubos` UboEntry[], required - … - `goLiveChecklist` MerchantGoLiveChecklist, required - … - `webhookSettings` WebhookSettings - … - `cardSettings` CardSettings, required - … - `achSettings` ACHSettings, required - … - `citconSettings` CitconSettings - … - `aptPayCanadaSettings` union - … - `wireSettings` IWireProviderSettings, required - … - `pixSettings` PixSettings, required - … - `ibanSettings` IbanSettings, required - … - `cryptoPayinSettings` CryptoPayInSettings, required - … - `passiveWithdrawSettings` PassiveWithdrawSettings — Merchant-level settings for the withdrawer-side passive deposit address flow (CryptoWithdrawService). Independent from CryptoPayInSettings. - … - `cashAppSettings` CashAppSettings, required - … - `rainCompanyCards` RainCompanyCardsSettings - … - `paypalSettings` PayPalSettings, required - … - `venmoSettings` VenmoSettings, required - … - `apaSettings` ApaSettings, required - … - `verisoulSettings` VerisoulSettings - … - `blockConfig` IMerchantStringBlockConfig - … - `hideBranding` boolean, required - `onlyShowTotal` boolean, required - `skipSendWithdrawEmail` boolean, required - `sendInvoiceNotifications` boolean, required - `invoiceFrequency` 'Monthly' | 'BiWeekly' | 'Weekly' - `advancedAnalytics` boolean, required - `billingEmails` string[] - `withdrawFeePayment` IMerchantStringWithdrawFeePayment - … - `pushToCardEnabled` boolean, required - `requireAniCheck` boolean, required - `bankPayoutProvider` PayoutProviderOption[] - `ibanPayoutProviders` IbanPayoutProvider[] - `swiftPayoutProviders` SwiftPayoutProvider[] - `ibanPayoutProvider` 'merge' | 'mock' | 'ivy' - `rtpPayoutProviders` RtpPayoutProvider[] - `rtpPayoutProvider` 'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale' - `pixPayoutProviders` PixPayoutProvider[] - `pixPayoutProvider` 'brla' | 'mock' - `eftPayoutProviders` EftPayoutProvider[] - `eftPayoutProvider` 'checkbook' | 'aptpay' | 'mock' - `p2cPayoutProviders` CardPayoutProvider[] - `p2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `globalP2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `appleP2cPayoutProvider` 'aptpay' | 'MOCK' - `venmoPayoutProviders` VenmoPayoutProvider[] - `venmoPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `paypalPayoutProviders` PayPalPayoutProvider[] - `paypalPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `wirePayoutProvider` WirePayoutProvider[] - `interacPayoutProviders` InteracPayoutProvider[] - `interacPayoutProvider` 'checkbook' | 'mock' | 'aptpay' - `interacPaymentProvider` 'mock' | 'aptpay' - `interacSettings` InteracSettings, required - … - `withdrawSorting` PartialRecordWithdrawSpeedWithdrawSort — Make all properties in T optional - … - `withdrawRules` string[] - `firstPartyPayoutOverrides` IMerchantStringFirstPartyPayoutOverrides - … - `maxTransactionAmount` Cents - … - `minTransactionAmount` Cents - … - `refundBalanceLimit` Cents, required - … - `parent` string - `creditSeed` string, required - `withdrawSettlementLocation` 'circle' | 'brale' | 'paper' | 'brale_youpay' | 'bastion', required - `enforceJwt` boolean, required - `enforceCheckoutJwt` boolean - `externalVerificationLinks` boolean - `whitelistedAncestorUrls` string[] - `banDuplicateAccounts` boolean - `fxFees` PartialRecordCurrencyNumber — Make all properties in T optional - … - `blocked` BlockedStatus - … - `vendorSettings` VendorSettings - … - `generatedDescription` string - `bankSettlementOptions` MerchantBankSettlementOptions - … - `allowAttestedKyc` boolean - `attestedKycSsnNotRequired` boolean - `allowAccountSharing` boolean - `personaKycShareTokenTemplate` string - `delayedSettlementDays` number, double, required — Number of business days to delay stablecoin settlement after payment capture. Only applies to USDC settlements. 0 means no delay (immediate settlement). Maximum value is 5 days. - `sendPresettleWebhooks` boolean - `velocitySettings` VelocityControlSettings - … - `velocitySettingsByRail` PartialRecordPaymentTypeVelocityControlSettings — Make all properties in T optional - … - `interchangeFees` InterchangeFees, required - … - `enforceLivenessKyc` boolean - `kycMinAge` number, double - `canCreateBankAccounts` boolean - `checkbookSettings` IMerchantStringCheckbookSettings - … - `reserveSettings` ReserveSettings - … - `globalRateLimit` number, double - `banProxiesForCheckoutEndpoints` boolean - `riskControls` IMerchantStringRiskControls - … - `acceptedToS` boolean - `ssoSettings` MerchantSsoSettings - … - `chargebackFeeCents` number, double - `chargebackEmails` string[] - `fraudEmails` string[] - `linkedBankAccount` LinkedBankAccount - … - `customerDefaultOverrideLimit` Cents - … - `customerOverrideLimitCeiling` Cents - … - `customerDefaultExposureLimit` Cents - … - `dailyExposureLimit` Cents - … - `monthlyExposureLimit` Cents - … - `mcc` string - `processing` IMerchantStringProcessing - … - `failedAttemptSetting` 'Standard' | 'Exempt', required - `verificationSetting` 'Enforced' | 'Exempt', required - `exempt3DS` boolean - `chargebackProtectionOverrideLog` CustomerOverrideAuditLog - `reason` 'customer_override', required - `editor` string - `editorType` 'Coinflow' | 'Merchant' - `overriddenAt` string, date-time - `ipAddress` string - `geoBlockOverride` IGeoBlockOverride — Per-customer exemption from real-time geographic enforcement. When set and not expired, withdrawal blocking rules with method `GEOLOCATION` or `IP` are skipped for this withdrawer. `KYC_ADDRESS` rules still apply — KYC is the compliance floor and must remain enforceable. Auditable by construction: `reason` and `setBy` are required so admins can review why a specific user was exempted. `expiresAt` is optional but strongly recommended; long-lived overrides should be avoided. - `reason` string, required - `setBy` string, required - `setAt` string, date-time, required - `expiresAt` string, date-time - `blockConfigOverride` ICustomerStringBlockConfigOverride — Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit. - `maxDistinctTokensPer30Days` number, double - `customerOverrideLimit` Cents - `cents` integer, required - `overrideExposureLimit` Cents - `cents` integer, required - `fraudOverrideWhitelist` boolean - `excludeBlockCardReuseAcrossCustomers` boolean - `merchant` union, required - string - IMerchantString - `_id` string, required - `merchantId` string, required - `verification` Verification, required - `reference` string, required - `status` 'pending' | 'partial-approval' | 'approved' | 'rejected' | 'expired', required - `vendor` 'middesk' | 'sumsub' | 'sumsub_docv' | 'persona' | 'persona_kyb', required - `name` string - `attested` boolean - `shareToken` string - `shareTokenStatus` string - `sessionToken` string - `rejectionReasons` string[] - `brand` MerchantBrandSettings - `portalBrand` 'approvely' | 'seamlesschex' | 'coinflow' | 'yourbrandhere' | 'Plan2Play' | 'tango' | 'interlace' | 'tapvia' | 'decal' - `logo` string - `displayName` string - `colors` MerchantTheme - `showCardIcon` boolean - `placeholderColor` string - `expirationPlaceholder` string - `cvvPlaceholder` string - `cardNumberPlaceholder` string - `fontWeight` string - `fontSize` string - `style` 'rounded' | 'sharp' | 'pill' - `font` string - `ctaColor` string - `textColorAction` string - `textColorAccent` string - `textColor` string - `backgroundAccent2` string - `backgroundAccent` string - `cardBackground` string - `background` string - `primary` string - `url` string - `withdrawFees` IMerchantStringWithdrawFees, required - `firstParty` PartialRecordWithdrawSpeedWithdrawFeeConfig, required — Make all properties in T optional - `asap` WithdrawFeeConfig - … - `same_day` WithdrawFeeConfig - … - `standard` WithdrawFeeConfig - … - `card` WithdrawFeeConfig - … - `iban` WithdrawFeeConfig - … - `pix` WithdrawFeeConfig - … - `eft` WithdrawFeeConfig - … - `venmo` WithdrawFeeConfig - … - `paypal` WithdrawFeeConfig - … - `wire` WithdrawFeeConfig - … - `interac` WithdrawFeeConfig - … - `swift` WithdrawFeeConfig - … - `business` PartialRecordWithdrawSpeedWithdrawFeeConfig, required — Make all properties in T optional - `asap` WithdrawFeeConfig - … - `same_day` WithdrawFeeConfig - … - `standard` WithdrawFeeConfig - … - `card` WithdrawFeeConfig - … - `iban` WithdrawFeeConfig - … - `pix` WithdrawFeeConfig - … - `eft` WithdrawFeeConfig - … - `venmo` WithdrawFeeConfig - … - `paypal` WithdrawFeeConfig - … - `wire` WithdrawFeeConfig - … - `interac` WithdrawFeeConfig - … - `swift` WithdrawFeeConfig - … - `user` PartialRecordWithdrawSpeedWithdrawFeeConfig, required — Make all properties in T optional - `asap` WithdrawFeeConfig - … - `same_day` WithdrawFeeConfig - … - `standard` WithdrawFeeConfig - … - `card` WithdrawFeeConfig - … - `iban` WithdrawFeeConfig - … - `pix` WithdrawFeeConfig - … - `eft` WithdrawFeeConfig - … - `venmo` WithdrawFeeConfig - … - `paypal` WithdrawFeeConfig - … - `wire` WithdrawFeeConfig - … - `interac` WithdrawFeeConfig - … - `swift` WithdrawFeeConfig - … - `swapBps` number, double, required - `customWithdrawFees` CustomWithdrawFeesConfig — Make all properties in T optional - `asap` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `same_day` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `standard` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `card` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `iban` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `pix` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `eft` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `venmo` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `paypal` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `wire` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `interac` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `swift` union - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `global` union, required - CustomWithdrawFeeValue0 - … - CustomWithdrawFeeValue1 - … - `lineItemLabel` string, required - `isBundled` boolean, required - `customPayInFees` CustomPayInFeeConfig[] - `fee` union, required - CustomPayInFeeValue0 - … - CustomPayInFeeValue1 - … - `lineItemLabel` string, required - `wallets` IMerchantStringWallets, required - `stellar` IMerchantStringWalletsStellar, required - `usdcPayer` string, required - `evm` IMerchantStringWalletsEvm, required - `usdcPayer` string, required - `feePayer` string, required - `solana` IMerchantStringWalletsSolana, required - `usdcPayer` string, required - `feePayer` string, required - `apiKey` string, required - `webhookValidationKey` string - `nmiWebhookValidationKey` string - `apiKeys` IMerchantStringApiKeysItems[], required - `scope` 'admin' | 'editor' | 'chargeback' | 'chargeback_analyst' | 'viewer' | 'seller' | 'pos_device' — Which monthly-minimum model bills the merchant, selectable in merchant settings. `Off` assesses no minimum; `Legacy` and `Tiered` read their numbers from the merchant's MonthlyMinimum MerchantFeeSchedule row. - `ips` string[], required - `disabled` boolean - `privateUuid` string, required - `publicUuid` string, required - `kycType` 'person' | 'business' | 'both', required - `settlementToken` 'USDC' | 'SBC' | 'EUROe' | 'FXUSD' | 'HSUSD' | 'CFUSD' | 'YPUSD', required - `settlementAddresses` IMerchantStringSettlementAddresses - `solana` string - `eth` string - `polygon` string - `base` string - `user` string - `arbitrum` string - `stellar` string - `monad` string - `tempo` string - `directVendor` 'brale' - `mpcWalletProvider` 'metakeep' | 'brale' - `recipientAddresses` IMerchantStringSettlementAddressesRecipientAddressesItems[] - `info` RecordStringAny — Construct a type with a set of properties K of type T - `createdAt` string, date-time, required - `recipient` string, required - `verification` Verification - `reference` string, required - `status` 'pending' | 'partial-approval' | 'approved' | 'rejected' | 'expired', required - `vendor` 'middesk' | 'sumsub' | 'sumsub_docv' | 'persona' | 'persona_kyb', required - `name` string - `attested` boolean - `shareToken` string - `shareTokenStatus` string - `sessionToken` string - `rejectionReasons` string[] - `users` IMerchantUser[], required - `email` string, required - `password` string - `scope` 'admin' | 'editor' | 'chargeback' | 'chargeback_analyst' | 'viewer' | 'seller' | 'pos_device', required — Which monthly-minimum model bills the merchant, selectable in merchant settings. `Off` assesses no minimum; `Legacy` and `Tiered` read their numbers from the merchant's MonthlyMinimum MerchantFeeSchedule row. - `secret` string - `resetNonce` string - `resetNonceUsed` boolean - `ssoProvider` 'google' - `ssoId` string - `ubos` UboEntry[], required - `reference` string, required - `status` 'pending' | 'partial-approval' | 'approved' | 'rejected' | 'expired', required - `vendor` 'middesk' | 'sumsub' | 'sumsub_docv' | 'persona' | 'persona_kyb', required - `name` string - `attested` boolean - `shareToken` string - `shareTokenStatus` string - `sessionToken` string - `rejectionReasons` string[] - `ownershipPct` number, double - `isControllingPerson` boolean - `goLiveChecklist` MerchantGoLiveChecklist, required - `acceptedToS` boolean - `programWhitelistRequests` ProgramWhitelistRequest[] - `programId` string, required - `blockchain` 'solana' | 'eth' | 'polygon' | 'base' | 'user' | 'arbitrum' | 'stellar' | 'monad' | 'tempo', required - `status` 'approved' | 'pending' | 'rejected', required - `rfis` MerchantRfiRef[] - `name` string, required - `status` 'pending' | 'completed', required - `url` string, required - `assignmentFormId` string - `onboardingFormSubmitted` boolean - `applicationSubmitted` boolean - `applicationSubmittedAt` string, date-time - `lockIndustry` boolean - `webhookSettings` WebhookSettings - `webhookUrls` string[], required - `version` 'Legacy' | 'Version 1' | 'Version 2' | 'Version 3', required - `subscriptions` WebhookEventType[], required - `disableAuthorizationHeader` boolean - `disableSubmerchantToParentWebhooks` boolean - `cardSettings` CardSettings, required - `processor` 'payarc' | 'mock' | 'shift4' | 'merchant_warrior' | 'greenlight' | 'nmi_direct' | 'mvb' | 'fifththird' | 'natwest' | 'crb' | 'highnote' | 'nuveiv1' | 'koard' | 'fallback_payarc_shift4' | 'fallback_shift4_payarc' | 'fallback_shift4_nuvei' | 'fallback_nuvei_payarc' | 'fallback_payarc_nuvei' | 'fallback_shift4_greenlight' | 'fallback_greenlight_shift4' | 'fallback_natwest_shift4' | 'fallback_natwest_nuvei' | 'fallback_natwest_shift4_payarc' | 'fallback_natwest_shift4_nuvei' | 'fallback_shift4_natwest_payarc' | 'fallback_nuvei_natwest_payarc' | 'fallback_natwest_nuvei_payarc' | 'fallback_mvb_fifththird_shift4_payarc' | 'fallback_fifththird_mvb_shift4_payarc' | 'fallback_mvb_nuvei' | 'fallback_nuvei_fifththird' | 'fallback_fifththird_nuvei' - `orchestrationRuleId` string - `applePayProcessor` 'payarc' | 'mock' | 'shift4' | 'merchant_warrior' | 'greenlight' | 'nmi_direct' | 'mvb' | 'fifththird' | 'natwest' | 'crb' | 'highnote' | 'nuveiv1' | 'koard' | 'fallback_payarc_shift4' | 'fallback_shift4_payarc' | 'fallback_shift4_nuvei' | 'fallback_nuvei_payarc' | 'fallback_payarc_nuvei' | 'fallback_shift4_greenlight' | 'fallback_greenlight_shift4' | 'fallback_natwest_shift4' | 'fallback_natwest_nuvei' | 'fallback_natwest_shift4_payarc' | 'fallback_natwest_shift4_nuvei' | 'fallback_shift4_natwest_payarc' | 'fallback_nuvei_natwest_payarc' | 'fallback_natwest_nuvei_payarc' | 'fallback_mvb_fifththird_shift4_payarc' | 'fallback_fifththird_mvb_shift4_payarc' | 'fallback_mvb_nuvei' | 'fallback_nuvei_fifththird' | 'fallback_fifththird_nuvei' - `googlePayProcessor` 'payarc' | 'mock' | 'shift4' | 'merchant_warrior' | 'greenlight' | 'nmi_direct' | 'mvb' | 'fifththird' | 'natwest' | 'crb' | 'highnote' | 'nuveiv1' | 'koard' | 'fallback_payarc_shift4' | 'fallback_shift4_payarc' | 'fallback_shift4_nuvei' | 'fallback_nuvei_payarc' | 'fallback_payarc_nuvei' | 'fallback_shift4_greenlight' | 'fallback_greenlight_shift4' | 'fallback_natwest_shift4' | 'fallback_natwest_nuvei' | 'fallback_natwest_shift4_payarc' | 'fallback_natwest_shift4_nuvei' | 'fallback_shift4_natwest_payarc' | 'fallback_nuvei_natwest_payarc' | 'fallback_natwest_nuvei_payarc' | 'fallback_mvb_fifththird_shift4_payarc' | 'fallback_fifththird_mvb_shift4_payarc' | 'fallback_mvb_nuvei' | 'fallback_nuvei_fifththird' | 'fallback_fifththird_nuvei' - `creditCardFeeMode` 'user' | 'merchant' | 'invoice' - `chargebackProtectionFeeMode` 'user' | 'merchant' | 'invoice' - `gasFeeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `networkFeeMode` 'user' | 'merchant' | 'invoice' - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `fixedFee` Cents - `cents` integer, required - `variableFeeBps` number, double - `networkFeeBps` number, double - `supportsGooglePay` boolean - `supportsApplePay` boolean - `saveCardDefault` boolean - `ignoreProcessorLimit` boolean - `nameMatchThreshold` number, double - `verificationSettings` CardSettingsVerificationSettings - `threshold3DS` Cents - … - `verificationLimit` Cents - … - `avsCheck` boolean, required - `threeDsChallengePreference` 'NoPreference' | 'Frictionless' | 'Challenge', required - `enforce3DSWhenProtectionExempt` boolean, required - `greenlightMerchantArgs` GreenlightMerchantArgs - `securityKey` string, required - `mid` string, required - `nuveiV1MerchantArgs` NuveiV1MerchantArgs - `merchantId` string, required - `merchantSiteId` string, required - `conversionAffiliateCountryCode` string - `crbMerchantArgs` CrbMerchantSettings — The merchant's CRB banking identity. CRB is onboarded manually in CRB's dashboard — these values are pasted into our merchant dashboard and verified live against CRB before being persisted. - `customerId` string, required - `cifNumber` string - `subledgerAccountNumber` string - `controllingPersonId` string - `environment` 'sandbox' | 'production' - `highnoteMerchantArgs` HighnoteMerchantSettings - `businessId` string, required - `primaryAuthorizedPersonId` string — Highnote id of the primary business person, captured from the createBusiness response — onboardBusiness attributes its consent to it. - `merchantAcceptorId` string - `applicationSubmittedAt` string, date-time — Set when onboardBusiness (the ProductApplication submission) succeeded. A re-run while underwriting is still Pending must not re-submit the application — Highnote rejects duplicates, which would overwrite a healthy Pending status with an error. - `payarcMerchantArgs` PayarcMerchantArgs - `apiKey` string, required - `merchantId` string - `threeDSArgs` ThreeDSArgs — Construct a type with a set of properties K of type T - `VISA` AcquirerInfo, required - … - `MSTR` AcquirerInfo, required - … - `AMEX` AcquirerInfo, required - … - `DISC` AcquirerInfo, required - … - `scaOnly` boolean - `allowAttempts` boolean, required - `mcc` string, required - `statementDescriptor` string - `tokenizationProvider` 'bt' | 'tokenex' - `applePayIntegratorRegistration` ApplePayIntegratorRegistration - `domainNames` string[], required - `partnerMerchantName` string, required - `partnerMerchantValidationURI` string, required - `partnerInternalMerchantIdentifier` string, required - `applePayMerchantDecryption` boolean - `applePayCertificates` CardSettingsApplePayCertificates - `merchantIdCert` string, required - `privatePem` string, required - `certPem` string, required - `merchantDisplay` string, required - `merchantIdentifier` string, required - `aftSettings` AftSettings - `enabled` boolean, required - `type` 'disbursement' | 'personToPerson' | 'accountToAccount' | 'topUp' | 'purchase' | 'cash' | 'walletLoad', required - `purpose` 'businessToBusiness' | 'creditCardRepayment' | 'crypto' | 'crowdLending' | 'debitCard' | 'education' | 'emergency' | 'familySupport' | 'gift' | 'giftCard' | 'gaming' | 'highRiskSecurities' | 'liquidAssets' | 'medical' | 'payroll' | 'prepaidCard' | 'salary' | 'savings' | 'travel' | 'other', required - `merchantA2AMastercardAftRecipient` AftSettingsMerchantA2AMastercardAftRecipient - … - `customStatementDescriptor` boolean - `cardOnFileSettings` CardOnFileSettings - `enabled` boolean, required - `period` number, double, required - `maxCount` number, double, required - `maxMultiple` number, double, required - `expiration` number, double, required - `maxZeroAuthAmount` Cents - … - `maxAmountLookback` number, double - `mitSettings` CardOnFileSettings - `enabled` boolean, required - `period` number, double, required - `maxCount` number, double, required - `maxMultiple` number, double, required - `expiration` number, double, required - `maxZeroAuthAmount` Cents - … - `maxAmountLookback` number, double - `blockCardReuseAcrossCustomers` boolean — When true, blocks a card payment if the same card token has been used by a different customer for this merchant. - `allowedCardNetworks` CardType[] - `allowServerToServerTokenization` boolean - `visaFraudMonitoringProgram` boolean - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `achSettings` ACHSettings, required - `processor` 'mock' | 'aptpay' | 'coinfx' | 'braid' - `feeMode` 'user' | 'merchant' | 'invoice' - `maxAmount` Cents - `cents` integer, required - `nameMatchThreshold` number, double - `requireKycBeforePurchase` boolean - `withdrawNameMatchThreshold` number, double - `allowDelayedTransactions` boolean, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `instantSettle` boolean, required - `minFee` Cents - `cents` integer, required - `maxFee` Cents - `cents` integer, required - `feeBps` number, double - `fixedFee` Cents - `cents` integer, required - `settlementDays` number, double - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `citconSettings` CitconSettings - `fundPurpose` 'goods' | 'services' | 'prizes' | 'rebates' | 'others', required - `apiKey` string - `aptPayCanadaSettings` union - AptpayCanadaMerchantSettings - `id` string, required - AptpayCanadaCoinflowSettings - `coinflow` boolean, required - `wireSettings` IWireProviderSettings, required - `processor` 'braid' | 'mock' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `minFee` Cents - `cents` integer, required - `maxFee` Cents - `cents` integer, required - `feeBps` number, double - `fixedFee` Cents - `cents` integer, required - `dailyLimit` Cents - `cents` integer, required - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `pixSettings` PixSettings, required - `processor` 'brla' | 'mock' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `fixedFee` Cents - `cents` integer, required - `feeBps` number, double - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `ibanSettings` IbanSettings, required - `processor` 'merge' | 'ivy' | 'mock' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `fixedFee` Cents - `cents` integer, required - `feeBps` number, double - `minFee` Cents - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `cryptoPayinSettings` CryptoPayInSettings, required - `stables` TierSettings, required - `feeBps` number, double, required - `feeMode` 'user' | 'merchant' | 'invoice' - `enabled` boolean, required - `majors` TierSettings, required - `feeBps` number, double, required - `feeMode` 'user' | 'merchant' | 'invoice' - `enabled` boolean, required - `volatile` TierSettings, required - `feeBps` number, double, required - `feeMode` 'user' | 'merchant' | 'invoice' - `enabled` boolean, required - `enabled` boolean, required - `feeMode` 'user' | 'merchant' | 'invoice' - `maxGasFeePayment` Cents, required - `cents` integer, required - `coinbaseDisabled` boolean, required - `transferOnly` boolean - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `fixedFee` Cents - `cents` integer, required - `enableStableDepositAddresses` boolean - `maxActivePassiveAddresses` number, double — Cap on the number of simultaneously-active customer pay-in passive deposit addresses for this merchant. Undefined = no cap. Paused addresses don't count against the cap. - `passiveWithdrawSettings` PassiveWithdrawSettings — Merchant-level settings for the withdrawer-side passive deposit address flow (CryptoWithdrawService). Independent from CryptoPayInSettings. - `enabled` boolean, required - `maxActiveAddresses` number, double — Cap on the number of simultaneously-active withdraw passive deposit addresses for this merchant. Undefined = no cap. - `cashAppSettings` CashAppSettings, required - `processor` 'mock' | 'flashnet' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `fixedFee` Cents - `cents` integer, required - `feeBps` number, double - `minFee` Cents - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `rainCompanyCards` RainCompanyCardsSettings - `enabled` boolean - `rainCompanyId` string - `externalId` string - `applicationStatus` 'approved' | 'pending' | 'needsInformation' | 'needsVerification' | 'manualReview' | 'denied' | 'locked' | 'canceled' - `applicationReason` string - `completionLink` string - `submittedAt` string, date-time - `lastSyncedAt` string, date-time - `contract` RainContractInfo - `contractId` string, required - `chainId` number, double, required - `depositAddress` string, required - `programAddress` string - `proxyAddress` string - `controllerAddress` string - `contractVersion` number, double - `adminAddresses` string[] - `onramp` RainContractInfoOnramp - … - `createdAt` string, date-time, required - `lastSyncedAt` string, date-time, required - `autoTopUp` RainAutoTopUpSettings - `enabled` boolean, required - `targetUsdc` number, double, required - `cadence` 'transaction' | 'hour' | 'day' | 'week' | 'month', required - `lastRunAt` string, date-time - `updatedAt` string, date-time - `updatedBy` string - `pendingTopUps` RainPendingTopUp[] - `amount` number, double, required - `queuedAt` string, date-time, required - `transactionId` string, required - `processedSpendTxnIds` string[] - `paypalSettings` PayPalSettings, required - `processor` 'mock' | 'paypal' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `maxFee` Cents - `cents` integer, required - `fixedFee` Cents, required - `cents` integer, required - `feeBps` number, double, required - `minFee` Cents, required - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `requireLogin` boolean — When set, new PayPal payout accounts must be linked via the verified "Log in with PayPal" flow — raw phone/email adds are rejected. Not retroactive: already-linked accounts remain payable. - `blockPayerReuseAcrossCustomers` boolean — When true, blocks a PayPal payment if the same PayPal payer identity (payerId/email) has been used by a different customer for this merchant. - `venmoSettings` VenmoSettings, required - `processor` 'mock' | 'paypal' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `maxFee` Cents - `cents` integer, required - `fixedFee` Cents, required - `cents` integer, required - `feeBps` number, double, required - `minFee` Cents, required - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `refundFeeSettings` RefundFeeSettings - `feeBps` number, double - `fixedFee` Cents - … - `minFee` Cents - … - `maxFee` Cents - … - `blockPayerReuseAcrossCustomers` boolean — When true, blocks a Venmo payment if the same Venmo payer identity (payerId/email) has been used by a different customer for this merchant. - `apaSettings` ApaSettings, required - `processor` 'apa' | 'mock' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `fixedFee` Cents - `cents` integer, required - `feeBps` number, double - `minFee` Cents - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `verisoulSettings` VerisoulSettings - `enabled` boolean, required - `riskThresholds` VerisoulRiskThresholds, required - `device_risk` number, double - `proxy` number, double - `vpn` number, double - `tor` number, double - `spoofed_ip` number, double - `datacenter` number, double - `recent_fraud_ip` number, double - `impossible_travel` number, double - `device_network_mismatch` number, double - `account_score` number, double - `risk_signals` number, double - `email_score` number, double - `blockConfig` IMerchantStringBlockConfig - `disableMultiCardAttemptCheck` boolean — When true, skips the multi-card attempt check (2+ distinct cards failing in 1 hour). - `maxDistinctTokensPer30Days` number, double — Maximum number of distinct card tokens a single customer may use across non-failed/voided card payments for this merchant in a rolling 30-day window. Apple Pay / Google Pay payments are excluded. Unset or 0 disables the check. Customers with `failedAttemptSetting: Exempt` bypass it. - `disableDestinationAuthKey` boolean — When true, prevents usage of destinationAuthKey for custom settlement addresses. - `enableNmiSettlement` boolean — When true, enables the settlement pipeline for NMI transactions (converts card payments to USDC). - `disableInvoiceWalletPayment` boolean — When true, disables wallet balance payments for invoices. Merchants must use checkout. - `blockingRules` IBlockingRule[] — Independent geo-blocking rules for withdrawals vs card checkout, with explicit per-rule enforcement methods (KYC address / IP / billing address). Read via `getBlockingRules` so callers transparently see the legacy `bannedWithdrawalStates` for un-migrated merchants. - `scope` 'WITHDRAWAL' | 'CHECKOUT' | 'GLOBAL', required - `method` 'KYC_ADDRESS' | 'IP' | 'BILLING_ADDRESS' | 'GEOLOCATION' | 'BIN', required - `listMode` 'DENY' | 'ALLOW' - `states` USState[], required - `countries` Country[] - `bannedWithdrawalStates` USState[] - `whitelistedBinLocations` Country[] - `failedPaymentAttemptLimit` number, double - `hideBranding` boolean, required - `onlyShowTotal` boolean, required - `skipSendWithdrawEmail` boolean, required - `sendInvoiceNotifications` boolean, required - `invoiceFrequency` 'Monthly' | 'BiWeekly' | 'Weekly' - `advancedAnalytics` boolean, required - `billingEmails` string[] - `withdrawFeePayment` IMerchantStringWithdrawFeePayment - `paysGasFees` PartialRecordBlockchainBoolean — Make all properties in T optional - `solana` boolean - `eth` boolean - `polygon` boolean - `base` boolean - `user` boolean - `arbitrum` boolean - `stellar` boolean - `monad` boolean - `tempo` boolean - `bundleDelegatedPayoutFees` boolean - `paysSwapFees` boolean - `paysWithdrawFees` boolean - `pushToCardEnabled` boolean, required - `requireAniCheck` boolean, required - `bankPayoutProvider` PayoutProviderOption[] - `ibanPayoutProviders` IbanPayoutProvider[] - `swiftPayoutProviders` SwiftPayoutProvider[] - `ibanPayoutProvider` 'merge' | 'mock' | 'ivy' - `rtpPayoutProviders` RtpPayoutProvider[] - `rtpPayoutProvider` 'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale' - `pixPayoutProviders` PixPayoutProvider[] - `pixPayoutProvider` 'brla' | 'mock' - `eftPayoutProviders` EftPayoutProvider[] - `eftPayoutProvider` 'checkbook' | 'aptpay' | 'mock' - `p2cPayoutProviders` CardPayoutProvider[] - `p2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `globalP2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `appleP2cPayoutProvider` 'aptpay' | 'MOCK' - `venmoPayoutProviders` VenmoPayoutProvider[] - `venmoPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `paypalPayoutProviders` PayPalPayoutProvider[] - `paypalPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `wirePayoutProvider` WirePayoutProvider[] - `interacPayoutProviders` InteracPayoutProvider[] - `interacPayoutProvider` 'checkbook' | 'mock' | 'aptpay' - `interacPaymentProvider` 'mock' | 'aptpay' - `interacSettings` InteracSettings, required - `processor` 'mock' | 'aptpay' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `fixedFee` Cents - `cents` integer, required - `feeBps` number, double - `minFee` Cents - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `withdrawSorting` PartialRecordWithdrawSpeedWithdrawSort — Make all properties in T optional - `asap` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `same_day` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `standard` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `card` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `iban` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `pix` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `eft` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `venmo` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `paypal` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `wire` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `interac` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `swift` 'DEFAULT' | 'CHEAPEST' | 'ORDERED' | 'LIMIT_CONSUMPTION' - `withdrawRules` string[] - `firstPartyPayoutOverrides` IMerchantStringFirstPartyPayoutOverrides - `interacPayoutProvider` 'checkbook' | 'mock' | 'aptpay' - `wirePayoutProvider` WirePayoutProvider[] - `paypalPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `venmoPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `appleP2cPayoutProvider` 'aptpay' | 'MOCK' - `globalP2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `p2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `eftPayoutProvider` 'checkbook' | 'aptpay' | 'mock' - `pixPayoutProvider` 'brla' | 'mock' - `rtpPayoutProvider` 'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale' - `ibanPayoutProvider` 'merge' | 'mock' | 'ivy' - `bankPayoutProvider` PayoutProviderOption[] - `maxTransactionAmount` Cents - `cents` integer, required - `minTransactionAmount` Cents - `cents` integer, required - `refundBalanceLimit` Cents, required - `cents` integer, required - `parent` string - `creditSeed` string, required - `withdrawSettlementLocation` 'circle' | 'brale' | 'paper' | 'brale_youpay' | 'bastion', required - `enforceJwt` boolean, required - `enforceCheckoutJwt` boolean - `externalVerificationLinks` boolean - `whitelistedAncestorUrls` string[] - `banDuplicateAccounts` boolean - `fxFees` PartialRecordCurrencyNumber — Make all properties in T optional - `USD` number, double - `AED` number, double - `AFN` number, double - `ALL` number, double - `AMD` number, double - `ANG` number, double - `AOA` number, double - `ARS` number, double - `AUD` number, double - `AWG` number, double - `AZN` number, double - `BAM` number, double - `BBD` number, double - `BDT` number, double - `BGN` number, double - `BHD` number, double - `BIF` number, double - `BMD` number, double - `BND` number, double - `BOB` number, double - `BRL` number, double - `BSD` number, double - `BTN` number, double - `BWP` number, double - `BYN` number, double - `BZD` number, double - `CAD` number, double - `CHF` number, double - `CLF` number, double - `CLP` number, double - `CNY` number, double - `COP` number, double - `CRC` number, double - `CUP` number, double - `CVE` number, double - `CZK` number, double - `DJF` number, double - `DKK` number, double - `DOP` number, double - `DZD` number, double - `EGP` number, double - `ETB` number, double - `EUR` number, double - `FJD` number, double - `GBP` number, double - `GEL` number, double - `GHS` number, double - `GMD` number, double - `GNF` number, double - `GTQ` number, double - `GYD` number, double - `HKD` number, double - `HNL` number, double - `HTG` number, double - `HUF` number, double - `IDR` number, double - `ILS` number, double - `INR` number, double - `IQD` number, double - `IRR` number, double - `ISK` number, double - `JMD` number, double - `JOD` number, double - `JPY` number, double - `KES` number, double - `KGS` number, double - `KHR` number, double - `KMF` number, double - `KRW` number, double - `KWD` number, double - `KYD` number, double - `KZT` number, double - `LAK` number, double - `LBP` number, double - `LKR` number, double - `LRD` number, double - `LSL` number, double - `LYD` number, double - `MAD` number, double - `MDL` number, double - `MGA` number, double - `MKD` number, double - `MMK` number, double - `MNT` number, double - `MOP` number, double - `MRU` number, double - `MUR` number, double - `MWK` number, double - `MVR` number, double - `MXN` number, double - `MYR` number, double - `MZN` number, double - `NAD` number, double - `NGN` number, double - `NIO` number, double - `NOK` number, double - `NPR` number, double - `NZD` number, double - `OMR` number, double - `PAB` number, double - `PEN` number, double - `PGK` number, double - `PHP` number, double - `PKR` number, double - `PLN` number, double - `PYG` number, double - `QAR` number, double - `RON` number, double - `RSD` number, double - `RWF` number, double - `SAR` number, double - `SCR` number, double - `SDG` number, double - `SEK` number, double - `SGD` number, double - `SLE` number, double - `SLL` number, double - `SOS` number, double - `SRD` number, double - `STN` number, double - `SVC` number, double - `SYP` number, double - `SZL` number, double - `THB` number, double - `TJS` number, double - `TMT` number, double - `TND` number, double - `TOP` number, double - `TRY` number, double - `TTD` number, double - `TWD` number, double - `TZS` number, double - `UAH` number, double - `UGX` number, double - `UYU` number, double - `UZS` number, double - `VND` number, double - `VUV` number, double - `WST` number, double - `XAF` number, double - `XCD` number, double - `XOF` number, double - `XPF` number, double - `YER` number, double - `ZAR` number, double - `ZMW` number, double - `ZWL` number, double - `CDF` number, double - `ERN` number, double - `FKP` number, double - `KPW` number, double - `RUB` number, double - `SBD` number, double - `SHP` number, double - `SSP` number, double - `VES` number, double - `blocked` BlockedStatus - `level` 'Unverified' | 'Suspended', required - `reason` string, required - `editor` string, required - `blockedAt` string, date-time, required - `recoverySignature` string - `vendorSettings` VendorSettings - `aptPayIdentity` number, double - `aptPayUSCoinflow` boolean - `braid` BraidMerchantSettings - `businessId` number, double, required - `accountId` number, double, required — the Braid operating accountId - `accountNumber` string, required — the Braid operating account number - `reserveAccountId` number, double, required — the Braid reserve accountId - `reserveAccountNumber` string, required — the Braid reserve account number - `rollingAccountId` number, double — the Braid rolling accountId - `rollingAccountNumber` string — the Braid rolling account number - `ivy` IvySettings - `gbpPayinAccountId` string, required - `eurAccountId` string, required - `paypal` PayPalVendorSettings - `accountId` string, required - `status` string — PAY_WITH_PAYPAL capability status (ACTIVE / NEED_DATA / SUSPENDED). - `requirements` string[] — Outstanding requirements blocking PAY_WITH_PAYPAL. - `venmoStatus` string — VENMO_PAY_PROCESSING capability status — same account, separate status. - `venmoRequirements` string[] — Outstanding requirements blocking VENMO_PAY_PROCESSING. - `stakeholderIds` string[] - `verificationTriggered` boolean — True once we've asked PayPal to (re)verify this account's capabilities. triggerVerification itself makes PayPal emit a CAPABILITY_UPDATED webhook, so this flag stops that webhook from triggering verification again forever. - `koard` VendorSettingsKoard - `enabled` boolean - `apiKeyPreview` string - `apiKey` string - `accountId` string, required - `generatedDescription` string - `bankSettlementOptions` MerchantBankSettlementOptions - `token` string, required - `minRemainingBalance` Cents, required - `cents` integer, required - `useWire` boolean - `allowAttestedKyc` boolean - `attestedKycSsnNotRequired` boolean - `allowAccountSharing` boolean - `personaKycShareTokenTemplate` string - `delayedSettlementDays` number, double, required — Number of business days to delay stablecoin settlement after payment capture. Only applies to USDC settlements. 0 means no delay (immediate settlement). Maximum value is 5 days. - `sendPresettleWebhooks` boolean - `velocitySettings` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `velocitySettingsByRail` PartialRecordPaymentTypeVelocityControlSettings — Make all properties in T optional - `card` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `ach` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `pix` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `iban` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `crypto` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `wire` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `CashApp` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `paypal` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `venmo` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `apa` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `interac` VelocityControlSettings - `limitMode` 'default' | 'dynamic' | 'custom' | 'no_limit', required - `customLimit` number, double - `haltOnThreshold` boolean - `lastHaltNotificationSentAt` string, date-time - `lastSettlementPausedNotificationSentAt` string, date-time - `interchangeFees` InterchangeFees, required - `settings` InterchangeSettings, required - `useType` boolean, required - `useRegion` boolean, required - `useScheme` boolean, required - `useBrand` boolean, required - `useDurbin` boolean, required - `rates` RecordStringInterchangeRate — Construct a type with a set of properties K of type T - `enforceLivenessKyc` boolean - `kycMinAge` number, double - `canCreateBankAccounts` boolean - `checkbookSettings` IMerchantStringCheckbookSettings - `merchantName` string, required - `secret` string, required - `key` string, required - `walletId` string, required - `id` string, required - `reserveSettings` ReserveSettings - `status` 'Disabled' | 'Active' | 'SweepFixed', required - `rollingBps` number, double, required - `rollingDuration` number, double, required - `notes` string - `globalRateLimit` number, double - `banProxiesForCheckoutEndpoints` boolean - `riskControls` IMerchantStringRiskControls - `topup` TopupRiskControls - `minAmountCents` number, double — Minimum topup amount in cents - `maxAmountCents` number, double — Maximum topup amount in cents - `acceptedToS` boolean - `ssoSettings` MerchantSsoSettings - `requireSso` boolean, required - `chargebackFeeCents` number, double - `chargebackEmails` string[] - `fraudEmails` string[] - `linkedBankAccount` LinkedBankAccount - `routingNumber` string, required - `accountNumber` string, required - `accountType` 'checking' | 'savings', required - `institutionName` string - `plaidAccessToken` string, required - `plaidAccountId` string, required - `customerDefaultOverrideLimit` Cents - `cents` integer, required - `customerOverrideLimitCeiling` Cents - `cents` integer, required - `customerDefaultExposureLimit` Cents - `cents` integer, required - `dailyExposureLimit` Cents - `cents` integer, required - `monthlyExposureLimit` Cents - `cents` integer, required - `mcc` string - `processing` IMerchantStringProcessing - `msaSigned` boolean, required - `statementsOnFile` boolean, required - `chargebackProtectionDecision` 'approved' | 'rejected' | 'Not Reviewed' | 'Not Enabled' | 'Overridden' | 'Pending Review', required - `liabilityOwner` 'coinflow-entity' | 'coinflow' | 'merchant' - `overrideChargebackProtectionDecision` boolean - `chargebackProtectionAccountType` 'guest' | 'private' | 'business' - `doNotReviewChargebackProtection` boolean - `cart` CartItemClassOmitted[] — Cart item details required for Coinflow Chargeback Protection. Required if the merchant uses chargeback protection. - union - PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClass — From T, pick a set of properties whose keys are in the union K - `productName` string, required — The name of the related product - `productType` 'inGameProduct' | 'gameOfSkill' | 'dataStorage' | 'computingResources' | 'sportsTicket' | 'eSportsTicket' | 'musicTicket' | 'conferenceTicket' | 'virtualSportsTicket' | 'virtualESportsTicket' | 'virtualMusicTicket' | 'virtualConferenceTicket' | 'alcohol' | 'DLC' | 'subscription' | 'fundACause' | 'realEstate' | 'computingContract' | 'digitalArt' | 'topUp' | 'ownershipContract' | 'inGameCurrency' | 'digitalCollectibles' | 'digitalCollectiblesMarketplace' | 'digitalGiftingMarketplace' | 'sweepstakes' | 'virtualSportsEvents' | 'contractInvoicing' | 'onlineCasino' | 'cryptoOnramp' | 'gaming' | 'travelDocuments' | 'musicStreaming' | 'digitalContent' | 'eBooks' | 'digitalSubscriptionContent', required - `listPrice` PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClassListPrice — The item's list price - `currency` string - `valueInCurrency` number, double - `quantity` number, double, required — The number of units sold - `rawProductData` AnyObject - `example` string - `seller` SellerInfo - `id` string — Id of the seller - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `lastName` string — Last name Example: Lois - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `rawSellerData` RecordStringAny — Construct a type with a set of properties K of type T - `transactionHistory` TransactionHistoryItem[] - `txType` string, required - `chain` string, required - `paymentAmount` string, required - `paymentToken` string, required - `to` string, required - `from` string, required - `registryContract` string, required - `assetID` string, required - `txTime` string, required - `blockNumber` number, double, required - `txHash` string, required - PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPrice — From T, pick a set of properties whose keys are in the union K - `brand` string — The name of the brand - `sellingPrice` PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceSellingPrice, required - `currency` string, required - `valueInCurrency` number, double, required - `itemClass` 'giftCard', required - `productType` 'giftCard', required - `quantity` number, double, required — The number of units sold - `rawProductData` RecordStringAny — Construct a type with a set of properties K of type T - `seller` SellerInfo - `id` string — Id of the seller - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `lastName` string — Last name Example: Lois - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `rawSellerData` RecordStringAny — Construct a type with a set of properties K of type T - `id` string, required — The cart items’s unique ID - `itemFulfillment` 'digital' | 'physical', required — How the product was fulfilled. - `sku` string — The stock-keeping unit (SKU) number - `categories` string[] — The category in the site/app in which the item was classified (e.g., fashion) - `isGift` boolean - `recipientInfo` RecipientInfo - `accountId` string — The ID of the account that will receive the purchased goods - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `gender` string — Gender Example: female - `lastName` string — Last name Example: Lois - `message` string — The message that the recipient will receive - `phoneInfo` PhoneInfo — Phone information structure - … - `shippingAddress` CartItemAddress — Address structure - … - `wallet` RecipientInfoWallet — The crypto wallet that will receive the funds - … - `expectedDeliveryDelay` number, double — The expected delay in delivery, in hours - `isPresetAmount` boolean — Represents whether the item amount is taken from a preset list, e.g. 25, 50, 100, etc. or whether it was a different amount, e.g. 27 - CryptoCartItem — Represents a crypto item in a shopping cart - `itemClass` 'crypto', required — Denotes the cart item class. The item schema is chosen based on this value. Allowed value: crypto Example: crypto - `id` string — The cart items's unique ID Example: 5de33332-546a-4171-8988-2a43d2bfe9c6 - `rawProductData` AnyObject - `example` string - `units` string, required — The amount in the crypto currency which is specified in the `cryptoCurrency` property Example: 1.04112 Pattern: ^[0-9]+(\.[0-9]+)?$ - `cryptoCurrency` string, required — The crypto-currency symbol (uppercase) Example: BTC Pattern: ^[A-Z0-9-]+$ - `unitPrice` CryptoCartItemUnitPrice, required — The price per 1 unit - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `expectedDeliveryDelay` number, double — The expected delay in delivery, in hours Min value: 0 - `recipientInfo` RecipientInfo, required - `accountId` string — The ID of the account that will receive the purchased goods - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `gender` string — Gender Example: female - `lastName` string — Last name Example: Lois - `message` string — The message that the recipient will receive - `phoneInfo` PhoneInfo — Phone information structure - … - `shippingAddress` CartItemAddress — Address structure - … - `wallet` RecipientInfoWallet — The crypto wallet that will receive the funds - … - `seller` SellerInfo - `id` string — Id of the seller - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `lastName` string — Last name Example: Lois - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `rawSellerData` RecordStringAny — Construct a type with a set of properties K of type T - MoneyTopUpCartItem — Represents a money top-up item in a shopping cart - `itemClass` 'moneyTopUp', required — Denotes the cart item class. The item schema is chosen based on this value. Allowed value: moneyTopUp Example: moneyTopUp - `id` string — The cart items's unique ID Example: 5de33332-546a-4171-8988-2a43d2bfe9c6 - `rawProductData` RecordStringAny — Construct a type with a set of properties K of type T - `sellingPrice` CurrencyAmount, required — Common currency amount structure - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `recipientInfo` RecipientInfo - `accountId` string — The ID of the account that will receive the purchased goods - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `gender` string — Gender Example: female - `lastName` string — Last name Example: Lois - `message` string — The message that the recipient will receive - `phoneInfo` PhoneInfo — Phone information structure - … - `shippingAddress` CartItemAddress — Address structure - … - `wallet` RecipientInfoWallet — The crypto wallet that will receive the funds - … - `topUpAmount` CurrencyAmount, required — Common currency amount structure - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `quantity` number, double, required — Quantity Example: 2 - `isPresetAmount` boolean, required — Represents whether the item amount is taken from a preset list, e.g. 25, 50, 100, etc. or whether it was a different amount, e.g. 27 - TravelCartItem — Represents a travel booking item in a shopping cart - `itemClass` 'travel', required — Denotes the cart item class. The item schema is chosen based on this value. Allowed value: travel Example: travel - `id` string — The cart items's unique ID Example: 5de33332-546a-4171-8988-2a43d2bfe9c6 - `rawProductData` AnyObject - `example` string - `sellingPrice` CurrencyAmount, required — Common currency amount structure - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `listPrice` CurrencyAmount — Common currency amount structure - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `recipientInfo` RecipientInfo - `accountId` string — The ID of the account that will receive the purchased goods - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `gender` string — Gender Example: female - `lastName` string — Last name Example: Lois - `message` string — The message that the recipient will receive - `phoneInfo` PhoneInfo — Phone information structure - … - `shippingAddress` CartItemAddress — Address structure - … - `wallet` RecipientInfoWallet — The crypto wallet that will receive the funds - … - `lodging` TravelLodging, required — The lodging details of the travel booking - `reservationId` string, required — Hotel reservation id Example: X36Q9C - `nights` number, double, required — The number of nights booked in the reservation Min value: 1 Example: 2 - `checkInDate` string, required — The check-in date Example: 2022-05-02 - `checkInHour` string, required — The hour of day in which the check-in is done Example: 18 Pattern: ^([01][0-9]|2[0-3])$ - `hotel` TravelLodgingHotel, required — The booked hotel details - … - `wereExtrasPurchased` boolean, required — Indicates whether extras were purchased in the reservation - `isRefundable` boolean, required — Indicates whether the reservation is refundable - `highestRoomType` string, required — The most luxurious room booked in the reservation Example: Presidential Suite - `numberOfRooms` number, double, required — The number of rooms booked in the reservation Min value: 1 Example: 2 - `numberOfGuests` number, double, required — The number of guests in the reservation Min value: 1 Example: 4 - `numberOfKids` number, double, required — The number of kids, out of the number of guests in the reservation Min value: 0 Example: 2 - `pnr` string, required — The flight ticket's PNR code Example: X36Q9C - `trip` TravelTrip, required — The trip details of the travel booking - `numberOfFlights` number, double, required — The number of flights in the trip Min value: 1 Example: 2 - `numberOfCheckedBags` number, double, required — The number of checked bags Min value: 0 Example: 1 - `firstWayDestination` string, required — The first-way destination's three-letter IATA airport code Example: JFK Pattern: ^[A-Z]{3}$ - `isRoundTrip` boolean, required — `true` if the trip is a round-trip Example: true - `highestClass` 'economy' | 'luxurious', required — `luxurious` if the highest bought travel class in the trip is a luxury class (business/first), `economy` otherwise Example: luxurious - `isFlexibleTicket` boolean, required — True if the trip ticket is a flexible ticket Example: true - `wereExtrasPurchased` boolean, required — True if extras were included in the trip purchase Example: true - `firstFlight` TravelFirstFlight, required — The first flight details of the trip - `numberOfTravelers` number, double, required — The number of travelers in the first flight Min value: 1 Example: 2 - `departureTime` number, double, required — The timestamp of the departure, in *milliseconds* since the unix epoch Example: 1551398400000 - `departureAirport` string, required — The first-flight departure airport's three-letter IATA code Example: JFK Pattern: ^[A-Z]{3}$ - `duration` number, double, required — The first-flight duration, in hours Min value: 0 Example: 3.5 - `flightNumber` string, required — The alphanumeric flight code Example: BA2491A Pattern: ^[A-Z0-9]+$ - FlightTicketCartItem — Represents a flight ticket item in a shopping cart - `itemClass` 'flightTicket', required — Denotes the cart item class. The item schema is chosen based on this value. Allowed value: flightTicket Example: flightTicket - `id` string — The cart items's unique ID Example: 5de33332-546a-4171-8988-2a43d2bfe9c6 - `rawProductData` AnyObject - `example` string - `sellingPrice` CurrencyAmount, required — Common currency amount structure - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `listPrice` CurrencyAmount — Common currency amount structure - `valueInCurrency` number, double, required — The amount in the currency, which is specified in the `currency` property Example: 90 - `currency` string, required — Currency specified as a three letter code according to ISO 4217 Example: USD - `recipientInfo` RecipientInfo - `accountId` string — The ID of the account that will receive the purchased goods - `dob` string — Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY Pattern: ^\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$ - `email` string, nullable — Email Example: lois.lane@dailyplanet.com - `firstName` string — First name Example: Lois - `gender` string — Gender Example: female - … truncated; see the full OpenAPI document linked below --- [API](https://skmtc.net/coinflow/apis/api-reference.md) · [All operations](https://skmtc.net/coinflow/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coinflow/api-reference/versions/3f6a046fbb34/schema)