{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/auth":{"get":{"operationId":"get-message","summary":"Get Message","description":"Get the message for the user's wallet to sign.","tags":["authentication"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageToSignResponse"}}}}}}},"/auth/session-key":{"get":{"operationId":"get-session-key","summary":"Get Session Key","description":"Get an authentication session key","tags":["authentication"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSessionKeyResponse"}}}}}}},"/auth/verify":{"get":{"operationId":"verify-token","summary":"Verify Token","description":"Verify a token is valid and is not expired","tags":["authentication"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/tokenize/associate-cvv":{"post":{"operationId":"associate-cvv","summary":"Associate CVV","description":"Tokenize Card PAN & Optionally CVV in a server to server integration.\n\nIn order to gain access to this endpoint your company must have PCI-DSS\ncertification, and provide that to your Coinflow Integrations Representative.","tags":["cardTokenization"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"tx-token-scheme","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. Contact your Coinflow integrations representative if you are unsure whether this applies to you.","required":false,"schema":{"$ref":"#/components/schemas/TokenizeAssociateCvvPostParametersTxTokenScheme"}},{"name":"tx-tokenex-id","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. If it applies to you, pass 4582952996979143 in the Sandbox Environment and 2781185452603874 in Production.","required":false,"schema":{"type":"string"}},{"name":"tx-apikey","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. If it applies to you, contact your Coinflow integrations representative to receive this value.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerToServerTokenizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerToServerAssociatedCvvRequest"}}}}}},"/tokenize/extract-card":{"post":{"operationId":"extract-card","summary":"Extract Card From Image","description":"Extract the card details from a photo of a physical card and tokenize them.\n\nThis allows a customer to take a photo of their credit/debit card and have\nthe card details auto-populated during checkout instead of typing them in\nmanually. The card is extracted and stored as a token in Coinflow's\nPCI-compliant vault, and the resulting token is returned so it can be used\nin the cards endpoint.\n\nIn order to gain access to this endpoint your company must have PCI-DSS\ncertification, and provide that to your Coinflow Integrations Representative.","tags":["cardTokenization"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractCardResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractCardRequest"}}}}}},"/tokenize":{"post":{"operationId":"tokenize","summary":"Tokenize Card and CVV","description":"Tokenize Card PAN & Optionally CVV in a server to server integration.\n\nIn order to gain access to this endpoint your company must have PCI-DSS\ncertification, and provide that to your Coinflow Integrations Representative.","tags":["cardTokenization"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"tx-token-scheme","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. Contact your Coinflow integrations representative if you are unsure whether this applies to you.","required":false,"schema":{"$ref":"#/components/schemas/TokenizePostParametersTxTokenScheme"}},{"name":"tx-tokenex-id","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. If it applies to you, pass 4582952996979143 in the Sandbox Environment and 2781185452603874 in Production.","required":false,"schema":{"type":"string"}},{"name":"tx-apikey","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. If it applies to you, contact your Coinflow integrations representative to receive this value.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerToServerTokenizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerToServerTokenizationRequest"}}}}}},"/tokenize/card-only":{"post":{"operationId":"card-only","summary":"Tokenize Card Only","description":"Tokenize Card PAN without CVV in a server to server integration.\n\nIn order to gain access to this endpoint your company must have PCI-DSS\ncertification, and provide that to your Coinflow Integrations Representative.","tags":["cardTokenization"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"tx-token-scheme","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. Contact your Coinflow integrations representative if you are unsure whether this applies to you.","required":false,"schema":{"$ref":"#/components/schemas/TokenizeCardOnlyPostParametersTxTokenScheme"}},{"name":"tx-tokenex-id","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. If it applies to you, pass 4582952996979143 in the Sandbox Environment and 2781185452603874 in Production.","required":false,"schema":{"type":"string"}},{"name":"tx-apikey","in":"header","description":"Only required if your account is configured with a tokenization provider that uses this header — most merchants should omit it. If it applies to you, contact your Coinflow integrations representative to receive this value.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerToServerTokenizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerToServerCardOnlyRequest"}}}}}},"/checkout/ach-authorization/{authorizationId}/status":{"put":{"operationId":"set-ach-authorization-status","summary":"ACH Authorization Status Event","description":"Accepts a lifecycle status event (e.g. archived, fully filled) for a\npreviously created ACH authorization.","tags":["checkout"],"parameters":[{"name":"authorizationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchAuthorizationStatusEventRequest"}}}}}},"/checkout/ach/{merchantId}":{"post":{"operationId":"ach-checkout","summary":"ACH Checkout","description":"Processes a checkout via ACH.","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"428":{"description":"User must re-verify account","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchCheckoutArgs"}}}}}},"/checkout/apa/{merchantId}":{"post":{"operationId":"apa-checkout","summary":"APA Checkout","description":"Initiates the checkout for an APA Payment","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_ApaCheckout_Response_200"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApaCheckoutArgs"}}}}}},"/checkout/v2/apple-pay/{merchantId}":{"post":{"operationId":"apple-pay","summary":"Apple Pay Checkout","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"402":{"description":"ApplePay unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePayCheckoutArgs"}}}}}},"/checkout/apple-pay/validatemerchant":{"get":{"operationId":"validate-merchant","summary":"Apple Pay Validate Merchant","tags":["checkout"],"parameters":[{"name":"domainName","in":"query","description":"- Top level domain that the Apple Pay Button is associated with","required":true,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"The merchant ID associated with this request, required\nif you are utilizing custom certificates\n- The Merchant ID of the Merchant","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/checkout/capture":{"post":{"operationId":"capture-payment","summary":"Capture Payment","description":"If a payment has been created with authOnly=true, capture it using this endpoint.","tags":["checkout"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_CapturePayment_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePaymentRequest"}}}}}},"/checkout/card/{merchantId}":{"post":{"operationId":"card-checkout","summary":"Card Checkout","description":"Processes a checkout via credit card information, will tokenize and save the card for reuse by the customer in the future.","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCheckoutArgs"}}}}}},"/checkout/card-on-file-authorized":{"post":{"operationId":"card-on-file-authorized","summary":"Card on File Authorized","description":"Checks if a user is authorized for card on file transactions with this card.\n\nIt is recommended to call this endpoint to confirm card on file transactions can be performed with a card before attempting any session (such as an auction) involving card on file transactions.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_CardOnFileAuthorized_Response_200"}}}},"403":{"description":"Card on file not enabled","content":{"application/json":{"schema":{"description":"Any type"}}}},"410":{"description":"Validation for this card has expired. Revalidate the CVV for this card, and make a new purchase using the /api/checkout/card/token in order to begin using this endpoint again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevalidateCVVFields"}}}},"412":{"description":"3DS Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]}}}}}},"/checkout/card-on-file":{"post":{"operationId":"card-on-file-checkout","summary":"Card On File Checkout","description":"Processes a Card On File Transaction using a saved card from a previous Customer Initiated Transaction (CIT).\n\nThis endpoint can only be used if the customer is actively involved\nin the purchase flow and has explicitly granted their authorization\nto charge their card.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"403":{"description":"Card on file not enabled","content":{"application/json":{"schema":{"description":"Any type"}}}},"410":{"description":"Validation for this card has expired. Revalidate the CVV for this card, and make a new purchase using the /api/checkout/card/token in order to begin using this endpoint again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevalidateCVVFields"}}}},"412":{"description":"3DS Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardOnFileCheckoutArgs"}}}}}},"/checkout/cashapp/{merchantId}":{"post":{"operationId":"cash-app-checkout","summary":"Cash App Checkout","description":"Initiates the checkout for a Cash App Payment","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_CashAppCheckout_Response_200"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashAppCheckoutArgs"}}}}}},"/checkout/ach-authorization":{"post":{"operationId":"create-ach-authorization","summary":"Create ACH Authorization","description":"Creates an ACH authorization record *before* the payment it will back.\nCallable either as the authenticated customer (SDK/iframe flow — the\ncustomer is resolved from the session, `customerId` in the body is\nignored) or as merchant-admin/admin (direct-API integrators — the\nbody's `customerId` is required and reconciled server-side). Pass the\nreturned record's `_id` as `achAuthorizationId` on the ACH checkout\ncall this authorization backs.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IAchAuthorization_string_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAchAuthorizationRequest"}}}}}},"/checkout/pix":{"post":{"operationId":"create-pix-payment","summary":"Create Pix Payment","description":"Initiates a Pix payment order. Returns a BR code used to pay the order. Must be paid before the returned expiration date (5 minutes).","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixCheckoutResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixCheckoutArgs"}}}}}},"/checkout/crypto":{"post":{"operationId":"crypto-checkout-headless","summary":"Crypto Payin","description":"Initiates a payment where the customer is paying with Crypto","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeadlessCheckoutSession"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoHeadlessCheckoutArgs"}}}}},"get":{"operationId":"get-supported-chains-and-tokens-for-merchant","summary":"Get supported chains and tokens","description":"Get the supported chains and tokens for crypto payin w/ merchant settings","tags":["checkout"],"parameters":[{"name":"subtotalCents","in":"query","description":"- (Optional) - include parameter to receive quoted fee in response","required":false,"schema":{"type":"number","format":"double"}},{"name":"subtotalCurrency","in":"query","description":"- (Optional) - include parameter if subtotal is not USD","required":false,"schema":{"$ref":"#/components/schemas/Currency"}},{"name":"tier","in":"query","description":"- (Optional) - filter tokens by fee tier","required":false,"schema":{"$ref":"#/components/schemas/CryptoTier"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedChainTokenCombos"}}}}}}},"/checkout/jwt-token":{"post":{"operationId":"get-checkout-jwt-token","summary":"Get Checkout Jwt Token","description":"Gets a Checkout Jwt Token for a purchase\n\nCheckout JWT tokens ensure:\n1. The arguments of the purchase cannot be manipulated\n2. The checkout JWT is only valid for a single purchase\n3. The arguments of the purchase are encrypted to be hidden from the user\n (webhook info, chargebackProtectionData, etc...)","tags":["checkout"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_GetCheckoutJwtToken_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCheckoutLinkArgs"}}}}}},"/checkout/link":{"post":{"operationId":"get-checkout-link","summary":"Get Checkout Link","description":"Gets a checkout link for the UserID that can be embedded in vanilla iframe\nor the user can be redirected to","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-submerchant-id","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_GetCheckoutLink_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCheckoutLinkArgs"}}}}}},"/checkout/destination-auth-key":{"post":{"operationId":"get-destination-auth-key","summary":"Get Destination Auth Key","description":"If your merchant account is settling USDC to an account OTHER than\nthe one defined in your settlement settings, you can utilize this\nendpoint to get a destinationAuthKey which can be passed into the\ncheckout endpoints which will settle USDC to the account which\nis passed into this endpoint.","tags":["checkout"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout_GetDestinationAuthKey_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestinationAuthKeyRequest"}}}}}},"/checkout/fees":{"post":{"operationId":"get-fees","summary":"Get Interchange Fees","description":"Gets the breakdown of possible fees\n\nIt is unlikely you will be calling this endpoint. Only call if you want to see the fee breakdown for all payment methods ex: Debit vs. Credit. If you are trying to display\nall possible fees (including gas) broken down by line item and the final total amount, call the \"Get Totals\" endpoint.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Partial_Record_PaymentMethods.FeeOption-Array-or-FeeDetail-or-CurrencyCents__"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeDetailRequest"}}}}}},"/checkout/totals/{merchantId}":{"post":{"operationId":"get-totals","summary":"Get Totals","description":"Gets the fees, quotes, and totals for a particular checkout.","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_PaymentMethods.TotalsResponseSettlement-or-undefined_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTotalsBody"}}}}}},"/checkout/evm/usdc-authorization":{"post":{"operationId":"get-usdc-authorization-message","summary":"Get USDC Authorization Message (EVM only)","description":"Gets the USDC authorization message to be signed by the customer for dual-source payments.\nThe signed message allows the customer's USDC to be used alongside credit card payment.\n\nThis is only necessary for EVM chains when using customer USDC + credit card payment.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsdcAuthorizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsdcAuthorizationBody"}}}}}},"/checkout/google-pay/{merchantId}":{"post":{"operationId":"google-pay","summary":"Google Pay Checkout","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"402":{"description":"GooglePay unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePayCheckoutArgs"}}}}}},"/checkout/interac":{"post":{"operationId":"interac-checkout","summary":"Interac e-Transfer Checkout (New Contact)","description":"Initiates an Interac e-Transfer payin with a new contact. Returns the paymentId.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteracCheckoutResponse"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewInteracCheckoutArgs"}}}}}},"/checkout/interac/token":{"post":{"operationId":"interac-token-checkout","summary":"Interac e-Transfer Checkout (Saved Contact)","description":"Initiates an Interac e-Transfer payin with a previously saved contact.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteracCheckoutResponse"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedTokenCheckoutArgs"}}}}}},"/checkout/merchant-initiated-transaction":{"post":{"operationId":"merchant-initiated-transaction","summary":"Merchant Initiated Transaction","description":"Processes a Merchant Initated Transaction using a saved card from a previous Customer Initiated Transaction (CIT) authorized for this purpose.\n\nThis endpoint can only be used if the customer has once before authorized their card to be charged on your platform.\nAn example flow would be a usage based billing paradigm. A customer would add their card and perform a zero authorization transaction which would then allow this card to be charged in subsequent merchant initiated transactions.","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"403":{"description":"Merchant Initiated Transactions not enabled","content":{"application/json":{"schema":{"description":"Any type"}}}},"410":{"description":"Validation for this card has expired. Revalidate the CVV for this card, and make a new purchase using the /api/checkout/card/token in order to begin using this endpoint again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevalidateCVVFields"}}}},"429":{"description":"Reached Max Number of Transactions In Period","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantInitiatedTransactionArgs"}}}}}},"/checkout/paypal/{merchantId}":{"post":{"operationId":"new-pay-pal-checkout","summary":"PayPal New Checkout","description":"Initiates the checkout for PayPal payment with a new account","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPayPalCheckoutArgs"}}}}}},"/checkout/paypal/token/{merchantId}":{"post":{"operationId":"saved-pay-pal-checkout","summary":"PayPal Saved Checkout","description":"Initiates the checkout for PayPal payment with a saved account","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedPayPalCheckoutArgs"}}}}}},"/checkout/paypal/vaulted/{merchantId}":{"post":{"operationId":"vaulted-pay-pal-checkout","summary":"PayPal Vaulted Checkout","description":"Initiates the checkout for PayPal payment with a vaulted account","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultedPayPalCheckoutArgs"}}}}}},"/checkout/review":{"put":{"operationId":"review-payment","summary":"Review Payment Protection","description":"If a payment has a chargeback protection status of Pending Review, select the action to be taken on the payment","tags":["checkout"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewPaymentRequest"}}}}}},"/checkout/ach-authorization/{authorizationId}/revoke":{"patch":{"operationId":"revoke-ach-authorization","summary":"Revoke ACH Authorization","description":"Revokes an ACH authorization by ID. Once revoked, no further payments\nmay be made using this authorization. Revoking an already-revoked\nauthorization succeeds as a no-op.","tags":["checkout"],"parameters":[{"name":"authorizationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/checkout/token/{merchantId}":{"post":{"operationId":"token-checkout","summary":"Saved Card Checkout","description":"Processes a checkout via tokenized card information.","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"412":{"description":"3DS Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"422":{"description":"Address Required","content":{"application/json":{"schema":{"description":"Any type"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCheckoutArgs"}}}}}},"/checkout/iban":{"post":{"operationId":"iban-checkout","summary":"Sepa/Faster Payments Checkout (New Account)","description":"Initiates a Sepa/Faster Payments payment order with a new account. Returns destination account info.\nMust be paid before the returned expiration date (5 minutes).","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbanPaymentDetails"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"426":{"description":"BIC required","content":{"application/json":{"schema":{"description":"Any type"}}}},"428":{"description":"User must re-verify account","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewIbanCheckoutArgs"}}}}}},"/checkout/iban/token":{"post":{"operationId":"iban-token-checkout","summary":"Sepa/Faster Payments Checkout (Saved Account)","description":"Initiates a Sepa/Faster Payments payment order. Returns destination account info.\nMust be paid before the returned expiration date (5 minutes).","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbanPaymentDetails"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"428":{"description":"User must re-verify account","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedTokenCheckoutArgs"}}}}}},"/checkout/wire":{"post":{"operationId":"wire-checkout","summary":"US Wire Domestic Payments Checkout (New Account)","description":"Initiates a US Domestic Wire Payments payment order with a new account. Returns destination account info.\nMust be paid before the returned expiration date (5 minutes).","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USWirePaymentDetails"}}}},"412":{"description":"Additional Account Details Are Required - Please provide the required fields in body.bankAccountDetails.wireRoutingNumber and/or body.bankAccountDetails.accountNumber","content":{"application/json":{"schema":{"description":"Any type"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"428":{"description":"User must re-verify account","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWireCheckoutArgs"}}}}}},"/checkout/wire/token":{"post":{"operationId":"wire-token-checkout","summary":"US Wire Domestic Payments Checkout (Saved Account)","description":"Initiates a US Domestic Wire Payments payment order with a saved account. Returns destination account info.\nMust be paid before the returned expiration date (5 minutes).","tags":["checkout"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USWirePaymentDetails"}}}},"412":{"description":"Additional Account Details Are Required - Please provide the required fields in body.bankAccountDetails.wireRoutingNumber and/or body.bankAccountDetails.accountNumber","content":{"application/json":{"schema":{"description":"Any type"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"428":{"description":"User must re-verify account","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedWireTokenCheckoutArgs"}}}}}},"/checkout/venmo/{merchantId}":{"post":{"operationId":"new-venmo-checkout","summary":"Venmo New Checkout","description":"Initiates the checkout for Venmo payment with a new account","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenmoCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewVenmoCheckoutArgs"}}}}}},"/checkout/venmo/token/{merchantId}":{"post":{"operationId":"saved-venmo-checkout","summary":"Venmo Saved Checkout","description":"Initiates the checkout for Venmo payment with a saved account","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenmoCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedVenmoCheckoutArgs"}}}}}},"/checkout/venmo/vaulted/{merchantId}":{"post":{"operationId":"vaulted-venmo-checkout","summary":"Venmo Vaulted Checkout","description":"Initiates the checkout for Venmo payment with a vaulted account","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenmoCheckoutResponse"}}}},"412":{"description":"Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}},"423":{"description":"Customer is Blocked","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_VerificationRequiredResponse.verification-or-verificationLink_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultedVenmoCheckoutArgs"}}}}}},"/checkout/void":{"post":{"operationId":"void-payment","summary":"Void Payment","description":"If a payment has been created with authOnly=true, void the authorization using this endpoint.","tags":["checkout"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidPaymentRequest"}}}}}},"/checkout/zero-authorization/{merchantId}":{"post":{"operationId":"zero-authorization","summary":"Zero Authorization","description":"Performs an Authorization transaction on a Card for $0.00 to be validated and stored for future use.\n\nThis endpoint can only be used if the customer is actively involved\nin the purchase flow and has explicitly granted their authorization\nto charge their card.","tags":["checkout"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCheckoutResponse"}}}},"403":{"description":"Zero Authorization not enabled","content":{"application/json":{"schema":{"description":"Any type"}}}},"410":{"description":"Validation for this card has expired. Revalidate the CVV for this card, and make a new purchase using the /api/checkout/card/token in order to begin using this endpoint again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevalidateCVVFields"}}}},"412":{"description":"3DS Challenge required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeFields"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZeroAuthorizationCheckoutArgsWithoutReason"}}}}}},"/customer/v2/bankAccount":{"post":{"operationId":"add-bank-account","summary":"Add Bank Account","description":"Adds a bank account for a given customer","tags":["customers"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pick_AddACHBankAccountData.Exclude_keyofAddACHBankAccountData.plaidAccountId__"}}}}}},"/customer/plaid-check":{"post":{"operationId":"plaid-check","summary":"Bank Account Status Check","description":"Checks whether a customer's linked bank account is still active and\nvalid. Returns a normalized status (`active`, `removed`, `login_required`,\nor `error`) that merchants can use to gate transaction attempts before\nsubmission.","tags":["customers"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MultiPlaidAccountStatusResponse"}}}}}},"requestBody":{"description":"- The customerId identifying the customer whose linked\naccount should be checked, and an optional bankAccountToken to identify\na specific bank account. If no token is provided, the customer's most\nrecently linked bank account will be checked.","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/CustomerPlaidCheckPostRequestBodyContentApplicationJsonSchemaAccountsItems"}}},"required":["accounts"]}}}}}},"/customer/iban":{"post":{"operationId":"add-iban","summary":"Create an Iban account","description":"Create an Iban account for a given customer","tags":["customers"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"merchantId":{"type":"string"},"data":{"$ref":"#/components/schemas/IbanData"}},"required":["merchantId","data"]}}}}}},"/customer/card":{"post":{"operationId":"create-card-for-customer","summary":"Create Card for Customer","description":"Create card for a particular customer","tags":["customers"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/CardData"}},"required":["card"]}}}}}},"/customer":{"post":{"operationId":"create-customer","summary":"Create Customer","description":"Creates a customer","tags":["customers"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"email":{"type":"string"}},"required":["email"]}}}}}},"/customer/bankAccount/{token}":{"delete":{"operationId":"delete-bank-account","summary":"Delete Bank Account","description":"Deletes a bank account for a given customer","tags":["customers"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/customer/card/{cardToken}":{"delete":{"operationId":"delete-card","summary":"Delete Card","description":"Deletes the card for a particular customer","tags":["customers"],"parameters":[{"name":"cardToken","in":"path","description":"- Token of the card to delete","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/customer/iban/{token}":{"delete":{"operationId":"delete-iban","summary":"Delete Iban Account","description":"Deletes an Iban account for a given customer","tags":["customers"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/customer/interac/{token}":{"delete":{"operationId":"delete-interac","summary":"Delete Interac Account","description":"Deletes an Interac account for a given customer","tags":["customers"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/customer/paypal/{token}":{"delete":{"operationId":"delete-paypal","summary":"Delete PayPal Account","description":"Deletes a saved PayPal account for a given customer","tags":["customers"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/customer/venmo/{token}":{"delete":{"operationId":"delete-venmo","summary":"Delete Venmo Account","description":"Deletes a saved Venmo account for a given customer","tags":["customers"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/customer/balances/{merchantIdOrCreditSeed}":{"get":{"operationId":"get-checkout-balances","summary":"Get Balances","description":"Gets the balances of credits, usdc, and an optional token for a particular wallet","tags":["customers"],"parameters":[{"name":"merchantIdOrCreditSeed","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerBalances"}}}}}}},"/customer/v2":{"get":{"operationId":"get-customer","summary":"Get Customer","description":"Gets the Customer record for a particular user.","tags":["customers"],"parameters":[{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerResponse"}}}},"412":{"description":"No customer associated with customerId, will also return this code if the customer exists, but they have no payment methods are available.","content":{"application/json":{"schema":{"type":"number","format":"double"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}}}},"/customer/history":{"get":{"operationId":"get-history","summary":"Get Purchase History","description":"Gets the Purchase History for a particular Customer","tags":["customers"],"parameters":[{"name":"paymentId","in":"query","description":"- Optional payment id to filter the request by","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_GetHistory_Response_200"}}}}}}},"/customer/history/{paymentId}":{"get":{"operationId":"get-customer-payment-by-id","summary":"Get Purchase History By ID","description":"Gets the Purchase for a Customer by ID","tags":["customers"],"parameters":[{"name":"paymentId","in":"path","description":"- Payment id to filter the request by","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_GetCustomerPaymentById_Response_200"}}}}}}},"/events":{"post":{"operationId":"post-event","summary":"Report Event","description":"This endpoint is for reporting Chargeback Protection Events throughout your customer's application lifecycle.\n\nThe goal of this endpoint is for reporting events to the chargeback protection system to that it\ncan evaluate timing and take note of significant events which will occur in a user's lifecycle. The end goal of\ncollecting this information is to increase approval rates (lower false positives) and reduce fraud and chargebacks\n(lower false negatives). When calling these API's it is highly encouraged to pass as much information as possible.\nThe more information provided, the better the outcomes will be.\n\nImplementing this API will help to increase your revenue via higher approval rates, while reducing your account's risk of becoming flagged\nby one of the card brands for excessive chargebacks.","tags":["events"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventData"}}}}}},"/seller/usdc-withdraw/recipient":{"post":{"operationId":"add-usdc-withdraw-recipient","summary":"Adds a USDC recipient.","description":"Registers a solana address that can receive USDC from the merchant’s Coinflow wallet balance","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"description":"- The recipient's solana wallet address","content":{"application/json":{"schema":{"type":"object","properties":{"recipient":{"type":"string"}},"required":["recipient"]}}}}},"delete":{"operationId":"remove-usdc-withdraw-recipient","summary":"Removes a USDC recipient.","description":"Removes a solana address from the merchant's allowlisted USDC recipients","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"description":"- The recipient's solana wallet address","content":{"application/json":{"schema":{"type":"object","properties":{"recipient":{"type":"string"}},"required":["recipient"]}}}}}},"/seller":{"post":{"operationId":"create-seller","summary":"Create Seller","description":"Given the verification information, register a seller to a marketplace.\n\nWhen the seller must complete additional verification the API responds\nwith a 451 containing a `verificationLink`. Send the seller there; once\nthey finish, they are returned to `body.redirectUrl` when supplied, and\notherwise to the marketplace's Coinflow seller login page.","tags":["marketplace"],"responses":{"200":{"description":"Successful response"},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellerRequest"}}}}}},"/seller/usdc-withdraw":{"post":{"operationId":"seller-usdc-withdraw","summary":"Creates a USDC withdrawal transaction for a merchant using the Coinflow wallet","description":"Creates a usdc withdrawal transaction for merchants using Coinflow wallet- so they can withdraw usdc from their wallet.","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerUsdcWithdrawResponse"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerUsdcWithdrawRequest"}}}}}},"/marketplace/kyc/download/{verificationId}":{"get":{"operationId":"download-kyc","summary":"Download Seller KYC verification report.","tags":["marketplace"],"parameters":[{"name":"verificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/marketplace/link/purchase":{"post":{"operationId":"get-purchase-link","summary":"Get Purchase Link","description":"Get a link which the marketplace can redirect or present via iframe to the\ncustomer for them to complete a purchase with a seller.","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceLinkResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplacePurchaseLinkRequest"}}}}}},"/marketplace/link/purchase/credits":{"post":{"operationId":"get-purchase-with-credits-link","summary":"Get Purchase with Credits link","description":"Get a link for a user to make a marketplace purchase with their Credits Balance","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceLinkResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"checkoutJwtToken":{"type":"string"},"email":{"type":"string"}},"required":["checkoutJwtToken"]}}}}}},"/marketplace/link/seller/login":{"post":{"operationId":"get-seller-login-link","summary":"Get Seller Login Link","description":"Get a link which the marketplace can redirect sellers to login to\ntheir dashboards and view purchases and withdraw their money.","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceLinkResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Marketplace_GetSellerLoginLink_Request"}}}}}},"/marketplace/link/seller/registration":{"post":{"operationId":"get-seller-register-link","summary":"Get Seller Registration Link","description":"Get a link which the marketplace can redirect new sellers to register\ntheir accounts.","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceLinkResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceSellerRegistrationLinkRequest"}}}}}},"/seller/verifyTransaction":{"get":{"operationId":"get-verify-transaction","summary":"Get Seller Verification Transaction","description":"Returns a verification transaction so the seller needs to sign and send with their MPC wlalet.\nThe transaction verifies that they have access to the authentication method tied to the MPC wallet which is linked\nto their Coinflow Account.","tags":["marketplace"],"parameters":[{"name":"parentId","in":"query","description":"- The parent merchant ID (can be merchantId or _id)","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/marketplace/link/subscription":{"post":{"operationId":"get-subscribe-link","summary":"Get Subscription Link","description":"Get a link which the marketplace can redirect or present via iframe to the\ncustomer for them to subscribe to a particular seller's subscription.","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceLinkResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketplaceSubscribeLinkRequest"}}}}}},"/marketplace/wallet":{"post":{"operationId":"get-wallet-address-by-email","summary":"Get wallet by email","description":"Given an email address returns the MPC wallet address for the user. Can\nbe used to pass into the SDK, query the API, and check balances.","tags":["marketplace"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Marketplace_GetWalletAddressByEmail_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}}}},"/merchant/chargebacks/{paymentId}/accept":{"post":{"operationId":"accept-chargeback","summary":"Accept chargeback","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_AcceptChargeback_Response_200"}}}}}}},"/withdraw/crypto-deposit-address/activate":{"post":{"operationId":"activate-passive-deposit-address","summary":"Activate Passive Deposit Address","description":"Activate a passive deposit address so it accepts new payments. If a deposit\naddress already exists for this merchant + withdrawer + chain + token, that\naddress is re-activated and returned. Otherwise a new session is created\nand its address is activated.","tags":["merchant"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassiveDepositAddressStatusResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCryptoWithdrawBody"}}}}}},"/merchant/block-seller":{"put":{"operationId":"block-marketplace-seller","summary":"Bans a seller","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSellerRequest"}}}}}},"/merchant/payments/refunds/batch":{"put":{"operationId":"batch-refund-payments","summary":"Batch Refund Payments","description":"Queues a full refund for each of the given payments. Every payment is refunded\nindependently - one refund job per payment, identical to refunding them one at a\ntime - so a payment that cannot be refunded is reported in `results` while the rest\nstill proceed.\n\nPartial amounts are not supported here, and payments needing a destination wallet\nare skipped with `skipped: true` on their result. Refund those payments\nindividually with `PUT /merchant/payments/{paymentId}/refund`.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRefundResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRefundRequest"}}}}}},"/merchant/blocked/{customerId}":{"put":{"operationId":"unblock-account","summary":"Block or Unblock Customer","tags":["merchant"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"merchantId":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/AvailabilityStatus"}},"required":["reason"]}}}}}},"/merchant/block-withdrawer/{withdrawerId}":{"put":{"operationId":"block-or-unblock-withdrawer","summary":"Block or Unblock Withdrawer","tags":["merchant"],"parameters":[{"name":"withdrawerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"blockchain":{"$ref":"#/components/schemas/Blockchain"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/AvailabilityStatus"}},"required":["reason","status"]}}}}}},"/merchant/{customerId}/exempt3DS":{"put":{"operationId":"update-3-ds-exemption","summary":"Configure 3DS exemption","description":"Change customer 3DS exemption status","tags":["merchant"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"merchantId":{"type":"string"},"exempt":{"type":"boolean"}},"required":["exempt"]}}}}}},"/merchant/{customerId}/attemptLimit":{"put":{"operationId":"update-attempt-limit-setting","summary":"Configure attempt limit setting","description":"Change customer attempt limit setting","tags":["merchant"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"merchantId":{"type":"string"},"setting":{"$ref":"#/components/schemas/FailedAttemptSetting"}},"required":["setting"]}}}}}},"/merchant/chargebacks/{paymentId}/respond":{"post":{"operationId":"respond","summary":"Create Chargeback Response","description":"Respond to a chargeback. This will send the response to the card network.","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_Respond_Request"}}}}}},"/withdraw/crypto-deposit-address":{"post":{"operationId":"create-crypto-withdraw-deposit","summary":"Create Crypto Withdraw Deposit","description":"Create a crypto deposit session for a payout. Returns a deposit address where\nthe merchant can send funds. Once funds are received via the deposit webhook,\nthe payout is automatically initiated.","tags":["merchant"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoWithdrawDepositResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCryptoWithdrawBody"}}}}},"get":{"operationId":"get-supported-chains","summary":"Get Supported Chains","description":"Get the list of supported chains and tokens for crypto deposit withdrawals.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSupportedChainsResponse"}}}}}}},"/merchant/exports":{"post":{"operationId":"create-export","summary":"Create Export","description":"Create a new export job","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IExport"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExportRequest"}}}}},"get":{"operationId":"list-exports","summary":"List Exports","description":"List all exports for the merchant","tags":["merchant"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IExport"}}}}}}}},"/withdraw/crypto-deposit-address/deactivate":{"post":{"operationId":"deactivate-passive-deposit-address","summary":"Deactivate Passive Deposit Address","description":"Deactivate (pause) a passive deposit address so it stops accepting new payments.","tags":["merchant"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassiveDepositAddressStatusResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassiveDepositAddressBody"}}}}}},"/merchant/exports/{exportId}":{"delete":{"operationId":"delete-export","summary":"Delete Export","description":"Delete an export","tags":["merchant"],"parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}},"get":{"operationId":"get-export","summary":"Get Export","description":"Get a specific export by ID","tags":["merchant"],"parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IExport"}}}}}}},"/merchant":{"put":{"operationId":"edit-merchant","summary":"Edit Merchant","description":"Edit the merchant details","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMerchant_string_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"supportEmail":{"type":"string"},"customerDefaultOverrideLimit":{"$ref":"#/components/schemas/Cents"},"fraudEmails":{"type":"array","items":{"type":"string"}},"chargebackEmails":{"type":"array","items":{"type":"string"}},"billingEmails":{"type":"array","items":{"type":"string"}},"settlementAddresses":{"$ref":"#/components/schemas/MerchantPutRequestBodyContentApplicationJsonSchemaSettlementAddresses"},"brand":{"$ref":"#/components/schemas/MerchantBrandSettings"},"enforceJwt":{"type":"boolean"},"cryptoPayinSettings":{"$ref":"#/components/schemas/Pick_CryptoPayInSettings.customerEmailNotifications-or-merchantEmailNotifications_"},"achSettings":{"$ref":"#/components/schemas/Pick_ACHSettings.customerEmailNotifications-or-merchantEmailNotifications_"},"cardSettings":{"$ref":"#/components/schemas/Pick_CardSettings.customerEmailNotifications-or-merchantEmailNotifications_"},"webhookSettings":{"$ref":"#/components/schemas/Pick_WebhookSettings.Exclude_keyofWebhookSettings.webhookUrls__"},"colors":{"$ref":"#/components/schemas/MerchantTheme"},"password":{"type":"string"}}}}}}},"get":{"operationId":"get-merchant","summary":"Get Merchant","description":"Get the merchant","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMerchant_string_"}}}}},"deprecated":true}},"/merchant/payments/{paymentId}/fail":{"put":{"operationId":"fail-payment","summary":"Fail Payment","description":"-- This method is for test environment only --\nForce an ACH, Wire, Iban, CashApp or PIX payment to fail","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/merchant/chargebacks/ach-return-rate":{"get":{"operationId":"get-ach-return-rate","summary":"Get ACH return rate","tags":["merchant"],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","required":false,"schema":{"type":"string"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchReturnRate"}}}}}}},"/merchant/chargebacks":{"get":{"operationId":"get-all-chargebacks","summary":"Get all chargebacks","tags":["merchant"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"page","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"responded","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"discrepancy","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"processor","in":"query","required":false,"schema":{"type":"string"}},{"name":"protection","in":"query","required":false,"schema":{"type":"string"}},{"name":"threeDSecure","in":"query","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"since","in":"query","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","required":false,"schema":{"type":"string"}},{"name":"reasonCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"method","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludeMethod","in":"query","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllChargebackResponse"}}}}}}}},"/merchant/payments":{"get":{"operationId":"get-all-payments","summary":"Get All Payments","tags":["merchant"],"parameters":[{"name":"since","in":"query","description":"- UTC epoch milliseconds of the earliest date to include in the results","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","description":"- UTC epoch milliseconds of the latest date to include in the results","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"- Page number to return starting from 1. Must be used with limit param.","required":false,"schema":{"type":"number","format":"double"}},{"name":"limit","in":"query","description":"- amount of records per page (def. 100). Must be used with page param.","required":false,"schema":{"type":"number","format":"double"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MerchantPaymentsGetParametersSortBy"}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"method","in":"query","required":false,"schema":{"type":"string"}},{"name":"protection","in":"query","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","required":false,"schema":{"type":"string"}},{"name":"authCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPayment"}}}}}}}},"/merchant/chargebacks/analytics/summary":{"get":{"operationId":"get-chargeback-analytics-summary","summary":"Get chargeback analytics summary for time frame","tags":["merchant"],"parameters":[{"name":"since","in":"query","description":"-- YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","description":"-- YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"-- IANA timezone the since/until dates and day buckets are interpreted in (defaults to UTC)","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackAnalyticsSummary"}}}}}}},"/merchant/chargebacks/{paymentId}":{"get":{"operationId":"get-chargeback","summary":"Get chargeback data","description":"Get information about a Chargeback for a payment","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_GetChargeback_Response_200"}}}}}}},"/merchant/chargebacks/{paymentId}/draft":{"get":{"operationId":"get-chargeback-response-draft","summary":"Get Chargeback Response Draft","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"operationId":"save-draft-and-notes","summary":"Save Chargeback Response Draft","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"type":"string"},"draft":{"type":"string"}}}}}}}},"/merchant/withdraws/payout/balance":{"get":{"operationId":"get-payout-balance","summary":"Get Coinflow Wallet Balance","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_GetPayoutBalance_Response_200"}}}}}}},"/merchant/withdraws/payout/crypto/tokens":{"get":{"operationId":"get-crypto-payout-tokens","summary":"Get Crypto Payout Tokens","description":"List the chains and tokens available as crypto payout destinations for\nthis merchant. The returned `chainId` and `tokenId` are the values to\npass as the payout destination's `chain` and `token` — use this endpoint\nto populate destination pickers rather than hardcoding ids. Only tokens\nwhose tier is enabled on the merchant account are listed.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoPayoutTokensResponse"}}}}}}},"/merchant/customers":{"get":{"operationId":"get-customer-accounts","summary":"Get customer list","description":"List customers for a merchant","tags":["merchant"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"page","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"blocked","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MerchantCustomersGetParametersSortBy"}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"protection","in":"query","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ICustomerWallet"}}}}}}}},"/merchant/withdraws/payout/delegated/quote/crypto":{"post":{"operationId":"get-delegated-crypto-payout-quote","summary":"Get Delegated Crypto Payout Quote","description":"Get a quote for a delegated crypto payout: the total amount that will be\ndebited from the merchant's wallet, the configured Coinflow fee, the USD\nvalue the user receives, and the amount of the destination token that\nwill be delivered. Non-stablecoin tokens are quoted at the current\nmarket rate and are not guaranteed — the delivered amount is finalized\nwhen the payout is processed.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelegatedCryptoPayoutQuote"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelegatedCryptoPayoutQuoteArgs"}}}}}},"/merchant/withdraws/payout/delegated/quote":{"post":{"operationId":"get-delegated-payout-quote","summary":"Get Delegated Payout Quote","description":"Get a quote for a delegated payout including the fee breakdown.\nShows the total amount that will be debited from the merchant's wallet,\nthe amount the user will receive, and the merchant fees.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelegatedPayoutQuote"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelegatedPayoutQuoteArgs"}}}}}},"/merchant/payments/enhanced/{paymentId}":{"get":{"operationId":"get-enhanced-tx-information","summary":"Get Enhanced Transaction Information","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_GetEnhancedTxInformation_Response_200"}}}}}}},"/merchant/exports/{exportId}/download":{"get":{"operationId":"get-export-download-url","summary":"Get Export Download URL","description":"Get a signed download URL for a completed export","tags":["merchant"],"parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportDownloadResponse"}}}}}}},"/merchant/credits/status/{jobId}":{"get":{"operationId":"get-job-status","summary":"Get Job Status","description":"Get the status of a mint or burn job","tags":["merchant"],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"description":"Any type"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatusResponse"}}}}}}},"/merchant/v2":{"get":{"operationId":"get-merchant-v-2","summary":"Get Merchant","description":"Get the merchant","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_GetMerchantV2_Response_200"}}}}}}},"/merchant/payments/{paymentId}":{"get":{"operationId":"get-payment-by-id","summary":"Get Payment By ID","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","description":"- ID of the payment to retrieve","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPayment"}}}}}}},"/merchant/webhooks":{"get":{"operationId":"get-all-webhooks","summary":"Get Payment Webhook Activity","tags":["merchant"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"responseCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Search by numeric responseCode","required":false,"schema":{"type":"string"}},{"name":"eventType","in":"query","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Filter by sentAt >= startDate (ISO 8601)","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"Filter by sentAt <= endDate (ISO 8601)","required":false,"schema":{"type":"string"}},{"name":"transactionId","in":"query","description":"Search by transaction Id","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter by delivery status ('success' for responseCode < 400, 'failure' for responseCode >= 400)","required":false,"schema":{"$ref":"#/components/schemas/WebhookStatus"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDisplay"}}}}}}}},"/merchant/payments/ach-returns":{"get":{"operationId":"get-ach-returns","summary":"Get Returned ACH Payments","tags":["merchant"],"parameters":[{"name":"since","in":"query","description":"- UTC ISO String of the earliest date to include in the results","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","description":"- UTC ISO String of the latest date to include in the results","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"- Number of results to return per page (MAX 1000)","required":false,"schema":{"type":"number","format":"double"}},{"name":"page","in":"query","description":"- Page number to return","required":false,"schema":{"type":"number","format":"double"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MerchantPaymentsAchReturnsGetParametersSortBy"}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"protection","in":"query","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPayment"}}}}}}}},"/merchant/submerchants":{"get":{"operationId":"get-submerchants-for-merchant","summary":"Get Submerchants under Merchant","description":"Get submerchant Ids for a merchant","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/merchant/url-whitelist-requests":{"get":{"operationId":"get-url-whitelist-requests","summary":"Get URL Whitelist Requests","description":"Get all whitelist requests for the current merchant","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_GetUrlWhitelistRequests_Response_200"}}}}}}},"/merchant/withdraws/{withdrawalId}":{"get":{"operationId":"get-withdrawal","summary":"Get Withdrawal","description":"Get a specific withdrawal associated with the merchant\n  The withdrawal can be specified by transfer id or transaction","tags":["merchant"],"parameters":[{"name":"withdrawalId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_GetWithdrawal_Response_200"}}}},"404":{"description":"Withdrawal not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/merchant/withdraws":{"get":{"operationId":"get-all-withdraws","summary":"Get Withdraws","description":"Get All Withdraws associated with the merchant","tags":["merchant"],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MerchantWithdrawsGetParametersSortBy"}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"speed","in":"query","required":false,"schema":{"type":"string"}},{"name":"provider","in":"query","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"bankSettlementsOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatus"}}}}}}}},"/merchant/withdrawers":{"get":{"operationId":"get-withdrawers","summary":"Gets merchant withdrawers","tags":["merchant"],"parameters":[{"name":"blocked","in":"query","description":"Filter on blocked status (boolean string - 'true' or 'false')","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Search term to filter results","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IWithdrawer"}}}}}}}},"/withdraw/crypto-deposit-address/passive":{"get":{"operationId":"list-passive-deposit-addresses","summary":"List Passive Deposit Addresses","description":"List passive deposit addresses (active and paused) belonging to the\nauthenticated merchant + withdrawer. Sessions that were never activated\nas passive are excluded.","tags":["merchant"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassiveDepositAddressListResponse"}}}}}}},"/merchant/credits/mint":{"post":{"operationId":"mint-credits","summary":"Mint Credits","description":"Mint Credits from your Merchant's Coinflow USDC wallet to a users wallet","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_MintCredits_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditOperation"}}}}}},"/merchant/{customerId}/protection":{"put":{"operationId":"override-chargeback-protection","summary":"Override Chargeback Protection","description":"Override the chargeback protection setting to false","tags":["merchant"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"merchantId":{"type":"string"},"protectionEnabled":{"type":"boolean"}},"required":["protectionEnabled"]}}}}}},"/merchant/withdraws/payout/delegated":{"post":{"operationId":"payout-from-delegated-settlement-wallet","summary":"Payout to a user via Coinflow Wallet","description":"Payout a user from the coinflow wallet balance.\nBy default, this endpoint waits for transaction confirmation before returning.\nSet waitForConfirmation to false to return immediately after queuing the transaction.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelegatedPayoutResponse"}}}},"402":{"description":"Insufficient Funds","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"User Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutFromDelegatedSettlementWalletRequestUnavailableForLegalReasonsError"}}}},"503":{"description":"Payout encountered a temporary issue and needs to be retried, please immediately retry the request.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDelegatedArgs"}}}}}},"/merchant/withdraws/payout":{"post":{"operationId":"do-payout","summary":"Payout to a user via Merchant Self-Custodial Wallet","description":"Get a transaction which will payout a user's account upon successful sending\nof the transaction.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawTransactionResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWithdrawTransactionParams"}}}}}},"/merchant/payments/{paymentId}/refund":{"put":{"operationId":"refund-payment","summary":"Refund Payment","description":"Refunds a payment. First will check if the users wallet has credits to refund the payment. If so, will take the\ncredits from the users wallet and refund the payment. Otherwise, will transfer USDC from the merchants wallet to\nCoinflow's wallet and refund the payment.The amount of USDC transferred will the total amount of the payment +\ncredit card fees + gas fees.","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","description":"- ID of the payment to refund","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_RefundPayment_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"destinationWallet":{"type":"string"},"partialAmount":{"$ref":"#/components/schemas/Cents"},"refundReason":{"$ref":"#/components/schemas/RefundReason"}},"required":["refundReason"]}}}}}},"/merchant/program":{"post":{"operationId":"request-program-approval","summary":"Request Program Approval","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"blockchain":{"$ref":"#/components/schemas/Blockchain"},"programId":{"type":"string"}},"required":["blockchain","programId"]}}}}}},"/merchant/url-whitelist-request":{"post":{"operationId":"request-url-whitelist","summary":"Request URL Whitelisting","description":"Request to whitelist a URL for embedding the checkout form.\nThe request will be placed in a pending state for compliance review.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"},"url":{"type":"string"}},"required":["url"]}}}}}},"/merchant/webhooks/{webhookLogId}":{"post":{"operationId":"resend-webhook","summary":"Resend Payment Webhook","tags":["merchant"],"parameters":[{"name":"webhookLogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_ResendWebhook_Response_200"}}}},"403":{"description":"Not authorized to resend webhook","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Webhook not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/merchant/url-whitelist":{"delete":{"operationId":"revoke-url-whitelist","summary":"Revoke URL Whitelist","description":"Revokes a URLs whitelist for use in the checkout iframe","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}}}}},"/merchant/{customerId}/override-limit":{"put":{"operationId":"set-customer-override-limit","summary":"Set Customer Override Limit","description":"Set Customer Override Limit","tags":["merchant"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"description":"Send `customerOverrideLimit: null` to clear the per-customer\noverride and fall back to the merchant default. Sending `{cents: 0}`\npreserves the explicit \"no overrides allowed\" state.","content":{"application/json":{"schema":{"type":"object","properties":{"merchantId":{"type":"string"},"customerOverrideLimit":{"oneOf":[{"$ref":"#/components/schemas/Cents"},{"type":"null"}]}},"required":["customerOverrideLimit"]}}}}}},"/merchant/settlement-address":{"post":{"operationId":"set-settlement-address","summary":"Set Settlement Address","description":"Set the blockchain account information which will be used for settlement. Only call this if you want the money processed\nfrom credit card transactions to be sent to directly as USDC to a company owned blockchain address.","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMerchant_string_"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"}},"required":["address","blockchain"]}}}}}},"/merchant/payments/{paymentId}/settle":{"put":{"operationId":"settle-payment","summary":"Settle Payment","description":"-- This method is for test environment only --\nForce an ACH, Wire, Iban, CashApp or PIX payment to settlement","tags":["merchant"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant_SettlePayment_Response_200"}}}}}}},"/merchant/unverify-seller":{"put":{"operationId":"unverify-seller","summary":"Unverify Seller","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"},"merchantId":{"type":"string"}},"required":["reason","merchantId"]}}}}}},"/merchant/withdraws/custom-fees":{"put":{"operationId":"update-custom-withdrawal-fees","summary":"Update Custom Withdrawal Fees","description":"Update custom withdrawal fees for a merchant","tags":["merchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomWithdrawFeesConfig"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomWithdrawFeesConfig"}}}}}},"/merchant/accounts/subsidiaries":{"post":{"operationId":"create-subsidiary","summary":"Create Subsidiary","tags":["merchantAccounts"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchant Accounts_CreateSubsidiary_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}}},"get":{"operationId":"get-subsidiaries","summary":"Get Subsidiaries","tags":["merchantAccounts"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ManagedAccount"}}}}}}}},"/merchant/accounts/transfers":{"post":{"operationId":"create-transfer","summary":"Create Transfer","tags":["merchantAccounts"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedTransferRequest"}}}}}},"/merchant/accounts/primary-account":{"get":{"operationId":"get-primary-account","summary":"Get Primary Account","tags":["merchantAccounts"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedAccount"}}}}}}},"/merchant/accounts/subsidiaries/{subsidiaryId}":{"delete":{"operationId":"remove-subsidiary","summary":"Remove Subsidiary","tags":["merchantAccounts"],"parameters":[{"name":"subsidiaryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/merchant/subscription/subscribers/{subscriptionId}":{"patch":{"operationId":"cancel-subscription","summary":"Cancel Subscription (by merchant)","description":"Cancel a subscription","tags":["merchantSubscription"],"parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}},"get":{"operationId":"get-subscription-payments","summary":"Get Subscription Payments","description":"Get the payments applied to a subscription","tags":["merchantSubscription"],"parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionPayment"}}}}}}}},"/merchant/subscription/plans":{"post":{"operationId":"create-plan","summary":"Create Plans","description":"Create a new subscription plan","tags":["merchantSubscription"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPlan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPlanRequest"}}}}},"get":{"operationId":"get-plans","summary":"Get Plans","description":"Get subscription plans","tags":["merchantSubscription"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionPlan"}}}}}}}},"/merchant/subscription/plans/{planId}":{"delete":{"operationId":"deactivate-plan","summary":"Deactivate Plan","description":"Deactivate a subscription plan\nIf no subscribers, will be deleted.\nNew subscriptions will not be allowed.","tags":["merchantSubscription"],"parameters":[{"name":"planId","in":"path","description":"- can be the id or the plan code","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}},"put":{"operationId":"update-plan","summary":"Update Plan","description":"Update a subscription plan","tags":["merchantSubscription"],"parameters":[{"name":"planId","in":"path","description":"- can be the id or the plan code","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPlan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Partial_SubscriptionPlanRequest_"}}}}}},"/merchant/subscription/plans/{planId}/subscribers":{"get":{"operationId":"get-subscriptions","summary":"Get Subscribers","description":"Get the subscriptions for a subscription plan","tags":["merchantSubscription"],"parameters":[{"name":"planId","in":"path","description":"- can be the id or the plan code","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionDisplay"}}}}}}}},"/redeem/evm/creditsAuthMsg":{"post":{"operationId":"get-evm-credits-auth-msg","summary":"(EVM only) Get Credits Authorization Message","description":"Endpoint to generate an EIP-712 typed data message for authorizing credits usage on EVM chains.\n\nThis endpoint is used to retrieve a \"CreditsAuthorization\" message that the user must sign using their wallet (e.g., MetaMask)\nvia the eth_signTypedData_v4 method. The resulting signed message (permitCredits) is then supplied to the\n`/api/redeem/evm/sendGaslessTx` endpoint to execute a gasless redeem transaction.\n\n**Request Body:**\n- `merchantId` (string): The ID of the merchant requesting redemption.\n- `subtotal` (Subtotal): The transaction subtotal (either in USDC or a token-based subtotal).\n- `transactionData` (EvmTransactionData): Transaction details used for calculating gas fees and total credits required.\n\n**Response:**\nReturns an object with the following properties:\n- `message` (string): A JSON string representing the EIP-712 typed data.\n- `validBefore` (string): A timestamp or block number indicating until when the message is valid.\n- `nonce` (string): A unique value to prevent replay attacks.\n- `creditsRawAmount` (number): The raw credits amount calculated based on the transaction subtotal and estimated gas fees.","tags":["redeem"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreditsAuthMessageResponse"}}}},"412":{"description":"Wallet does not have enough credits to complete redeem request, this can happen when the network is slow. Please retry the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"description":"Request body containing the parameters required for generating the credits authorization message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEvmCreditsAuthMsgBody"}}}}}},"/redeem/evm/sendGaslessTx":{"post":{"operationId":"send-evm-credits-gasless-tx","summary":"(EVM only) Send Redeem Transaction with Credits Authorization Message","description":"Endpoint to send a credits redeem transaction on EVM-based blockchains.\n\nThis endpoint processes a gasless transaction for redeeming credits. It requires a signed permit message\n(contained in `signedMessages.permitCredits`) that was previously generated by the `/evm/creditsAuthMsg` endpoint.\n\n**How It Works:**\n- Validates that the provided signed permit (EIP-712 signature) is correct.\n- Constructs the transaction using provided details and sends it through the appropriate EVM network provider.\n\n**Request Body:**\n- `merchantId` (string): The ID of the merchant.\n- `subtotal` (Subtotal): The transaction subtotal.\n- `transactionData` (EvmTransactionData): Details of the transaction to be executed.\n- `signedMessages` (SignedMessages): Contains the signed permit message (permitCredits) for credit authorization.\n- `chargebackProtectionData?` (CartItemClassOmitted): Optional chargeback protection data.\n- `validBefore`, `nonce`, `creditsRawAmount`: Values returned by `/evm/creditsAuthMsg` for further verification.\n\n**Response:**\nReturns an object containing:\n- `hash` (string): The transaction hash of the submitted gasless transaction.","tags":["redeem"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"Optional device identifier provided in the request header.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redeem_SendEvmCreditsGaslessTx_Response_200"}}}},"412":{"description":"Wallet does not have enough credits to complete redeem request, this can happen when the network is slow. Please retry the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"description":"Request body with all necessary parameters to execute the gasless redeem transaction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvmRedeemBody"}}}}}},"/redeem/merchant":{"post":{"operationId":"get-merchant-wallet-redeem-transaction","summary":"Create Merchant Wallet Redemption Transaction","description":"Creates a transaction for the user to sign in order to redeem their Coinflow credits, with the resulting stablecoins being delivered to the merchant's settlement wallet.","tags":["redeem"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedeemResponse"}}}},"412":{"description":"Wallet does not have enough credits to complete redeem request, this can happen when the network is slow. Please retry the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantWalletRedeemBody"}}}}}},"/redeem":{"post":{"operationId":"get-redeem-transaction","summary":"Create Redeem Transaction","description":"Creates a transaction for the user to sign in order to redeem their Coinflow credits with a merchant's contract.\n\nThe transaction passed to this endpoint should be the same as if the end user's wallet was calling the merchant's contract with enough USDC/Other Cryto Currency to successfully complete the transaction.","tags":["redeem"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedeemResponse"}}}},"412":{"description":"Wallet does not have enough credits to complete redeem request, this can happen when the network is slow. Please retry the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedeemBody"}}}}}},"/refunds":{"get":{"operationId":"get-refunds","summary":"Get Refunds","tags":["refund"],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string"}},{"name":"method","in":"query","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Payment ID or User ID / Customer ID","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RefundInfo"}}}}}}}},"/refunds/{refundId}/retry":{"post":{"operationId":"retry-refund","summary":"Retry a Failed Refund","tags":["refund"],"parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund_RetryRefund_Response_200"}}}}}}},"/refunds/payment/{paymentId}/all":{"get":{"operationId":"get-refunds-via-payment-id","summary":"View All Refunds for Payment","tags":["refund"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IRefund"}}}}}}}},"/refunds/payment/{paymentId}":{"get":{"operationId":"get-refund-via-payment-id","summary":"View Refund Information for Payment","tags":["refund"],"parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund_GetRefundViaPaymentId_Response_200"}}}}}}},"/submerchant":{"post":{"operationId":"create-submerchant","summary":"Create Submerchant","description":"Create a sub-merchant and prefill a draft onboarding form with a lean\nPhase-1 field set. Caller-supplied `merchantId`/`email` map to the new\nsub-merchant's identity and login; the remaining fields are validated\nagainst the ISV Phase-1 subset and written as a draft `Onboarding` form.","tags":["subMerchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubmerchantResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubmerchantBody"}}}}},"get":{"operationId":"get-submerchants","summary":"Get All Submerchants","tags":["subMerchant"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","format":"double","default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double","default":100}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SanitizedMerchant"}}}}}}}},"/submerchant/{submerchantId}":{"get":{"operationId":"get-submerchant","summary":"Get Submerchant by ID","tags":["subMerchant"],"parameters":[{"name":"submerchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SanitizedMerchant"}}}},"404":{"description":"Submerchant Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}}},"patch":{"operationId":"update-submerchant","summary":"Update Submerchant","description":"Merge-update a sub-merchant's draft onboarding form with a Phase-1 field\nsubset. Only fields present in the body are changed — previously-set\nfields (from this or an earlier call) are preserved, except that\n`websiteUrls`/`developmentUrls` are whole-array replacements: providing\na shorter array than a previous call clears the now-unused trailing\ndiscrete fields rather than leaving them stale. Rejects once the\nsub-merchant's application has been submitted for underwriting review.","tags":["subMerchant"],"parameters":[{"name":"submerchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSubmerchantResponse"}}}},"404":{"description":"Submerchant Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsvSubmerchantFields"}}}}}},"/submerchant/onboarding-token":{"post":{"operationId":"get-onboarding-token","summary":"Get Submerchant Onboarding Token","description":"Mint a short-lived onboarding token that authorizes creating a\nsubmerchant or seller under the authenticated merchant. The token embeds\nthe caller's own merchantId as the parent — it cannot be minted for\nanother merchant.","tags":["subMerchant"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchant_GetOnboardingToken_Response_200"}}}}}}},"/subscription/{merchantId}/subscribers/{subscriptionId}":{"patch":{"operationId":"cancel-customer-subscription","summary":"Customer Cancel Subscription","description":"Cancel a subscription (by customer)","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/subscription/{merchantId}/plans":{"get":{"operationId":"get-available-plans","summary":"Get Available Plans","description":"Get the available subscription plans for a merchant","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionPlan"}}}}}}}},"/subscription/{merchantId}/subscribers":{"get":{"operationId":"get-customer-subscriptions","summary":"Get Customer Subscriptions","description":"Get the subscriptions a customer has with a merchant","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionDisplay"}}}}}}}},"/subscription/{merchantId}/plans/{code}":{"get":{"operationId":"get-plan","summary":"Get Plan","description":"Get a specific subscription plan","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"code","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPlan"}}}}}}},"/subscription/{merchantId}/subscribers/ach":{"post":{"operationId":"create-subscription-ach","summary":"Purchase Subscription by ACH","description":"Purchase a subscription using ACH","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}},"428":{"description":"User must re-verify account","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionAchSetup"}}}}}},"/subscription/{merchantId}/subscribers/token":{"post":{"operationId":"create-subscription-token","summary":"Purchase Subscription with Existing Card","description":"Purchase a subscription with an existing credit card","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}},"422":{"description":"Address Required","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionTokenSetup"}}}}}},"/subscription/{merchantId}/subscribers/card":{"post":{"operationId":"create-subscription-card","summary":"Purchase Subscription with New Card","description":"Purchase a subscription with a new credit card","tags":["subscription"],"parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-session-key","in":"header","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}},{"name":"x-device-id","in":"header","description":"- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCardSetup"}}}}}},"/utils/contract-address":{"get":{"operationId":"get-contract-addresses","summary":"Get the Coinflow Contract Address","description":"Get the Coinflow Contract address by blockchain","tags":["utilities"],"parameters":[{"name":"blockchain","in":"query","description":"- Blockchain to get the contract address of","required":true,"schema":{"$ref":"#/components/schemas/Blockchain"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Utilities_GetContractAddresses_Response_200"}}}}}}},"/utils/send-coinflow-tx":{"post":{"operationId":"send-coinflow-transaction","summary":"Send Coinflow Signed Solana Transaction","description":"Send a Coinflow generated and signed transaction\n\nUse Coinflow's battle tested ⚔️ Transaction Sending (The same system we use to send our own transactions)\nThis endpoint sends a fully signed Solana transaction with retries thru stable RPC servers.\n\nThis endpoint is specifically used in the case that the transaction attempting to be sent\nwas pre-signed by one of Coinflow's wallets.\n\nFor example:\nTransaction is retrieved from the /api/redeem endpoint, that transaction\ncomes with the feePayer set and pre-signed by one of Coinflow's fee payer wallets.\nThis endpoint can then be called directly from a frontend without the need for the\nmerchant's API key like the /send-solana-tx endpoint above.","tags":["utilities"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Utilities_SendCoinflowTransaction_Response_200"}}}},"412":{"description":"Transaction Simulation Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCoinflowTransactionRequestPreconditionFailedError"}}}},"417":{"description":"Transaction Expired, fetch a new transaction, re-sign, and resend","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The transaction can't be confirmed, fetch a new transaction, re-sign, and resend","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"- merchantId: A valid merchant id\n  signedTransaction: The signed transaction\n  confirm: Confirm the solana transaction - Will cause the response times to be longer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTransactionBody"}}}}}},"/utils/send-solana-tx":{"post":{"operationId":"send-solana-transaction","summary":"Send Solana Transaction","description":"Use Coinflow's battle tested ⚔️ Transaction Sending (The same system we use to send our own transactions).\n\nThis endpoint sends a fully signed Solana transaction with retries and stable RPC servers.\nThis is helpful during periods of network instability where the solution is to use better private RPC servers,\nretry transactions multiple times.","tags":["utilities"],"parameters":[{"name":"Authorization","in":"header","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendSolanaTransactionResponse"}}}},"412":{"description":"Transaction Simulation Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendSolanaTransactionRequestPreconditionFailedError"}}}},"417":{"description":"Transaction Expired, fetch a new transaction, re-sign, and resend","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The transaction can't be confirmed, fetch a new transaction, re-sign, and resend","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendSolanaTransactionRequest"}}}}}},"/withdraw/interac":{"post":{"operationId":"add-interac","summary":"Add Interac Account","description":"Adds an interac account to the withdrawer's account which they can withdraw funds to.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddInteracArgs"}}}}}},"/withdraw/account":{"post":{"operationId":"create-bank-account","summary":"Create Bank Account","description":"Creates a bank account for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWithdrawMethodResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBankAccountArgs"}}}}}},"/withdraw/account/v2":{"post":{"operationId":"create-bank-account-v-2","summary":"Create Bank Account (v2)","description":"Creates a bank account for a particular user or business","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWithdrawMethodResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBankAccountV2Args"}}}}}},"/withdraw/debit-card":{"post":{"operationId":"add-debit-card","summary":"Create Debit Card","description":"Adds a debit card to the withdrawer's account which they can withdraw funds to.\n\nWill check the card to see if its eligible to receive funds.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}},"412":{"description":"User Address Info Required  - Please provide address info in body.address parameters","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDebitCardArgs"}}}}}},"/withdraw/eft":{"post":{"operationId":"create-eft-account","summary":"Create EFT Account","description":"Creates an EFT account for a particular Canadian user or business.\nAccepts raw Canadian bank details (institution number, transit number, account number).","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token representing the new EFT account","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEftAccountArgs"}}}}}},"/withdraw/iban":{"post":{"operationId":"create-iban-account","summary":"Create Iban Account","description":"Creates an Iban account for a particular user","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token representing the new Iban account","content":{"application/json":{"schema":{"type":"string"}}}},"426":{"description":"BIC required","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbanAccountData"}}}}}},"/withdraw/pix":{"post":{"operationId":"create-pix-account","summary":"Create Pix Account","description":"Creates a Pix account for a particular user","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pixKey":{"type":"string"}},"required":["pixKey"]}}}}}},"/withdraw/swift":{"post":{"operationId":"create-swift-account","summary":"Create Swift Account","description":"Creates a Swift account for a particular user","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token representing the new Swift account","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftAccountData"}}}}}},"/withdraw/transaction":{"post":{"operationId":"get-transaction","summary":"Create Transactions","description":"Creates the transaction to be signed by the user and sent to the blockchain.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawTransactionResponse"}}}},"412":{"description":"User Address Info Required  - Please provide address info in body.address parameters","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"User Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTransactionRequestUnavailableForLegalReasonsError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawTransactionRequestBody"}}}}}},"/withdraw/account/{token}":{"delete":{"operationId":"delete-withdrawer-account","summary":"Delete Withdrawer Bank Account","description":"Deletes a bank account for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"token","in":"path","description":"The token of the bank account to delete.","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteWithdrawerAccount_Response_200"}}}}}}},"/withdraw/card/{token}":{"delete":{"operationId":"delete-withdrawer-card","summary":"Delete Withdrawer Card","description":"Deletes a card for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"token","in":"path","description":"The token of the card to delete.","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteWithdrawerCard_Response_200"}}}}}}},"/withdraw/eft/{token}":{"delete":{"operationId":"delete-eft-account","summary":"Delete Withdrawer EFT Account","description":"Deletes an EFT account for a particular user","tags":["withdraw"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteEftAccount_Response_200"}}}}}}},"/withdraw/iban/{token}":{"delete":{"operationId":"delete-iban-account","summary":"Delete Withdrawer Iban Account","description":"Deletes an Iban account for a particular user","tags":["withdraw"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteIbanAccount_Response_200"}}}}}}},"/withdraw/interac/{token}":{"delete":{"operationId":"delete-withdrawer-interac","summary":"Delete Withdrawer Interac Account","description":"Deletes a bank account for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"token","in":"path","description":"The token of the bank account to delete.","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteWithdrawerInterac_Response_200"}}}}}}},"/withdraw/mobile/{token}":{"delete":{"operationId":"delete-withdrawer-mobile","summary":"Delete Withdrawer Mobile Account","description":"Deletes a mobile (Apple Pay) account for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"token","in":"path","description":"The token of the mobile account to delete.","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteWithdrawerMobile_Response_200"}}}}}}},"/withdraw/paypal/{token}":{"delete":{"operationId":"delete-withdrawer-paypal","summary":"Delete Withdrawer Paypal Account","description":"Deletes a bank account for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"token","in":"path","description":"The token of the bank account to delete.","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteWithdrawerPaypal_Response_200"}}}}}}},"/withdraw/pix/{token}":{"delete":{"operationId":"delete-pix-account","summary":"Delete Withdrawer Pix Account","description":"Deletes a Pix account for a particular user","tags":["withdraw"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeletePixAccount_Response_200"}}}}}}},"/withdraw/swift/{token}":{"delete":{"operationId":"delete-swift-account","summary":"Delete Withdrawer Swift Account","description":"Deletes a Swift account for a particular user","tags":["withdraw"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteSwiftAccount_Response_200"}}}}}}},"/withdraw/venmo/{token}":{"delete":{"operationId":"delete-withdrawer-venmo","summary":"Delete Withdrawer Venmo Account","description":"Deletes a venmo for a particular user.","tags":["withdraw"],"parameters":[{"name":"token","in":"path","description":"The token of the bank account to delete.","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_DeleteWithdrawerVenmo_Response_200"}}}}}}},"/withdraw/balances":{"get":{"operationId":"get-withdraw-balances","summary":"Get Balances","description":"Gets all the token balances for a particular wallet","tags":["withdraw"],"parameters":[{"name":"tokenAddress","in":"query","description":"- Optional token address to fetch balance for a specific token","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_GetWithdrawBalances_Response_200"}}}}}}},"/withdraw/evm/message":{"post":{"operationId":"get-evm-message","summary":"Get Message (EVM USDC/SBC/EuroE only)","description":"Gets any messages to be signed by the user, the signed message is then passed\nas the `evmPermitMessage` body property into the\n`/api/withdraw/evm/transaction` endpoint.\n\nThis is only necessary for EVM chains.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawMessageBody"}}}}}},"/withdraw/quote":{"get":{"operationId":"get-quote","summary":"Get Quote","description":"Gets a quote in USD cents for a particular token and amount.","tags":["withdraw"],"parameters":[{"name":"token","in":"query","description":"- The token address or contract of the token which the user is withdrawing.","required":true,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"- The amount of that token which the user is withdrawing.","required":true,"schema":{"type":"number","format":"double"}},{"name":"merchantId","in":"query","description":"- The merchant that this quote is for.","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"- The payout currency of the quote. Defaults to the account/withdrawer currency.","required":false,"schema":{"$ref":"#/components/schemas/Currency"}},{"name":"usePermit","in":"query","description":"- [EVM only] whether the user's wallet supports signing permit messages.","required":false,"schema":{"type":"boolean","default":true}},{"name":"accountToken","in":"query","description":"- The token of the account to use","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawQuote"}}}}}}},"/withdraw/quote/exact-out":{"get":{"operationId":"get-exact-out-quote","summary":"Get Quote (Exact Out)","description":"Destination-amount (\"reverse\") quote. Given a target fiat payout\n(`exactAmountOut`), returns — for every withdrawal speed — how much of the\ninput token the merchant needs to send so that, after swap, gas and\nwithdraw fees, the withdrawer nets exactly that payout. A speed is\n`undefined` when it isn't available for the requested payout (no\nproviders, unsupported currency, over the limit, or unreachable).\n\nThis is the inverse of `GET /withdraw/quote`.","tags":["withdraw"],"parameters":[{"name":"exactAmountOut","in":"query","description":"- The fiat payout amount (in cents) the withdrawer should receive.","required":true,"schema":{"type":"number","format":"double"}},{"name":"inputToken","in":"query","description":"- The token address or contract of the token which the user is withdrawing.","required":true,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"- The merchant that this quote is for.","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"- The currency of `exactAmountOut`. Defaults to the account/withdrawer currency.","required":false,"schema":{"$ref":"#/components/schemas/Currency"}},{"name":"usePermit","in":"query","description":"- [EVM only] whether the user's wallet supports signing permit messages.","required":false,"schema":{"type":"boolean","default":true}},{"name":"accountToken","in":"query","description":"- The token of the account to use","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_WithdrawSpeed.WithdrawExactOutQuote-or-undefined_"}}}}}}},"/withdraw":{"get":{"operationId":"get-withdrawer","summary":"Get Withdrawer","description":"Gets the withdrawer record for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"redirectLink","in":"query","description":"(optional): The URL to which the user will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller\nto direct the user to verificationLink first.","required":false,"schema":{"type":"string"}},{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawerResponse"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawerVerificationRequiredResponse"}}}}}}},"/withdraw/history":{"get":{"operationId":"get-withdrawer-history","summary":"Get Withdrawer History","description":"Gets the withdrawal history for a particular user or business.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_GetWithdrawerHistory_Response_200"}}}}}}},"/withdraw/apple-pay":{"post":{"operationId":"add-apple-pay","summary":"Link Apple Pay Card","description":"Adds an Apple Pay card to the withdrawer's account which they can push\nfunds to from the CF wallet.\n\nThe `ApplePayResponseObject` is decrypted and the underlying card is BIN\nchecked to ensure it is a debit card eligible for push-to-card. Returns the\ntoken to pass as the `account` on the payout endpoints.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddApplePayArgs"}}}}}},"/withdraw/paypal":{"post":{"operationId":"add-paypal","summary":"Link Paypal Account","description":"Adds a Paypal account to the withdrawer's account which they can withdraw funds to.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPaypalArgs"}}}}}},"/withdraw/venmo":{"post":{"operationId":"add-venmo","summary":"Link Venmo Account","description":"Adds a Venmo account to the withdrawer's account which they can withdraw funds to.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVenmoArgs"}}}}}},"/withdraw/paypal/login/status":{"get":{"operationId":"get-paypal-login-status","summary":"Log in with PayPal status","description":"Polls the outcome of a Log in with PayPal attempt for the authenticated\nwithdrawer. The widget calls this while its popup is open; the server-side\nreturn handler links the account and records `linked`/`error` on the\nsession, so completion never relies on the popup messaging the widget.","tags":["withdraw"],"parameters":[{"name":"sessionId","in":"query","required":true,"schema":{"type":"string"}},{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_GetPaypalLoginStatus_Response_200"}}}}}}},"/withdraw/kyb":{"post":{"operationId":"create-kyb","summary":"Register Business","description":"Performs a Know-Your-Business check for a particular user. Will create  a withdrawer record for the user if one does not exist.\nIf the user has previously used coinflow to withdraw, the wallet will be added to the withdrawer record.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_CreateKyb_Response_200"}}}},"409":{"description":"User already exists for this wallet and merchant","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawerVerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KybRequestBody"}}}}}},"/withdraw/kyc":{"post":{"operationId":"create-kyc","summary":"Register User","description":"Performs a Know-Your-Customer check for a particular user. Will create  a withdrawer record for the user if one does not exist.\nIf the user has previously used coinflow to withdraw, the wallet will be added to the withdrawer record.\nNote: If `x-coinflow-auth-wallet` in request headers is not associated with a user, the wallet will get added to the newly created /existing user withdrawer record.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_CreateKyc_Response_200"}}}},"409":{"description":"Business already exists for this wallet and merchant","content":{"application/json":{"schema":{"description":"Any type"}}}},"451":{"description":"Must Complete Additional Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawerVerificationRequiredResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycRequestBody"}}}}}},"/withdraw/kyc/attested":{"post":{"operationId":"create-kyc-attested","summary":"Register User Via Attested KYC","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_CreateKycAttested_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttestedKycRequest"}}}}}},"/withdraw/kyc-doc":{"post":{"operationId":"create-kyc-document","summary":"Register User Via Document","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_CreateKycDocument_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"email":{"type":"string"},"country":{"type":"string"},"idType":{"type":"string","description":"Must be one of:\n- ID_CARD\n- PASSPORT\n- DRIVERS\n- RESIDENCE_PERMIT"},"merchantId":{"type":"string"},"idFront":{"type":"string","format":"binary"},"idBack":{"type":"string","format":"binary"}},"required":["email","country","idType","merchantId","idFront"]}}}}}},"/withdraw/kyc/share-token":{"post":{"operationId":"create-kyc-share-token","summary":"Register User Via Share Token","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_CreateKycShareToken_Response_200"}}}},"400":{"description":"","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycShareTokenBody"}}}}}},"/withdraw/evm/transaction":{"post":{"operationId":"send-evm-gasless-transaction","summary":"Send Gasless Withdraw Transaction (EVM USDC/SBC/EuroE only)","description":"Send a gasless USDC withdraw transaction to the blockchain.\nThe gas for the transaction can either be paid by the user or by the merchant,\ndepending on your merchant settings.\n\nThis is only allowed for withdrawing USDC/SBC/EuroE on EVM chains.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-wallet","in":"header","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_SendEvmGaslessTransaction_Response_200"}}}},"412":{"description":"User Address Info Required  - Please provide address info in body.address parameters","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEvmWithdrawTransactionBody"}}}}}},"/withdraw/paypal/login":{"post":{"operationId":"start-paypal-login","summary":"Start Log in with PayPal","description":"Begins the \"Log in with PayPal\" flow. Returns the PayPal authorization URL\nto redirect the withdrawer to, a signed `state` that must be echoed back to\nthe callback endpoint, and a `sessionId` the widget polls (via\n  ) to learn when linking finished.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_StartPaypalLogin_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartPaypalLoginArgs"}}}}}},"/withdraw/kyc/validate":{"post":{"operationId":"validate-kyc","summary":"Validate KYC Information","description":"This endpoint checks if the user's provided information matches the information used during their Know-Your-Customer (KYC) verification.\nIt returns an object with a `valid` property that is `true` if the information matches and `false` otherwise.\nA 404 error is returned if the KYC information for the user cannot be found. This does not indicate a validation failure.\nCheck the response body to determine if the KYC information is valid.","tags":["withdraw"],"parameters":[{"name":"x-coinflow-auth-user-id","in":"header","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_ValidateKyc_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateKycBody"}}}}}}},"servers":[{"url":"https://api-sandbox.coinflow.cash/api","description":"https://api-sandbox.coinflow.cash/api"}],"webhooks":{"interac-pin-webhook":{"post":{"operationId":"interac-pin-webhook","summary":"Interac PIN","description":"Fired when an Interac payout receives its Interac code (PIN), so you can display the code to the recipient without polling.","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteracPinWebhookPacket"}}}}}}},"components":{"schemas":{"GetMessageToSignResponse":{"type":"object","properties":{"message":{"type":"string"},"transaction":{"type":"string"}},"required":["message"],"title":"GetMessageToSignResponse"},"GetSessionKeyResponse":{"type":"object","properties":{"key":{"type":"string"}},"required":["key"],"title":"GetSessionKeyResponse"},"TokenizeAssociateCvvPostParametersTxTokenScheme":{"type":"string","enum":["sixANTOKENfour"],"title":"TokenizeAssociateCvvPostParametersTxTokenScheme"},"ServerToServerAssociatedCvvRequest":{"type":"object","properties":{"token":{"type":"string","description":"The token to associate the CVV with.\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card data should be sent."},"cvv":{"type":"string","description":"The value of the CVV you wish to associate with the token.\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card data should be sent."}},"required":["token"],"title":"ServerToServerAssociatedCvvRequest"},"ServerToServerTokenizationResponse":{"type":"object","properties":{"token":{"type":"string"},"firstSix":{"type":"string"},"lastFour":{"type":"string"},"referenceNumber":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"}},"required":["token","firstSix","lastFour","referenceNumber","success","error","message"],"title":"ServerToServerTokenizationResponse"},"ExtractCardRequest":{"type":"object","properties":{"image":{"type":"string","description":"A base64-encoded image of the physical card to extract details from.\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card image should be sent."},"mimeType":{"type":"string","description":"The MIME type of the provided image. Defaults to image/jpeg.\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card image should be sent."}},"title":"ExtractCardRequest"},"ExtractCardResponse":{"type":"object","properties":{"token":{"type":"string","description":"The token representing the extracted card. Use this token in the cards\nendpoint to complete the checkout."},"firstSix":{"type":"string","description":"The first six digits of the extracted card number."},"lastFour":{"type":"string","description":"The last four digits of the extracted card number."},"expirationMonth":{"type":["string","null"],"description":"The extracted card expiration month, if available."},"expirationYear":{"type":["string","null"],"description":"The extracted card expiration year, if available."},"cvvCaptured":{"type":"boolean","description":"Whether a CVV/CVC was captured from the image and stored with the token."}},"required":["token","firstSix","lastFour","expirationMonth","expirationYear","cvvCaptured"],"title":"ExtractCardResponse"},"TokenizePostParametersTxTokenScheme":{"type":"string","enum":["sixANTOKENfour"],"title":"TokenizePostParametersTxTokenScheme"},"ServerToServerTokenizationRequest":{"type":"object","properties":{"data":{"type":"string","description":"The data to be tokenized. This is the PAN of the card.\nExample: 4111111111111111\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card data should be sent."},"cvv":{"type":"string","description":"The value of the CVV you want to associate with the token.\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card data should be sent."}},"title":"ServerToServerTokenizationRequest"},"TokenizeCardOnlyPostParametersTxTokenScheme":{"type":"string","enum":["sixANTOKENfour"],"title":"TokenizeCardOnlyPostParametersTxTokenScheme"},"ServerToServerCardOnlyRequest":{"type":"object","properties":{"data":{"type":"string","description":"The data to be tokenized. This is the PAN of the card.\nExample: 4111111111111111\n\nNote: This is only for documentation purposes, this endpoint returns an HTTP\nredirect where the card data should be sent."}},"title":"ServerToServerCardOnlyRequest"},"AuthorizationEventType":{"type":"string","enum":["archived","reopened","deadline_passed_no_shipment","fully_filled"],"title":"AuthorizationEventType"},"AchAuthorizationStatusEventRequest":{"type":"object","properties":{"eventTimestamp":{"type":"string","format":"date-time"},"eventType":{"$ref":"#/components/schemas/AuthorizationEventType"}},"required":["eventTimestamp","eventType"],"title":"AchAuthorizationStatusEventRequest"},"Currency":{"type":"string","enum":["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"],"title":"Currency"},"CustomPayInFeeValue0":{"type":"object","properties":{"cents":{"type":"number","format":"double"},"currency":{"$ref":"#/components/schemas/Currency"},"percent":{"type":["number","null"],"format":"double"},"isFixed":{"type":"boolean"}},"required":["cents","currency","percent","isFixed"],"title":"CustomPayInFeeValue0"},"CustomPayInFeeValue1":{"type":"object","properties":{"cents":{"type":["number","null"],"format":"double"},"currency":{"type":["number","null"],"format":"double"},"percent":{"type":"number","format":"double"},"isFixed":{"type":"boolean"}},"required":["cents","currency","percent","isFixed"],"title":"CustomPayInFeeValue1"},"CustomPayInFeeValue":{"oneOf":[{"$ref":"#/components/schemas/CustomPayInFeeValue0"},{"$ref":"#/components/schemas/CustomPayInFeeValue1"}],"title":"CustomPayInFeeValue"},"CustomPayInFeeConfig":{"type":"object","properties":{"fee":{"$ref":"#/components/schemas/CustomPayInFeeValue"},"lineItemLabel":{"type":"string"}},"required":["fee","lineItemLabel"],"title":"CustomPayInFeeConfig"},"CustomPayInFeesConfig":{"type":"array","items":{"$ref":"#/components/schemas/CustomPayInFeeConfig"},"title":"CustomPayInFeesConfig"},"SplitNameCustomerInfo":{"type":"object","properties":{"verificationId":{"type":"string"},"displayName":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"ip":{"type":"string"},"lat":{"type":"string"},"lng":{"type":"string"},"dob":{"type":"string","description":"Date of birth in YYYY-MM-DD format"},"email":{"type":"string"},"firstName":{"type":"string","minLength":1},"lastName":{"type":"string","minLength":1}},"required":["firstName","lastName"],"title":"SplitNameCustomerInfo"},"NameCustomerInfo":{"type":"object","properties":{"verificationId":{"type":"string"},"displayName":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"ip":{"type":"string"},"lat":{"type":"string"},"lng":{"type":"string"},"dob":{"type":"string","description":"Date of birth in YYYY-MM-DD format"},"email":{"type":"string"},"name":{"type":"string"}},"title":"NameCustomerInfo"},"CustomerInfo":{"oneOf":[{"$ref":"#/components/schemas/SplitNameCustomerInfo"},{"$ref":"#/components/schemas/NameCustomerInfo"}],"title":"CustomerInfo"},"AnyObject":{"type":"object","properties":{"example":{"type":"string"}},"title":"AnyObject"},"productType":{"type":"string","enum":["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"],"title":"productType"},"PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClassListPrice":{"type":"object","properties":{"currency":{"type":"string"},"valueInCurrency":{"type":"number","format":"double"}},"description":"The item's list price","title":"PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClassListPrice"},"Record_string.any_":{"type":"object","properties":{},"description":"Construct a type with a set of properties K of type T","title":"Record_string.any_"},"SellerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Id of the seller"},"email":{"type":["string","null"],"description":"Email\nExample: lois.lane@dailyplanet.com"},"firstName":{"type":"string","description":"First name\nExample: Lois"},"lastName":{"type":"string","description":"Last name\nExample: Lois"},"dob":{"type":"string","description":"Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY\nPattern: ^\\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$"},"rawSellerData":{"$ref":"#/components/schemas/Record_string.any_"}},"title":"SellerInfo"},"TransactionHistoryItem":{"type":"object","properties":{"txType":{"type":"string"},"chain":{"type":"string"},"paymentAmount":{"type":"string"},"paymentToken":{"type":"string"},"to":{"type":"string"},"from":{"type":"string"},"registryContract":{"type":"string"},"assetID":{"type":"string"},"txTime":{"type":"string"},"blockNumber":{"type":"number","format":"double"},"txHash":{"type":"string"}},"required":["txType","chain","paymentAmount","paymentToken","to","from","registryContract","assetID","txTime","blockNumber","txHash"],"title":"TransactionHistoryItem"},"Pick_nftCartItem.Exclude_keyofnftCartItem.sellingPrice-or-itemClass__":{"type":"object","properties":{"productName":{"type":"string","minLength":1,"description":"The name of the related product"},"productType":{"$ref":"#/components/schemas/productType"},"listPrice":{"$ref":"#/components/schemas/PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClassListPrice","description":"The item's list price"},"quantity":{"type":"number","format":"double","description":"The number of units sold"},"rawProductData":{"$ref":"#/components/schemas/AnyObject"},"seller":{"$ref":"#/components/schemas/SellerInfo"},"transactionHistory":{"type":"array","items":{"$ref":"#/components/schemas/TransactionHistoryItem"}}},"required":["productName","productType","quantity"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_nftCartItem.Exclude_keyofnftCartItem.sellingPrice-or-itemClass__"},"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceSellingPrice":{"type":"object","properties":{"currency":{"type":"string"},"valueInCurrency":{"type":"number","format":"double"}},"required":["currency","valueInCurrency"],"title":"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceSellingPrice"},"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemClass":{"type":"string","enum":["giftCard"],"title":"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemClass"},"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceProductType":{"type":"string","enum":["giftCard"],"title":"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceProductType"},"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemFulfillment":{"type":"string","enum":["digital","physical"],"description":"How the product was fulfilled.","title":"PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemFulfillment"},"PhoneInfo":{"type":"object","properties":{"carrier":{"type":"string","description":"The mobile carrier\nExample: T-Mobile"},"countryCode":{"type":"string","description":"The country code (leading `+` is optional)\nExample: 42\nPattern: ^\\+?[0-9]+$"},"phone":{"type":"string","description":"The phone number without the country code or hyphens\nExample: 2025550169\nPattern: ^[0-9]+$"}},"required":["countryCode","phone"],"description":"Phone information structure","title":"PhoneInfo"},"CartItemAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country code specified as a two letter code according to ISO 3166 Alpha-2\nBetween 2 and 2 characters\nExample: US\nPattern: ^[A-Z]{2}$"},"state":{"type":"string","description":"The state or province\nExample: PA"},"city":{"type":"string","description":"The city or locality\nExample: Pittsburgh"},"street":{"type":"string","description":"The street name\nExample: Baker St"},"postalCode":{"type":"string","description":"The address postal code"}},"description":"Address structure","title":"CartItemAddress"},"RecipientInfoWalletCustodialType":{"type":"string","enum":["custodial","nonCustodial","unknown"],"description":"The type of the wallet\nAllowed values: custodial, nonCustodial, unknown\nExample: custodial","title":"RecipientInfoWalletCustodialType"},"RecipientInfoWallet":{"type":"object","properties":{"custodialType":{"$ref":"#/components/schemas/RecipientInfoWalletCustodialType","description":"The type of the wallet\nAllowed values: custodial, nonCustodial, unknown\nExample: custodial"},"blockchain":{"type":"string","description":"The blockchain on which the transaction was made\nExample: BTC\nPattern: ^[A-Z0-9-]+$"},"address":{"type":"string","description":"The crypto wallet address that will receive the funds"}},"required":["custodialType","blockchain","address"],"description":"The crypto wallet that will receive the funds","title":"RecipientInfoWallet"},"RecipientInfo":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account that will receive the purchased goods"},"dob":{"type":"string","description":"Date of birth, formatted as YYYY-MM-DD. If only the year is known, use YYYY\nPattern: ^\\d{4}(-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))?$"},"email":{"type":["string","null"],"description":"Email\nExample: lois.lane@dailyplanet.com"},"firstName":{"type":"string","description":"First name\nExample: Lois"},"gender":{"type":"string","description":"Gender\nExample: female"},"lastName":{"type":"string","description":"Last name\nExample: Lois"},"message":{"type":"string","description":"The message that the recipient will receive"},"phoneInfo":{"$ref":"#/components/schemas/PhoneInfo"},"shippingAddress":{"$ref":"#/components/schemas/CartItemAddress"},"wallet":{"$ref":"#/components/schemas/RecipientInfoWallet","description":"The crypto wallet that will receive the funds"}},"title":"RecipientInfo"},"Pick_GiftCardCartItem.Exclude_keyofGiftCardCartItem.listPrice__":{"type":"object","properties":{"brand":{"type":"string","description":"The name of the brand"},"sellingPrice":{"$ref":"#/components/schemas/PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceSellingPrice"},"itemClass":{"$ref":"#/components/schemas/PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemClass"},"productType":{"$ref":"#/components/schemas/PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceProductType"},"quantity":{"type":"number","format":"double","description":"The number of units sold"},"rawProductData":{"$ref":"#/components/schemas/Record_string.any_"},"seller":{"$ref":"#/components/schemas/SellerInfo"},"id":{"type":"string","description":"The cart items’s unique ID"},"itemFulfillment":{"$ref":"#/components/schemas/PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemFulfillment","description":"How the product was fulfilled."},"sku":{"type":"string","description":"The stock-keeping unit (SKU) number"},"categories":{"type":"array","items":{"type":"string"},"description":"The category in the site/app in which the item was classified (e.g., fashion)"},"isGift":{"type":"boolean"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"},"expectedDeliveryDelay":{"type":"number","format":"double","description":"The expected delay in delivery, in hours"},"isPresetAmount":{"type":"boolean","description":"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"}},"required":["sellingPrice","itemClass","productType","quantity","id","itemFulfillment"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_GiftCardCartItem.Exclude_keyofGiftCardCartItem.listPrice__"},"CryptoCartItemItemClass":{"type":"string","enum":["crypto"],"description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: crypto\nExample: crypto","title":"CryptoCartItemItemClass"},"CryptoCartItemUnitPrice":{"type":"object","properties":{"currency":{"type":"string","description":"Currency specified as a three letter code according to ISO 4217\nExample: USD"},"valueInCurrency":{"type":"number","format":"double","description":"The amount in the currency, which is specified in the `currency` property\nExample: 90"}},"required":["currency","valueInCurrency"],"description":"The price per 1 unit","title":"CryptoCartItemUnitPrice"},"CryptoCartItem":{"type":"object","properties":{"itemClass":{"$ref":"#/components/schemas/CryptoCartItemItemClass","description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: crypto\nExample: crypto"},"id":{"type":"string","description":"The cart items's unique ID\nExample: 5de33332-546a-4171-8988-2a43d2bfe9c6"},"rawProductData":{"$ref":"#/components/schemas/AnyObject"},"units":{"type":"string","description":"The amount in the crypto currency which is specified in the `cryptoCurrency` property\nExample: 1.04112\nPattern: ^[0-9]+(\\.[0-9]+)?$"},"cryptoCurrency":{"type":"string","description":"The crypto-currency symbol (uppercase)\nExample: BTC\nPattern: ^[A-Z0-9-]+$"},"unitPrice":{"$ref":"#/components/schemas/CryptoCartItemUnitPrice","description":"The price per 1 unit"},"expectedDeliveryDelay":{"type":"number","format":"double","description":"The expected delay in delivery, in hours\nMin value: 0"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"},"seller":{"$ref":"#/components/schemas/SellerInfo"}},"required":["itemClass","units","cryptoCurrency","unitPrice","recipientInfo"],"description":"Represents a crypto item in a shopping cart","title":"CryptoCartItem"},"MoneyTopUpCartItemItemClass":{"type":"string","enum":["moneyTopUp"],"description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: moneyTopUp\nExample: moneyTopUp","title":"MoneyTopUpCartItemItemClass"},"CurrencyAmount":{"type":"object","properties":{"valueInCurrency":{"type":"number","format":"double","description":"The amount in the currency, which is specified in the `currency` property\nExample: 90"},"currency":{"type":"string","description":"Currency specified as a three letter code according to ISO 4217\nExample: USD"}},"required":["valueInCurrency","currency"],"description":"Common currency amount structure","title":"CurrencyAmount"},"MoneyTopUpCartItem":{"type":"object","properties":{"itemClass":{"$ref":"#/components/schemas/MoneyTopUpCartItemItemClass","description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: moneyTopUp\nExample: moneyTopUp"},"id":{"type":"string","description":"The cart items's unique ID\nExample: 5de33332-546a-4171-8988-2a43d2bfe9c6"},"rawProductData":{"$ref":"#/components/schemas/Record_string.any_"},"sellingPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"},"topUpAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"quantity":{"type":"number","format":"double","description":"Quantity\nExample: 2"},"isPresetAmount":{"type":"boolean","description":"Represents whether the item amount is taken from a preset list, e.g. 25, 50, 100, etc.\nor whether it was a different amount, e.g. 27"}},"required":["itemClass","sellingPrice","topUpAmount","quantity","isPresetAmount"],"description":"Represents a money top-up item in a shopping cart","title":"MoneyTopUpCartItem"},"TravelCartItemItemClass":{"type":"string","enum":["travel"],"description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: travel\nExample: travel","title":"TravelCartItemItemClass"},"TravelLodgingHotel":{"type":"object","properties":{"name":{"type":"string","description":"The name of the hotel\nExample: The Plaza Hotel"},"country":{"type":"string","description":"The two-letter code of the country in which the hotel is located\nExample: US\nPattern: ^[A-Z]{2}$"},"city":{"type":"string","description":"The city in which the hotel is located\nExample: New York"}},"required":["name","country","city"],"description":"The booked hotel details","title":"TravelLodgingHotel"},"TravelLodging":{"type":"object","properties":{"reservationId":{"type":"string","description":"Hotel reservation id\nExample: X36Q9C"},"nights":{"type":"number","format":"double","description":"The number of nights booked in the reservation\nMin value: 1\nExample: 2"},"checkInDate":{"type":"string","description":"The check-in date\nExample: 2022-05-02"},"checkInHour":{"type":"string","description":"The hour of day in which the check-in is done\nExample: 18\nPattern: ^([01][0-9]|2[0-3])$"},"hotel":{"$ref":"#/components/schemas/TravelLodgingHotel"},"wereExtrasPurchased":{"type":"boolean","description":"Indicates whether extras were purchased in the reservation"},"isRefundable":{"type":"boolean","description":"Indicates whether the reservation is refundable"},"highestRoomType":{"type":"string","description":"The most luxurious room booked in the reservation\nExample: Presidential Suite"},"numberOfRooms":{"type":"number","format":"double","description":"The number of rooms booked in the reservation\nMin value: 1\nExample: 2"},"numberOfGuests":{"type":"number","format":"double","description":"The number of guests in the reservation\nMin value: 1\nExample: 4"},"numberOfKids":{"type":"number","format":"double","description":"The number of kids, out of the number of guests in the reservation\nMin value: 0\nExample: 2"}},"required":["reservationId","nights","checkInDate","checkInHour","hotel","wereExtrasPurchased","isRefundable","highestRoomType","numberOfRooms","numberOfGuests","numberOfKids"],"description":"The lodging details of the travel booking","title":"TravelLodging"},"TravelTripHighestClass":{"type":"string","enum":["economy","luxurious"],"description":"`luxurious` if the highest bought travel class in the trip is a luxury class (business/first), `economy` otherwise\nExample: luxurious","title":"TravelTripHighestClass"},"TravelTrip":{"type":"object","properties":{"numberOfFlights":{"type":"number","format":"double","description":"The number of flights in the trip\nMin value: 1\nExample: 2"},"numberOfCheckedBags":{"type":"number","format":"double","description":"The number of checked bags\nMin value: 0\nExample: 1"},"firstWayDestination":{"type":"string","description":"The first-way destination's three-letter IATA airport code\nExample: JFK\nPattern: ^[A-Z]{3}$"},"isRoundTrip":{"type":"boolean","description":"`true` if the trip is a round-trip\nExample: true"},"highestClass":{"$ref":"#/components/schemas/TravelTripHighestClass","description":"`luxurious` if the highest bought travel class in the trip is a luxury class (business/first), `economy` otherwise\nExample: luxurious"},"isFlexibleTicket":{"type":"boolean","description":"True if the trip ticket is a flexible ticket\nExample: true"},"wereExtrasPurchased":{"type":"boolean","description":"True if extras were included in the trip purchase\nExample: true"}},"required":["numberOfFlights","numberOfCheckedBags","firstWayDestination","isRoundTrip","highestClass","isFlexibleTicket","wereExtrasPurchased"],"description":"The trip details of the travel booking","title":"TravelTrip"},"TravelFirstFlight":{"type":"object","properties":{"numberOfTravelers":{"type":"number","format":"double","description":"The number of travelers in the first flight\nMin value: 1\nExample: 2"},"departureTime":{"type":"number","format":"double","description":"The timestamp of the departure, in *milliseconds* since the unix epoch\nExample: 1551398400000"},"departureAirport":{"type":"string","description":"The first-flight departure airport's three-letter IATA code\nExample: JFK\nPattern: ^[A-Z]{3}$"},"duration":{"type":"number","format":"double","description":"The first-flight duration, in hours\nMin value: 0\nExample: 3.5"},"flightNumber":{"type":"string","description":"The alphanumeric flight code\nExample: BA2491A\nPattern: ^[A-Z0-9]+$"}},"required":["numberOfTravelers","departureTime","departureAirport","duration","flightNumber"],"description":"The first flight details of the trip","title":"TravelFirstFlight"},"TravelCartItem":{"type":"object","properties":{"itemClass":{"$ref":"#/components/schemas/TravelCartItemItemClass","description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: travel\nExample: travel"},"id":{"type":"string","description":"The cart items's unique ID\nExample: 5de33332-546a-4171-8988-2a43d2bfe9c6"},"rawProductData":{"$ref":"#/components/schemas/AnyObject"},"sellingPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"listPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"},"lodging":{"$ref":"#/components/schemas/TravelLodging"},"pnr":{"type":"string","description":"The flight ticket's PNR code\nExample: X36Q9C"},"trip":{"$ref":"#/components/schemas/TravelTrip"},"firstFlight":{"$ref":"#/components/schemas/TravelFirstFlight"}},"required":["itemClass","sellingPrice","lodging","pnr","trip","firstFlight"],"description":"Represents a travel booking item in a shopping cart","title":"TravelCartItem"},"FlightTicketCartItemItemClass":{"type":"string","enum":["flightTicket"],"description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: flightTicket\nExample: flightTicket","title":"FlightTicketCartItemItemClass"},"FlightTicketCartItem":{"type":"object","properties":{"itemClass":{"$ref":"#/components/schemas/FlightTicketCartItemItemClass","description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: flightTicket\nExample: flightTicket"},"id":{"type":"string","description":"The cart items's unique ID\nExample: 5de33332-546a-4171-8988-2a43d2bfe9c6"},"rawProductData":{"$ref":"#/components/schemas/AnyObject"},"sellingPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"listPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"},"pnr":{"type":"string","description":"The flight ticket's PNR code\nExample: X36Q9C"},"trip":{"$ref":"#/components/schemas/TravelTrip"},"firstFlight":{"$ref":"#/components/schemas/TravelFirstFlight"}},"required":["itemClass","sellingPrice","pnr","trip","firstFlight"],"description":"Represents a flight ticket item in a shopping cart","title":"FlightTicketCartItem"},"FlightUpgradeCartItemItemClass":{"type":"string","enum":["flightUpgrade"],"description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: flightUpgrade\nExample: flightUpgrade","title":"FlightUpgradeCartItemItemClass"},"FlightUpgradeCartItemUpgradeType":{"type":"string","enum":["changes","fareIncrease","baggage","seats","insurance","other"],"description":"The type of upgrade\nExample: changes","title":"FlightUpgradeCartItemUpgradeType"},"FlightUpgradeCartItem":{"type":"object","properties":{"itemClass":{"$ref":"#/components/schemas/FlightUpgradeCartItemItemClass","description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: flightUpgrade\nExample: flightUpgrade"},"id":{"type":"string","description":"The cart items's unique ID\nExample: 5de33332-546a-4171-8988-2a43d2bfe9c6"},"rawProductData":{"$ref":"#/components/schemas/AnyObject"},"sellingPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"listPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"},"pnr":{"type":"string","description":"The flight ticket's PNR code\nExample: X36Q9C"},"upgradeType":{"$ref":"#/components/schemas/FlightUpgradeCartItemUpgradeType","description":"The type of upgrade\nExample: changes"},"description":{"type":"string","description":"The upgrade description, required when the upgrade type is `other`"}},"required":["itemClass","sellingPrice","upgradeType"],"description":"Represents a flight upgrade item in a shopping cart","title":"FlightUpgradeCartItem"},"LodgingCartItemItemClass":{"type":"string","enum":["lodging"],"description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: lodging\nExample: lodging","title":"LodgingCartItemItemClass"},"LodgingCartItem":{"type":"object","properties":{"reservationId":{"type":"string","description":"Hotel reservation id\nExample: X36Q9C"},"nights":{"type":"number","format":"double","description":"The number of nights booked in the reservation\nMin value: 1\nExample: 2"},"checkInDate":{"type":"string","description":"The check-in date\nExample: 2022-05-02"},"checkInHour":{"type":"string","description":"The hour of day in which the check-in is done\nExample: 18\nPattern: ^([01][0-9]|2[0-3])$"},"hotel":{"$ref":"#/components/schemas/TravelLodgingHotel"},"wereExtrasPurchased":{"type":"boolean","description":"Indicates whether extras were purchased in the reservation"},"isRefundable":{"type":"boolean","description":"Indicates whether the reservation is refundable"},"highestRoomType":{"type":"string","description":"The most luxurious room booked in the reservation\nExample: Presidential Suite"},"numberOfRooms":{"type":"number","format":"double","description":"The number of rooms booked in the reservation\nMin value: 1\nExample: 2"},"numberOfGuests":{"type":"number","format":"double","description":"The number of guests in the reservation\nMin value: 1\nExample: 4"},"numberOfKids":{"type":"number","format":"double","description":"The number of kids, out of the number of guests in the reservation\nMin value: 0\nExample: 2"},"itemClass":{"$ref":"#/components/schemas/LodgingCartItemItemClass","description":"Denotes the cart item class. The item schema is chosen based on this value.\nAllowed value: lodging\nExample: lodging"},"id":{"type":"string","description":"The cart items's unique ID\nExample: 5de33332-546a-4171-8988-2a43d2bfe9c6"},"rawProductData":{"$ref":"#/components/schemas/AnyObject"},"sellingPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"listPrice":{"$ref":"#/components/schemas/CurrencyAmount"},"recipientInfo":{"$ref":"#/components/schemas/RecipientInfo"}},"required":["reservationId","nights","checkInDate","checkInHour","hotel","wereExtrasPurchased","isRefundable","highestRoomType","numberOfRooms","numberOfGuests","numberOfKids","itemClass","sellingPrice"],"description":"Represents a lodging reservation item in a shopping cart.\nThe reservation fields are flattened at the top level of the item.","title":"LodgingCartItem"},"CartItemClassOmitted":{"oneOf":[{"$ref":"#/components/schemas/Pick_nftCartItem.Exclude_keyofnftCartItem.sellingPrice-or-itemClass__"},{"$ref":"#/components/schemas/Pick_GiftCardCartItem.Exclude_keyofGiftCardCartItem.listPrice__"},{"$ref":"#/components/schemas/CryptoCartItem"},{"$ref":"#/components/schemas/MoneyTopUpCartItem"},{"$ref":"#/components/schemas/TravelCartItem"},{"$ref":"#/components/schemas/FlightTicketCartItem"},{"$ref":"#/components/schemas/FlightUpgradeCartItem"},{"$ref":"#/components/schemas/LodgingCartItem"}],"title":"CartItemClassOmitted"},"CartClassOmitted":{"type":"array","items":{"$ref":"#/components/schemas/CartItemClassOmitted"},"description":"Cart item details required for Coinflow Chargeback Protection. Required if the merchant uses chargeback protection.","title":"CartClassOmitted"},"Cents":{"type":"object","properties":{"cents":{"type":"integer","minimum":0}},"required":["cents"],"title":"Cents"},"AchCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"AchCheckoutArgsRentLamports"},"AchCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/AchCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"AchCheckoutArgsRent"},"SafeMintRedeemTransaction":{"type":"object","properties":{"data":{"type":"string","description":"The data to call this contract with, HEX encoded.\n\nThe coinflow contract calls the \"to\" contract, contract pulls USDC from msg.sender, and transfers the NFT/item to the \"receiver\" address defined in the contract function arguments."},"to":{"type":"string","description":"The merchant's whitelisted contract"}},"required":["data","to"],"description":"Transaction to be called.","title":"SafeMintRedeemTransaction"},"SafeMintRedeemType":{"type":"string","enum":["safeMint"],"title":"SafeMintRedeemType"},"SafeMintRedeem":{"type":"object","properties":{"waitForHash":{"type":"boolean","description":"Whether the UI should wait\nfor the transaction to be sent and\nthe hash to be returned."},"transaction":{"$ref":"#/components/schemas/SafeMintRedeemTransaction","description":"Transaction to be called."},"type":{"$ref":"#/components/schemas/SafeMintRedeemType"},"nftContract":{"type":"string"}},"required":["transaction","type"],"description":"(EVM only) If your contract mints an NFT via a OpenZeppelin Safe Mint Call, then utilize this object.\n\nThe contract mints the NFT to msg.sender (which is the Coinflow contract), the Coinflow contract picks up the SafeMint event, and fwd's the NFT to the end user's wallet.","title":"SafeMintRedeem"},"ReturnedTokenIdRedeemTransaction":{"type":"object","properties":{"data":{"type":"string","description":"The data to call this contract with, HEX encoded.\n\nThe coinflow contract calls the \"to\" contract, contract pulls USDC from msg.sender, and transfers the NFT/item to the \"receiver\" address defined in the contract function arguments."},"to":{"type":"string","description":"The merchant's whitelisted contract"}},"required":["data","to"],"description":"Transaction to be called.","title":"ReturnedTokenIdRedeemTransaction"},"ReturnedTokenIdRedeemType":{"type":"string","enum":["returned"],"title":"ReturnedTokenIdRedeemType"},"ReturnedTokenIdRedeem":{"type":"object","properties":{"waitForHash":{"type":"boolean","description":"Whether the UI should wait\nfor the transaction to be sent and\nthe hash to be returned."},"transaction":{"$ref":"#/components/schemas/ReturnedTokenIdRedeemTransaction","description":"Transaction to be called."},"type":{"$ref":"#/components/schemas/ReturnedTokenIdRedeemType"},"nftContract":{"type":"string"}},"required":["transaction","type"],"description":"(EVM only) If your contract returns the NFT ID, then utilize this object.\n\nThe contract mints the NFT to msg.sender (which is the Coinflow contract), the Coinflow contract picks up the returned NFT ID, and fwd's the NFT to the end user's wallet.","title":"ReturnedTokenIdRedeem"},"KnownTokenIdRedeemTransaction":{"type":"object","properties":{"data":{"type":"string","description":"The data to call this contract with, HEX encoded.\n\nThe coinflow contract calls the \"to\" contract, contract pulls USDC from msg.sender, and transfers the NFT/item to the \"receiver\" address defined in the contract function arguments."},"to":{"type":"string","description":"The merchant's whitelisted contract"}},"required":["data","to"],"description":"Transaction to be called.","title":"KnownTokenIdRedeemTransaction"},"KnownTokenIdRedeem":{"type":"object","properties":{"waitForHash":{"type":"boolean","description":"Whether the UI should wait\nfor the transaction to be sent and\nthe hash to be returned."},"transaction":{"$ref":"#/components/schemas/KnownTokenIdRedeemTransaction","description":"Transaction to be called."},"nftContract":{"type":"string","minLength":42,"maxLength":42,"description":"The address of the Nft's Contract"},"nftId":{"type":"string","minLength":1,"description":"The ID of the NFT being purchased. Will be forwarded by the Coinflow contract to the customer's wallet."}},"required":["transaction","nftContract","nftId"],"description":"(EVM only) If your know the ID of the NFT being purchased, then utilize this object.\n\nThe contract transfers the NFT to msg.sender (which is the Coinflow contract), the Coinflow contract fwd's the NFT to the end user's wallet.","title":"KnownTokenIdRedeem"},"NormalRedeemTransaction":{"type":"object","properties":{"data":{"type":"string","description":"The data to call this contract with, HEX encoded.\n\nThe coinflow contract calls the \"to\" contract, contract pulls USDC from msg.sender, and transfers the NFT/item to the \"receiver\" address defined in the contract function arguments."},"to":{"type":"string","description":"The merchant's whitelisted contract"}},"required":["data","to"],"description":"Transaction to be called.","title":"NormalRedeemTransaction"},"NormalRedeem":{"type":"object","properties":{"waitForHash":{"type":"boolean","description":"Whether the UI should wait\nfor the transaction to be sent and\nthe hash to be returned."},"transaction":{"$ref":"#/components/schemas/NormalRedeemTransaction","description":"Transaction to be called."}},"required":["transaction"],"description":"(EVM only) If your contract sends the item/service being purchased via a custom \"receiver\" field, then utilize this object.\n\nThe coinflow contract calls the \"to\" contract, which transfers the NFT/item to the \"receiver\" address defined in the contract function arguments.","title":"NormalRedeem"},"TokenRedeemType":{"type":"string","enum":["token"],"title":"TokenRedeemType"},"TokenRedeem":{"type":"object","properties":{"waitForHash":{"type":"boolean","description":"Whether the UI should wait\nfor the transaction to be sent and\nthe hash to be returned."},"type":{"$ref":"#/components/schemas/TokenRedeemType"},"destination":{"type":"string"}},"required":["type","destination"],"title":"TokenRedeem"},"DecentRedeemType":{"type":"string","enum":["decent"],"title":"DecentRedeemType"},"DecentRedeemCost":{"type":"object","properties":{"isNative":{"type":"boolean","description":"Whether or not the token is the native token for the chain (ex: Ethereum - ETH, Polygon - POL).\nIf native dstToken should be the 0 address (0x00...)"},"amount":{"type":"string","description":"This is the raw amount of the token\nex: 50000000000000n"}},"required":["isNative","amount"],"description":"Amount of the token on the destination chain you will be receiving","title":"DecentRedeemCost"},"DecentRedeem":{"type":"object","properties":{"waitForHash":{"type":"boolean","description":"Whether the UI should wait\nfor the transaction to be sent and\nthe hash to be returned."},"type":{"$ref":"#/components/schemas/DecentRedeemType"},"dstChainId":{"type":"number","format":"double","description":"ID of the destination chain you will be using\nFind your chain ID here: https://chainlist.org/"},"dstToken":{"type":"string","description":"Address on that chain of the token you will be receiving"},"contractAddress":{"type":"string","description":"The contract address which will be called on the destination chain"},"contractData":{"type":"string"},"cost":{"$ref":"#/components/schemas/DecentRedeemCost","description":"Amount of the token on the destination chain you will be receiving"}},"required":["type","dstChainId","dstToken","contractAddress","contractData","cost"],"description":"If your contract exists on a chain supported by Decent, pass this object in order to call it.","title":"DecentRedeem"},"EvmTransactionData":{"oneOf":[{"$ref":"#/components/schemas/SafeMintRedeem"},{"$ref":"#/components/schemas/ReturnedTokenIdRedeem"},{"$ref":"#/components/schemas/KnownTokenIdRedeem"},{"$ref":"#/components/schemas/NormalRedeem"},{"$ref":"#/components/schemas/TokenRedeem"},{"$ref":"#/components/schemas/DecentRedeem"}],"description":"(EVM only) if you want to execute an EVM transaction on a successful purchase, you can pass a transaction request here.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer. Optionally the merchant can opt to pay for these gas fees.","title":"EvmTransactionData"},"SettlementType":{"type":"string","enum":["Credits","USDC"],"title":"SettlementType"},"ThreeDsChallengePreference":{"type":"string","enum":["NoPreference","Frictionless","Challenge"],"title":"ThreeDsChallengePreference"},"IUserLocation":{"type":"object","properties":{"lat":{"type":"number","format":"double"},"lng":{"type":"number","format":"double"}},"required":["lat","lng"],"description":"End-user geographic coordinates captured at the moment of the withdrawal\nrequest. Consumed by `BlockingRuleMethod.GEOLOCATION` enforcement.\n\nReplay-of-different-coords bypass is prevented server-side: the first\nresolved {country, state} for a given (merchant, user) pair is pinned in\nRedis, and subsequent requests are evaluated against that pinned value\nregardless of the lat/lng they submit.","title":"IUserLocation"},"OrderType":{"type":"string","enum":["one_time_purchase","recurring_subscription","recurring_balance_top_up","limit_order","fair_market_value"],"title":"OrderType"},"AchCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"rent":{"$ref":"#/components/schemas/AchCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"token":{"type":"string","description":"Token for the bankAccount to be used for the checkout."},"transaction":{"type":["string","null"],"description":"- (Solana): A Base58 encoded transaction"},"orderType":{"$ref":"#/components/schemas/OrderType"},"achAuthorizationId":{"type":"string","description":"If this debit is a subsequent charge (recurring/top-up/limit-order/\nfair-market-value fill) under a previously submitted ACH authorization,\npass that authorization's founding `paymentId` here so this debit is\ntraceable back to the same authorization record."}},"required":["subtotal","token"],"title":"AchCheckoutArgs"},"CheckoutResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."}},"required":["paymentId"],"title":"CheckoutResponse"},"VerificationStatus":{"type":"string","enum":["pending","partial-approval","approved","rejected","expired"],"title":"VerificationStatus"},"VerificationVendor":{"type":"string","enum":["middesk","sumsub","sumsub_docv","persona","persona_kyb"],"title":"VerificationVendor"},"Verification":{"type":"object","properties":{"reference":{"type":"string"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"vendor":{"$ref":"#/components/schemas/VerificationVendor"},"name":{"type":"string"},"attested":{"type":"boolean"},"shareToken":{"type":"string"},"shareTokenStatus":{"type":"string"},"sessionToken":{"type":"string"},"rejectionReasons":{"type":"array","items":{"type":"string"}}},"required":["reference","status","vendor"],"title":"Verification"},"AdditionalVerification":{"type":"object","properties":{"name":{"type":"string"},"link":{"type":"string"},"reference":{"type":"string"},"vendor":{"$ref":"#/components/schemas/VerificationVendor"},"sessionToken":{"type":"string"}},"required":["name","link","reference","vendor"],"title":"AdditionalVerification"},"VerificationRequiredResponse":{"type":"object","properties":{"verification":{"$ref":"#/components/schemas/Verification"},"verificationLink":{"type":"string","description":"Link which can be hosted in an iframe or redirect the user to complete verification."},"redirectLink":{"type":"string","description":"Link where the user will be redirected to upon successful verification."},"additionalVerificationLinks":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalVerification"},"description":"Additional links which can be hosted in an iframe or redirect the user to complete verification."},"rejectionReasons":{"type":"array","items":{"type":"string"},"description":"List of reasons as to why the verification was rejected."}},"required":["verification"],"title":"VerificationRequiredResponse"},"CurrencyCents":{"type":"object","properties":{"cents":{"type":"integer","minimum":0},"currency":{"$ref":"#/components/schemas/Currency"}},"required":["cents","currency"],"title":"CurrencyCents"},"TokenSubtotalAmount":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"description":"Number of tokens","title":"TokenSubtotalAmount"},"TokenSubtotal":{"type":"object","properties":{"address":{"type":"string","description":"The tokens address\n\nSolana - Token Mint Address\nEvm - Token Contract Address"},"amount":{"$ref":"#/components/schemas/TokenSubtotalAmount","description":"Number of tokens"},"decimals":{"type":"number","format":"double","description":"Number of decimals for the token"}},"required":["address","amount"],"title":"TokenSubtotal"},"Subtotal":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/Cents"},{"$ref":"#/components/schemas/TokenSubtotal"}],"title":"Subtotal"},"ApaCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"ApaCheckoutArgsRentLamports"},"ApaCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/ApaCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"ApaCheckoutArgsRent"},"CustomerUsdcTransferDataV2ValidAfter":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CustomerUsdcTransferDataV2ValidAfter"},"CustomerUsdcTransferDataV2ValidBefore":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CustomerUsdcTransferDataV2ValidBefore"},"CustomerUsdcTransferDataV2":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"value":{"type":"string"},"validAfter":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2ValidAfter"},"validBefore":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2ValidBefore"},"nonce":{"type":"string"},"signature":{"type":"string"}},"required":["from","to","value","validAfter","validBefore","nonce","signature"],"description":"V2 of CustomerUsdcTransferData — replaces the (v, r, s) triple with a single\n`signature` bytes string, matching USDC FiatTokenV2_2's bytes-overload\n`transferWithAuthorization`. All other fields unchanged from V1.","title":"CustomerUsdcTransferDataV2"},"ApaCredentialType.PHONE":{"type":"string","enum":["PHONE"],"title":"ApaCredentialType.PHONE"},"ApaCredentialType.EMAIL":{"type":"string","enum":["EMAIL"],"title":"ApaCredentialType.EMAIL"},"Exclude_ApaCredentialType.ApaCredentialType.PAN_":{"oneOf":[{"$ref":"#/components/schemas/ApaCredentialType.PHONE"},{"$ref":"#/components/schemas/ApaCredentialType.EMAIL"}],"description":"Exclude from T those types that are assignable to U","title":"Exclude_ApaCredentialType.ApaCredentialType.PAN_"},"ApaCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/ApaCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"credentialType":{"$ref":"#/components/schemas/Exclude_ApaCredentialType.ApaCredentialType.PAN_"},"credentialValue":{"type":"string","description":"Lowercased email or E.164-formatted phone number, matching credentialType."},"email":{"type":"string","description":"Email for new customers paying with a phone APA credential. Not needed\nwhen credentialType is EMAIL (credentialValue is used as the email)."}},"required":["subtotal","credentialType","credentialValue"],"title":"ApaCheckoutArgs"},"Checkout_ApaCheckout_Response_200":{"type":"object","properties":{"paymentId":{"type":"string"}},"required":["paymentId"],"title":"Checkout_ApaCheckout_Response_200"},"Pick_VerificationRequiredResponse.verification-or-verificationLink_":{"type":"object","properties":{"verification":{"$ref":"#/components/schemas/Verification"},"verificationLink":{"type":"string","description":"Link which can be hosted in an iframe or redirect the user to complete verification."}},"required":["verification"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_VerificationRequiredResponse.verification-or-verificationLink_"},"RecipientAftInfo":{"type":"object","properties":{"firstName":{"type":"string","minLength":2},"lastName":{"type":"string","minLength":2},"address1":{"type":"string","minLength":2},"city":{"type":"string","minLength":2},"postalCode":{"type":"string","minLength":2},"state":{"type":"string","minLength":2},"countryCode":{"type":"string","minLength":2,"maxLength":2},"dateOfBirth":{"type":"string","pattern":"^\\d{8}$","description":"Recipients Date Of Birth in YYYMMDD format."},"phoneNumber":{"type":"string","pattern":"^\\d+$"},"documentReference":{"type":"string"}},"required":["firstName","lastName","address1","city","postalCode","countryCode"],"title":"RecipientAftInfo"},"AccountFundingTransaction":{"type":"object","properties":{"recipientAftInfo":{"$ref":"#/components/schemas/RecipientAftInfo"}},"description":"Used for Account Funding Transactions","title":"AccountFundingTransaction"},"ApplePayCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"ApplePayCheckoutArgsRentLamports"},"ApplePayCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/ApplePayCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"ApplePayCheckoutArgsRent"},"ChargebackProtectionAccountType":{"type":"string","enum":["guest","private","business"],"title":"ChargebackProtectionAccountType"},"CustomerUsdcTransferDataValidAfter":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CustomerUsdcTransferDataValidAfter"},"CustomerUsdcTransferDataValidBefore":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CustomerUsdcTransferDataValidBefore"},"CustomerUsdcTransferData":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"value":{"type":"string"},"validAfter":{"$ref":"#/components/schemas/CustomerUsdcTransferDataValidAfter"},"validBefore":{"$ref":"#/components/schemas/CustomerUsdcTransferDataValidBefore"},"nonce":{"type":"string"},"v":{"type":"number","format":"double"},"r":{"type":"string"},"s":{"type":"string"}},"required":["from","to","value","validAfter","validBefore","nonce","v","r","s"],"description":"Customer signed USDC transferWithAuthorization data for dual-source payments\nUsed for combined USDC + Credit Card payments on EVM chains","title":"CustomerUsdcTransferData"},"ApplePayPaymentTokenPaymentMethodType":{"type":"string","enum":["","debit","credit","prepaid","store"],"description":"A value representing the card's type of payment.\n\nOptional: Apple omits this field (or sends an empty string) for cards it\ndoes not classify, including some Amex corporate/commercial cards. Treat\na missing value as unknown rather than assuming a funding type.","title":"ApplePayPaymentTokenPaymentMethodType"},"ApplePayPaymentTokenPaymentMethodNetwork1":{"type":"string","enum":["Visa"],"title":"ApplePayPaymentTokenPaymentMethodNetwork1"},"ApplePayPaymentTokenPaymentMethodNetwork":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ApplePayPaymentTokenPaymentMethodNetwork1"}],"description":"A string, suitable for display, that is the name of the payment network backing the card.","title":"ApplePayPaymentTokenPaymentMethodNetwork"},"ApplePayPaymentTokenPaymentMethod":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ApplePayPaymentTokenPaymentMethodType","description":"A value representing the card's type of payment.\n\nOptional: Apple omits this field (or sends an empty string) for cards it\ndoes not classify, including some Amex corporate/commercial cards. Treat\na missing value as unknown rather than assuming a funding type."},"network":{"$ref":"#/components/schemas/ApplePayPaymentTokenPaymentMethodNetwork","description":"A string, suitable for display, that is the name of the payment network backing the card."},"displayName":{"type":"string","description":"A string, suitable for display, that describes the card."}},"required":["network","displayName"],"description":"Information about the card used in the transaction.","title":"ApplePayPaymentTokenPaymentMethod"},"ApplePayPaymentTokenPaymentDataHeader":{"type":"object","properties":{"transactionId":{"type":"string"},"ephemeralPublicKey":{"type":"string"},"publicKeyHash":{"type":"string"}},"required":["transactionId","ephemeralPublicKey","publicKeyHash"],"title":"ApplePayPaymentTokenPaymentDataHeader"},"ApplePayPaymentTokenPaymentData":{"type":"object","properties":{"version":{"type":"string"},"header":{"$ref":"#/components/schemas/ApplePayPaymentTokenPaymentDataHeader"},"signature":{"type":"string"},"data":{"type":"string"}},"required":["version","header","signature","data"],"description":"An object containing the encrypted payment data.","title":"ApplePayPaymentTokenPaymentData"},"ApplePayPaymentToken":{"type":"object","properties":{"transactionIdentifier":{"type":"string","description":"A unique identifier for this payment."},"paymentMethod":{"$ref":"#/components/schemas/ApplePayPaymentTokenPaymentMethod","description":"Information about the card used in the transaction."},"paymentData":{"$ref":"#/components/schemas/ApplePayPaymentTokenPaymentData","description":"An object containing the encrypted payment data."}},"required":["transactionIdentifier","paymentMethod","paymentData"],"title":"ApplePayPaymentToken"},"ApplePayBillingContact":{"type":"object","properties":{"givenName":{"type":"string","description":"The contact's given name."},"familyName":{"type":"string","description":"The contact's family name."},"addressLines":{"type":"array","items":{"type":"string"},"description":"The street portion of the address for the contact."},"country":{"type":"string","description":"The name of the country for the contact."},"emailAddress":{"type":"string","description":"An email address for the contact."},"postalCode":{"type":"string","description":"The zip code or postal code, where applicable, for the contact."},"locality":{"type":"string","description":"The city for the contact."},"administrativeArea":{"type":"string","description":"The state for the contact."},"subAdministrativeArea":{"type":"string","description":"The subadministrative area (such as a county or other region) in a postal address."},"countryCode":{"type":"string","description":"The contact’s two-letter ISO 3166 country code."}},"required":["givenName","familyName","addressLines"],"title":"ApplePayBillingContact"},"Pick_ApplePayJS.ApplePayPaymentContact.emailAddress_":{"type":"object","properties":{"emailAddress":{"type":"string","description":"An email address for the contact."}},"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_ApplePayJS.ApplePayPaymentContact.emailAddress_"},"PaymentData":{"type":"object","properties":{"onlinePaymentCryptogram":{"type":"string"},"eciIndicator":{"type":"string"}},"required":["onlinePaymentCryptogram"],"title":"PaymentData"},"DecryptedApplePayToken":{"type":"object","properties":{"applicationPrimaryAccountNumber":{"type":"string"},"applicationExpirationDate":{"type":"string"},"currencyCode":{"type":"string"},"transactionAmount":{"type":"number","format":"double"},"deviceManufacturerIdentifier":{"type":"string"},"paymentDataType":{"type":"string"},"paymentData":{"$ref":"#/components/schemas/PaymentData"}},"required":["applicationPrimaryAccountNumber","applicationExpirationDate","currencyCode","transactionAmount","deviceManufacturerIdentifier","paymentDataType","paymentData"],"title":"DecryptedApplePayToken"},"ApplePayPayment":{"type":"object","properties":{"token":{"$ref":"#/components/schemas/ApplePayPaymentToken"},"billingContact":{"$ref":"#/components/schemas/ApplePayBillingContact"},"shippingContact":{"$ref":"#/components/schemas/Pick_ApplePayJS.ApplePayPaymentContact.emailAddress_"},"decrypted":{"$ref":"#/components/schemas/DecryptedApplePayToken"}},"required":["token","billingContact"],"description":"Apple Pay Payment received from the Apple Pay SDK\n\nDetails can be found here: https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment","title":"ApplePayPayment"},"ApplePayCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"rent":{"$ref":"#/components/schemas/ApplePayCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"presentment":{"$ref":"#/components/schemas/Currency"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"applePayPayment":{"$ref":"#/components/schemas/ApplePayPayment"}},"required":["subtotal","applePayPayment"],"title":"ApplePayCheckoutArgs"},"CapturePaymentRequestRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CapturePaymentRequestRentLamports"},"CapturePaymentRequestRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/CapturePaymentRequestRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"CapturePaymentRequestRent"},"CapturePaymentRequest":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"rent":{"$ref":"#/components/schemas/CapturePaymentRequestRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"}},"required":["paymentId","subtotal"],"description":"From T, pick a set of properties whose keys are in the union K","title":"CapturePaymentRequest"},"CheckoutCapturePostResponsesContentApplicationJsonSchemaJobId":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"CheckoutCapturePostResponsesContentApplicationJsonSchemaJobId"},"Checkout_CapturePayment_Response_200":{"type":"object","properties":{"jobId":{"$ref":"#/components/schemas/CheckoutCapturePostResponsesContentApplicationJsonSchemaJobId"}},"required":["jobId"],"title":"Checkout_CapturePayment_Response_200"},"CardCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CardCheckoutArgsRentLamports"},"CardCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/CardCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"CardCheckoutArgsRent"},"VersionInfo":{"type":"object","properties":{"url":{"type":"string"},"transactionId":{"type":"string"},"directoryServer":{"type":"string"},"version":{"type":"string"}},"required":["transactionId","directoryServer","version"],"title":"VersionInfo"},"Device3DSInfo":{"type":"object","properties":{"colorDepth":{"type":"number","format":"double"},"screenHeight":{"type":"number","format":"double"},"screenWidth":{"type":"number","format":"double"},"timeZone":{"type":"number","format":"double"},"versionInfo":{"type":"array","items":{"$ref":"#/components/schemas/VersionInfo"}}},"required":["colorDepth","screenHeight","screenWidth","timeZone"],"title":"Device3DSInfo"},"External3DSInfo":{"type":"object","properties":{"transactionId":{"type":"string"},"cavv":{"type":"string"},"eci":{"type":"string"},"dsTransactionId":{"type":"string"},"acsTransactionId":{"type":"string"},"version":{"type":"string"}},"required":["transactionId","cavv","eci","dsTransactionId","acsTransactionId","version"],"description":"External 3DS info, if provided must call the endpoint\nwith API key or checkout JWT.","title":"External3DSInfo"},"ConcludeChallenge":{"type":"object","properties":{"transactionId":{"type":"string"}},"required":["transactionId"],"title":"ConcludeChallenge"},"Authentication3DS":{"oneOf":[{"$ref":"#/components/schemas/Device3DSInfo"},{"$ref":"#/components/schemas/External3DSInfo"},{"$ref":"#/components/schemas/ConcludeChallenge"}],"description":"3DS Card Authorization Data\n\nOn initial payment submission - Device3DSInfo needed:\n 3DS device information - required if 3DS is enabled\n\nAfter card challenge complete:\n 3DS challenge transaction id - required after prompted for challenge","title":"Authentication3DS"},"CardDataAdditionalVendorData":{"type":"object","properties":{},"description":"Optional non-PCI passthrough fields merged into the stored card vendorData.\nBase type is empty; tokenization providers extend it with their own fields.","title":"CardDataAdditionalVendorData"},"CardData":{"type":"object","properties":{"cardToken":{"type":"string","minLength":1,"description":"This is the card token received from the `CoinflowCardNumberInput`"},"expYear":{"type":"string","pattern":"^\\d+$","minLength":2,"maxLength":2,"description":"The Cards Expiration Year ex: 2026 => 26"},"expMonth":{"type":"string","pattern":"^\\d+$","minLength":2,"maxLength":2,"description":"The Cards Expiration Month ex: January => 01 December => 12"},"additionalVendorData":{"$ref":"#/components/schemas/CardDataAdditionalVendorData","description":"Optional non-PCI passthrough fields merged into the stored card vendorData.\nBase type is empty; tokenization providers extend it with their own fields."},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"businessName":{"type":"string"},"firstName":{"type":"string","minLength":2},"lastName":{"type":"string","minLength":2},"address1":{"type":"string","minLength":1},"city":{"type":"string","minLength":1},"zip":{"type":"string"},"state":{"type":"string"},"country":{"type":"string","minLength":2,"maxLength":2}},"required":["cardToken","expYear","expMonth","email","firstName","lastName","address1","city","country"],"title":"CardData"},"CardDataWithoutAddressAdditionalVendorData":{"type":"object","properties":{},"description":"Optional non-PCI passthrough fields merged into the stored card vendorData.\nBase type is empty; tokenization providers extend it with their own fields.","title":"CardDataWithoutAddressAdditionalVendorData"},"CardDataWithoutAddress":{"type":"object","properties":{"cardToken":{"type":"string","minLength":1,"description":"This is the card token received from the `CoinflowCardNumberInput`"},"expYear":{"type":"string","pattern":"^\\d+$","minLength":2,"maxLength":2,"description":"The Cards Expiration Year ex: 2026 => 26"},"expMonth":{"type":"string","pattern":"^\\d+$","minLength":2,"maxLength":2,"description":"The Cards Expiration Month ex: January => 01 December => 12"},"additionalVendorData":{"$ref":"#/components/schemas/CardDataWithoutAddressAdditionalVendorData","description":"Optional non-PCI passthrough fields merged into the stored card vendorData.\nBase type is empty; tokenization providers extend it with their own fields."},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"businessName":{"type":"string"},"firstName":{"type":"string","minLength":2},"lastName":{"type":"string","minLength":2}},"required":["cardToken","expYear","expMonth","email","firstName","lastName"],"title":"CardDataWithoutAddress"},"CardCheckoutArgsCard":{"oneOf":[{"$ref":"#/components/schemas/CardData"},{"$ref":"#/components/schemas/CardDataWithoutAddress"}],"description":"Credit card information.\n<b>Always</b> pass address unless explicitly told that you may not","title":"CardCheckoutArgsCard"},"CardCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/CardCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"presentment":{"$ref":"#/components/schemas/Currency"},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"card":{"$ref":"#/components/schemas/CardCheckoutArgsCard","description":"Credit card information.\n<b>Always</b> pass address unless explicitly told that you may not"},"saveCard":{"type":"boolean","description":"Save the new card? If not passed in, will default to true"}},"required":["subtotal","card"],"title":"CardCheckoutArgs"},"CardCheckoutResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."},"authorizationExpiration":{"type":"string","description":"The datetime when this authorization expires and subsequent card-on-file\nor merchant-initiated transactions can no longer be made. After this time,\nthe card must be re-authorized via another CIT transaction.\nOnly present when card-on-file or MIT settings are enabled on the merchant."}},"required":["paymentId"],"title":"CardCheckoutResponse"},"ChallengeFields":{"type":"object","properties":{"transactionId":{"type":"string"},"url":{"type":"string"},"creq":{"type":"string"}},"required":["transactionId","url","creq"],"title":"ChallengeFields"},"Checkout_CardOnFileAuthorized_Response_200":{"type":"object","properties":{"authorized":{"type":"boolean"}},"required":["authorized"],"title":"Checkout_CardOnFileAuthorized_Response_200"},"RevalidateCVVFields":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}},"required":["message","reason"],"title":"RevalidateCVVFields"},"CardOnFileCheckoutArgsWithOriginalPaymentIdRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CardOnFileCheckoutArgsWithOriginalPaymentIdRentLamports"},"CardOnFileCheckoutArgsWithOriginalPaymentIdRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/CardOnFileCheckoutArgsWithOriginalPaymentIdRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"CardOnFileCheckoutArgsWithOriginalPaymentIdRent"},"CardOnFileCheckoutArgsWithOriginalPaymentId":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"rent":{"$ref":"#/components/schemas/CardOnFileCheckoutArgsWithOriginalPaymentIdRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"presentment":{"$ref":"#/components/schemas/Currency"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"originalPaymentId":{"type":"string","description":"The payment ID of the original authorization."}},"required":["subtotal","originalPaymentId"],"description":"Card on file using the original payment ID","title":"CardOnFileCheckoutArgsWithOriginalPaymentId"},"CardOnFileCheckoutArgsWithTokenRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CardOnFileCheckoutArgsWithTokenRentLamports"},"CardOnFileCheckoutArgsWithTokenRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/CardOnFileCheckoutArgsWithTokenRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"CardOnFileCheckoutArgsWithTokenRent"},"CardOnFileCheckoutArgsWithToken":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"rent":{"$ref":"#/components/schemas/CardOnFileCheckoutArgsWithTokenRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"presentment":{"$ref":"#/components/schemas/Currency"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"token":{"type":"string","description":"Token for the card to be used for the card on file purchase. Must\nhave been previously authorized with a CVV."}},"required":["subtotal","token"],"description":"Card on file using a token","title":"CardOnFileCheckoutArgsWithToken"},"CardOnFileCheckoutArgs":{"oneOf":[{"$ref":"#/components/schemas/CardOnFileCheckoutArgsWithOriginalPaymentId"},{"$ref":"#/components/schemas/CardOnFileCheckoutArgsWithToken"}],"title":"CardOnFileCheckoutArgs"},"CashAppCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CashAppCheckoutArgsRentLamports"},"CashAppCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/CashAppCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"CashAppCheckoutArgsRent"},"CashAppCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/CashAppCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"email":{"type":"string"}},"required":["subtotal"],"title":"CashAppCheckoutArgs"},"Checkout_CashAppCheckout_Response_200":{"type":"object","properties":{"expiresAt":{"type":"string","format":"date-time"},"cashAppLink":{"type":"string"},"paymentId":{"type":"string"}},"required":["expiresAt","cashAppLink","paymentId"],"title":"Checkout_CashAppCheckout_Response_200"},"CreateAchAuthorizationRequest":{"type":"object","properties":{"renderedAuthorizationText":{"type":"string","description":"Exact disclosure text shown to the end user at consent time."},"consentTimestamp":{"type":"string","format":"date-time"},"sessionAuthRef":{"type":"string","description":"Reference/ID for the customer's authenticated session at consent time."},"idempotencyKey":{"type":"string","description":"A key unique to this intended checkout (a UUID you generate is fine).\nPassing the same key on a retried call returns the original\nauthorization instead of creating a duplicate."},"customerId":{"type":"string","description":"Required when authenticating as merchant-admin/admin (no customer\nsession to resolve one from); ignored for customer session-key calls,\nwhere the customer is resolved from the session instead."},"token":{"type":"string","description":"Purse token for the bank account being authorized."}},"required":["renderedAuthorizationText","consentTimestamp","sessionAuthRef","idempotencyKey","token"],"description":"Creates an ACH authorization record *before* the payment it will back —\n`achCheckout` requires a valid authorization id when the merchant's\n`achSettings.allowedOrderTypes` is configured. See\n`AchAuthorizationService.createAuthorization`.","title":"CreateAchAuthorizationRequest"},"AuthorizationStatusEvent":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/AuthorizationEventType"},"occurredAt":{"type":"string","format":"date-time","description":"When the status actually changed, as reported by the merchant."},"recordedAt":{"type":"string","format":"date-time","description":"When Coinflow recorded this event."}},"required":["eventType","occurredAt","recordedAt"],"title":"AuthorizationStatusEvent"},"IAchAuthorization_string_":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time"},"revoked":{"type":"boolean","description":"Once true, no further payments may use this authorization."},"statusHistory":{"type":"array","items":{"$ref":"#/components/schemas/AuthorizationStatusEvent"}},"status":{"$ref":"#/components/schemas/AuthorizationEventType"},"accountLastFour":{"type":"string"},"routingNumber":{"type":"string"},"renderedAuthorizationText":{"type":"string"},"consentTimestamp":{"type":"string","format":"date-time"},"sessionAuthRef":{"type":"string"},"merchant":{"type":"string"},"customerId":{"type":"string"},"idempotencyKey":{"type":"string","description":"Guarantees at most one authorization per intended checkout even if the create call is retried."},"paymentId":{"type":"string","description":"The founding ACH payment's external `paymentId`, linked in once that\npayment is created. Unset until then — the authorization itself must\nexist before its founding payment does. `achAuthorizationId` on\ncheckout/subsequent-debit calls always refers to this record's own\n`_id`, not this field."},"_id":{"type":"string"}},"required":["createdAt","revoked","statusHistory","accountLastFour","routingNumber","renderedAuthorizationText","consentTimestamp","sessionAuthRef","merchant","customerId","idempotencyKey","_id"],"description":"Discriminated union keyed by `orderType`, matching the payload shape\nTradepost sends on authorization submission (GitHub issue #17898).","title":"IAchAuthorization_string_"},"PixCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"PixCheckoutArgsRentLamports"},"PixCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/PixCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"PixCheckoutArgsRent"},"PixCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/PixCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"merchantId":{"type":"string","description":"Merchant Identifier"}},"required":["subtotal","email","merchantId"],"title":"PixCheckoutArgs"},"PixCheckoutResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."},"brCode":{"type":"string","description":"QR code to display to complete payment."},"quote":{"$ref":"#/components/schemas/CurrencyCents"},"expires":{"type":"string","description":"BR Code expiration"}},"required":["paymentId","brCode","quote","expires"],"title":"PixCheckoutResponse"},"CryptoHeadlessCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CryptoHeadlessCheckoutArgsRentLamports"},"CryptoHeadlessCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/CryptoHeadlessCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"CryptoHeadlessCheckoutArgsRent"},"CryptoHeadlessCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/CryptoHeadlessCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"email":{"type":"string"},"chain":{"type":"string","description":"The name of the chain to perform the crypto payin on."},"token":{"type":"string","description":"The symbol of the token to execute the payin with."}},"required":["subtotal","email","chain","token"],"title":"CryptoHeadlessCheckoutArgs"},"HeadlessCheckoutSession":{"type":"object","properties":{"sessionId":{"type":"string","description":"The session/payment identifier"},"depositAddress":{"type":"string","description":"The deposit address where funds should be sent"},"paymentChainName":{"type":"string","description":"Human-readable chain name"},"paymentCurrencySymbol":{"type":"string","description":"The token symbol"},"paymentAmount":{"type":"string","description":"The amount to pay in the selected currency"},"chainLogoUrl":{"type":"string"},"currencyLogoUrl":{"type":"string"},"paymentId":{"type":"string"}},"required":["sessionId","depositAddress","paymentChainName","paymentCurrencySymbol","paymentAmount","chainLogoUrl","currencyLogoUrl","paymentId"],"description":"Response from creating a payin session","title":"HeadlessCheckoutSession"},"GetCheckoutLinkArgsWebhookInfo":{"type":"object","properties":{},"title":"GetCheckoutLinkArgsWebhookInfo"},"PaymentMethods":{"type":"string","enum":["card","ach","fasterPayments","sepa","pix","usdc","googlePay","applePay","credits","crypto","wire","cashApp","apa","paypal","venmo","interac"],"title":"PaymentMethods"},"CoinflowBlockchain":{"type":"string","enum":["solana","eth","polygon","base","arbitrum","stellar","monad","tempo","user"],"description":"Coinflow Types *","title":"CoinflowBlockchain"},"ZeroAuthSavedPaymentMethods":{"type":"object","properties":{"disableSavedPaymentMethods":{"type":"boolean"}},"required":["disableSavedPaymentMethods"],"description":"Configuration for zero authorization flow - controls saved payment method visibility.","title":"ZeroAuthSavedPaymentMethods"},"ZeroAuthVerifyCard":{"type":"object","properties":{"cardToken":{"type":"string"}},"required":["cardToken"],"description":"Configuration for zero authorization flow - verify existing card mode.\nShows the \"Verify Card\" flow for a specific saved card.\nThe card token will be validated to ensure it belongs to the current user's wallet.\nIf the card doesn't belong to the user, falls back to \"Add New Card\" view.","title":"ZeroAuthVerifyCard"},"ZeroAuthorizationConfig":{"oneOf":[{"$ref":"#/components/schemas/ZeroAuthSavedPaymentMethods"},{"$ref":"#/components/schemas/ZeroAuthVerifyCard"}],"description":"Configuration for zero authorization flow.\nThe presence of this object indicates the checkout is in zero auth mode.\n\nTwo mutually exclusive modes:\n- Saved payment methods: `{ disableSavedPaymentMethods: boolean }` - show or hide saved methods\n- Verify card: `{ cardToken: \"token\" }` - verify a specific saved card","title":"ZeroAuthorizationConfig"},"MerchantStyle":{"type":"string","enum":["rounded","sharp","pill"],"title":"MerchantStyle"},"MerchantTheme":{"type":"object","properties":{"showCardIcon":{"type":"boolean"},"placeholderColor":{"type":"string"},"expirationPlaceholder":{"type":"string"},"cvvPlaceholder":{"type":"string"},"cardNumberPlaceholder":{"type":"string"},"fontWeight":{"type":"string"},"fontSize":{"type":"string"},"style":{"$ref":"#/components/schemas/MerchantStyle"},"font":{"type":"string"},"ctaColor":{"type":"string"},"textColorAction":{"type":"string"},"textColorAccent":{"type":"string"},"textColor":{"type":"string"},"backgroundAccent2":{"type":"string"},"backgroundAccent":{"type":"string"},"cardBackground":{"type":"string"},"background":{"type":"string"},"primary":{"type":"string"}},"title":"MerchantTheme"},"GetCheckoutLinkArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"GetCheckoutLinkArgsRentLamports"},"GetCheckoutLinkArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/GetCheckoutLinkArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"GetCheckoutLinkArgsRent"},"StandaloneLinkConfig":{"type":"object","properties":{"callbackUrl":{"type":"string","description":"A URL which the user will be redirected to after a successful checkout."},"endUserDeviceIpAddress":{"type":"string","minLength":1,"description":"The IP address of the device of the user. The link will fail to render\nif the IP address of the device viewing the link is different than\nthe one shared here."}},"required":["callbackUrl","endUserDeviceIpAddress"],"title":"StandaloneLinkConfig"},"CheckoutJwtExpiresIn0":{"type":"object","properties":{"seconds":{"type":"number","format":"double"}},"required":["seconds"],"title":"CheckoutJwtExpiresIn0"},"CheckoutJwtExpiresIn1":{"type":"object","properties":{"minutes":{"type":"number","format":"double"}},"required":["minutes"],"title":"CheckoutJwtExpiresIn1"},"CheckoutJwtExpiresIn2":{"type":"object","properties":{"hours":{"type":"number","format":"double"}},"required":["hours"],"title":"CheckoutJwtExpiresIn2"},"CheckoutJwtExpiresIn":{"oneOf":[{"$ref":"#/components/schemas/CheckoutJwtExpiresIn0"},{"$ref":"#/components/schemas/CheckoutJwtExpiresIn1"},{"$ref":"#/components/schemas/CheckoutJwtExpiresIn2"}],"description":"How long a checkout JWT remains valid. Exactly one unit key must be set.","title":"CheckoutJwtExpiresIn"},"GetCheckoutLinkArgs":{"type":"object","properties":{"supportEmail":{"type":"string","description":"Your company email address that the customer can contact."},"email":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/GetCheckoutLinkArgsWebhookInfo"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"allowedPaymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethods"},"description":"The payment methods displayed on the UI. If omitted, all available payment methods will be displayed."},"blockchain":{"$ref":"#/components/schemas/CoinflowBlockchain"},"presentment":{"$ref":"#/components/schemas/Currency"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"planCode":{"type":"string"},"useNativeSubtotal":{"type":"boolean","description":"When true, the Apple Pay button skips the totals (fee quote) fetch and\ncharges exactly the `subtotal` passed to the component."},"sessionKey":{"type":"string"},"isZeroAuthorization":{"type":"boolean","deprecated":true},"zeroAuthorizationConfig":{"$ref":"#/components/schemas/ZeroAuthorizationConfig"},"partialUsdcChecked":{"type":"boolean","description":"If true, pre-checks the partial USDC payment checkbox when USDC balance is available.\nIf false or undefined, maintains default behavior (unchecked)."},"deviceId":{"type":"string","description":"The DeviceID gotten from the Coinflow SDK:\n https://docs.coinflow.cash/guides/checkout/fraud-protection/chargeback-protection/implement-chargeback-protection#how-to-add-chargeback-protection"},"origins":{"type":"array","items":{"type":"string"},"description":"If rendering the Coinflow component within multiple nested iframes, all ancestors in the chain must be provided as a comma-separated list.\n\nExample:\nPrimary origin that will be interacting with the Coinflow iFrame: foo.com\nSubsequent origins that will render foo.com: bar.com\nThe origin array would then be: [https://foo.com,https://bar.com]"},"depositAmounts":{"type":"array","items":{"type":"number","format":"double"},"description":"Custom preset deposit amounts (in dollars) to display in the AmountSelector.\nOnly the first 3 values are used. Defaults to [10, 25, 50] if not provided."},"theme":{"$ref":"#/components/schemas/MerchantTheme"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"rent":{"$ref":"#/components/schemas/GetCheckoutLinkArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"destination":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destination which is the address to send\nthe USDC to."},"idempotencyKey":{"type":"string","description":"(Optional) Idemptotency Key to pass to prevent multiple purchases with the\nsame checkout link. If not passed, a random one will be generated for you\nautomatically."},"standaloneLinkConfig":{"$ref":"#/components/schemas/StandaloneLinkConfig"},"statementDescriptor":{"type":"string","description":"If custom statement descriptors are enabled for your merchant account and\nthe bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"expiresIn":{"$ref":"#/components/schemas/CheckoutJwtExpiresIn"}},"title":"GetCheckoutLinkArgs"},"Checkout_GetCheckoutJwtToken_Response_200":{"type":"object","properties":{"checkoutJwtToken":{"description":"Any type"}},"required":["checkoutJwtToken"],"title":"Checkout_GetCheckoutJwtToken_Response_200"},"Checkout_GetCheckoutLink_Response_200":{"type":"object","properties":{"link":{"type":"string"}},"required":["link"],"title":"Checkout_GetCheckoutLink_Response_200"},"Blockchain":{"type":"string","enum":["solana","eth","polygon","base","user","arbitrum","stellar","monad","tempo"],"title":"Blockchain"},"SingleDestination":{"type":"object","properties":{"destination":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"}},"required":["destination","blockchain"],"title":"SingleDestination"},"SplitAmountDestination":{"type":"object","properties":{"destination":{"type":"string"},"amount":{"$ref":"#/components/schemas/Cents"}},"required":["destination","amount"],"title":"SplitAmountDestination"},"MultipleAmountDestination":{"type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/SplitAmountDestination"}},"subtotal":{"$ref":"#/components/schemas/Cents"}},"required":["destinations","subtotal"],"title":"MultipleAmountDestination"},"SplitPercentageDestination":{"type":"object","properties":{"destination":{"type":"string"},"percentage":{"type":"number","format":"double"}},"required":["destination","percentage"],"title":"SplitPercentageDestination"},"MultiplePercentageDestination":{"type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/SplitPercentageDestination"}}},"required":["destinations"],"title":"MultiplePercentageDestination"},"DestinationAuthKeyRequest":{"oneOf":[{"$ref":"#/components/schemas/SingleDestination"},{"$ref":"#/components/schemas/MultipleAmountDestination"},{"$ref":"#/components/schemas/MultiplePercentageDestination"}],"title":"DestinationAuthKeyRequest"},"Checkout_GetDestinationAuthKey_Response_200":{"type":"object","properties":{"destinationAuthKey":{"type":"string"}},"required":["destinationAuthKey"],"title":"Checkout_GetDestinationAuthKey_Response_200"},"FeeDetailRequest":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant identifier"},"subtotal":{"$ref":"#/components/schemas/CurrencyCents"},"presentment":{"$ref":"#/components/schemas/Currency"},"bin":{"type":"string","description":"The Bin of the card (for exact fees)"}},"required":["merchantId","subtotal"],"title":"FeeDetailRequest"},"FeeOption":{"type":"object","properties":{"description":{"type":"string"},"fee":{"$ref":"#/components/schemas/CurrencyCents"},"fxFee":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["description","fee"],"title":"FeeOption"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard1"},"FeeDetail":{"type":"object","properties":{"fee":{"$ref":"#/components/schemas/CurrencyCents"},"fxFee":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["fee","fxFee"],"title":"FeeDetail"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac1":{"type":"array","items":{"$ref":"#/components/schemas/FeeOption"},"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac1"},"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac":{"oneOf":[{"$ref":"#/components/schemas/CurrencyCents"},{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac1"},{"$ref":"#/components/schemas/FeeDetail"}],"title":"PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac"},"Partial_Record_PaymentMethods.FeeOption-Array-or-FeeDetail-or-CurrencyCents__":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard"},"ach":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch"},"fasterPayments":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments"},"sepa":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa"},"pix":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix"},"usdc":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc"},"googlePay":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay"},"applePay":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay"},"credits":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits"},"crypto":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto"},"wire":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire"},"cashApp":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp"},"apa":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa"},"paypal":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal"},"venmo":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo"},"interac":{"$ref":"#/components/schemas/PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac"}},"description":"Make all properties in T optional","title":"Partial_Record_PaymentMethods.FeeOption-Array-or-FeeDetail-or-CurrencyCents__"},"CryptoTier":{"type":"string","enum":["stables","majors","volatile"],"description":"Currency tiers for crypto payins","title":"CryptoTier"},"SupportedToken":{"type":"object","properties":{"name":{"type":"string"},"symbol":{"type":"string"},"image":{"type":"string"},"feeTier":{"$ref":"#/components/schemas/CryptoTier"},"fee":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["name","symbol","image","feeTier"],"title":"SupportedToken"},"SupportedTokenChainCombo":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/SupportedToken"}}},"required":["name","image","tokens"],"title":"SupportedTokenChainCombo"},"SupportedChainTokenCombos":{"type":"object","properties":{"chains":{"type":"array","items":{"$ref":"#/components/schemas/SupportedTokenChainCombo"}}},"required":["chains"],"title":"SupportedChainTokenCombos"},"GetTotalsBodyRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"GetTotalsBodyRentLamports"},"GetTotalsBodyRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/GetTotalsBodyRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"GetTotalsBodyRent"},"GetTotalsBody":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/GetTotalsBodyRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call for a purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"bin":{"type":"string","description":"The bin of the card to get the exact fees"},"creditsBalance":{"$ref":"#/components/schemas/Cents"},"usdcBalance":{"$ref":"#/components/schemas/Cents"},"presentment":{"$ref":"#/components/schemas/Currency"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"}},"required":["subtotal"],"description":"From T, pick a set of properties whose keys are in the union K","title":"GetTotalsBody"},"TotalsResponse":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/CurrencyCents"},"creditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"fxFees":{"$ref":"#/components/schemas/CurrencyCents"},"networkFees":{"$ref":"#/components/schemas/CurrencyCents"},"payInFees":{"$ref":"#/components/schemas/CurrencyCents"},"total":{"$ref":"#/components/schemas/CurrencyCents"},"reserve":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidCreditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedFxFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/CurrencyCents"},"rebate":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedRebate":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["subtotal","creditCardFees","chargebackProtectionFees","gasFees","fxFees","total"],"title":"TotalsResponse"},"TotalsResponseSettlement":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/CurrencyCents"},"creditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"fxFees":{"$ref":"#/components/schemas/CurrencyCents"},"networkFees":{"$ref":"#/components/schemas/CurrencyCents"},"payInFees":{"$ref":"#/components/schemas/CurrencyCents"},"total":{"$ref":"#/components/schemas/CurrencyCents"},"reserve":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidCreditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedFxFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/CurrencyCents"},"rebate":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedRebate":{"$ref":"#/components/schemas/CurrencyCents"},"settlement":{"$ref":"#/components/schemas/TotalsResponse"},"basis":{"$ref":"#/components/schemas/CurrencyCents"},"exchangeRate":{"type":"number","format":"double"}},"required":["subtotal","creditCardFees","chargebackProtectionFees","gasFees","fxFees","total","settlement","basis","exchangeRate"],"title":"TotalsResponseSettlement"},"Record_PaymentMethods.TotalsResponseSettlement-or-undefined_":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"ach":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"fasterPayments":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"sepa":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"pix":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"usdc":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"googlePay":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"applePay":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"credits":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"crypto":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"wire":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"cashApp":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"apa":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"paypal":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"venmo":{"$ref":"#/components/schemas/TotalsResponseSettlement"},"interac":{"$ref":"#/components/schemas/TotalsResponseSettlement"}},"required":["card","ach","fasterPayments","sepa","pix","usdc","googlePay","applePay","credits","crypto","wire","cashApp","apa","paypal","venmo","interac"],"description":"Construct a type with a set of properties K of type T","title":"Record_PaymentMethods.TotalsResponseSettlement-or-undefined_"},"GetUsdcAuthorizationBody":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Cents"},"paymentId":{"type":"string","description":"Optional payment ID for generating unique nonce"}},"required":["amount"],"description":"Request body for getting USDC authorization message","title":"GetUsdcAuthorizationBody"},"GetUsdcAuthorizationResponseMessageData":{"type":"object","properties":{"nonce":{"type":"string"},"validBefore":{"type":"string"},"validAfter":{"type":"string"},"value":{"type":"string"},"to":{"type":"string"},"from":{"type":"string"}},"required":["nonce","validBefore","validAfter","value","to","from"],"description":"Structured message data for transparency","title":"GetUsdcAuthorizationResponseMessageData"},"GetUsdcAuthorizationResponse":{"type":"object","properties":{"message":{"type":"string","description":"EIP-712 message to sign"},"messageData":{"$ref":"#/components/schemas/GetUsdcAuthorizationResponseMessageData","description":"Structured message data for transparency"}},"required":["message","messageData"],"description":"Response for USDC authorization message","title":"GetUsdcAuthorizationResponse"},"GooglePayCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"GooglePayCheckoutArgsRentLamports"},"GooglePayCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/GooglePayCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"GooglePayCheckoutArgsRent"},"google.payments.api.Address":{"type":"object","properties":{"name":{"type":"string","description":"Name of the recipient at this address."},"address1":{"type":"string","default":"","description":"The first line of the address.\n\nWill be set to empty string if the address does not have a first\nline."},"address2":{"type":"string","default":"","description":"The second line of the address.\n\nWill be set to empty string if the address does not have a second\nline."},"address3":{"type":"string","default":"","description":"The third line of the address.\n\nWill be set to empty string if the address does not have a third\nline."},"locality":{"type":"string","description":"The locality (e.g. city or town)."},"administrativeArea":{"type":"string","description":"The administrative area (e.g. state or province)."},"countryCode":{"type":"string","description":"The two-letter ISO-3166 country code."},"postalCode":{"type":"string","description":"The postal code (also known in some places as ZIP code).\n\nNote: some regions do not have postal codes. In those cases\nthis field will be set to an empty string."},"sortingCode":{"type":"string","description":"The sorting code.\n\nNote: some regions do not have sorting codes. In those cases\nthis field will be set to an empty string."},"phoneNumber":{"type":"string","description":"The phone number.\n\nThis field will only be present if the caller requested that a phone\nnumber be returned."}},"required":["locality","administrativeArea","countryCode","postalCode"],"description":"Description of a user's address.","title":"google.payments.api.Address"},"google.payments.api.PaymentMethodType":{"type":"string","enum":["CARD","PAYPAL"],"description":"Payment method type enum string.\n\nOptions:\n\n- `CARD`:\n  CARD payment method.\n\n  Note that the payment method information that may be returned to you\n  or your processor for a credit card transaction is meant to be used\n  only once. If you need to charge the user again you must call the\n  APIs to obtain new payment credentials.\n\n  Also note that when we transfer information like PAN (personal\n  account number) to either you or your gateway/processor, they may not\n  correspond to the user's physical card. For support purposes, please\n  use user's card info returned in [[CardInfo|`CardInfo`]] instead.\n\n- `PAYPAL`:\n  PAYPAL payment method.","title":"google.payments.api.PaymentMethodType"},"google.payments.api.AssuranceDetails":{"type":"object","properties":{"accountVerified":{"type":"boolean","description":"If true, indicates that Cardholder possession validation has been performed on returned payment credential."},"cardHolderAuthenticated":{"type":"boolean","description":"If true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.\n\nIf false, the same risk-based authentication can be performed as you would for card transactions.\nThis risk-based authentication can include, but not limited to, step-up with 3D Secure protocol if applicable."}},"description":"Assurance details about what validation has been performed on the returned payment credentials so that appropriate instrument risk checks can be applied.\n\n Note: If both cardHolderAuthenticated and accountVerified are true, you don’t need to step up the returned credentials.\n If both aren’t, we recommend you to run the same risk checks and , authentication including 3D Secure flow if applicable.","title":"google.payments.api.AssuranceDetails"},"google.payments.api.CardNetwork":{"type":"string","enum":["AMEX","DISCOVER","ELECTRON","ELO","ELO_DEBIT","INTERAC","JCB","MAESTRO","MASTERCARD","VISA"],"description":"Card network enum string.\n\nOptions:\n\n- `AMEX`:\n  American Express card network.\n\n- `DISCOVER`:\n  Discover card network.\n\n- `ELECTRON`:\n  Visa's Electron card network.\n\n  Note that this option can only be set when\n  [[TransactionInfo.countryCode|`TransactionInfo.countryCode`]] is set\n  to `\"BR\"`, and\n  [[CardParameters.allowedCardNetworks|`CardParameters.allowedCardNetworks`]]\n  must also contain [[CardNetwork|`VISA`]]\n\n  For processing purposes, you should use this as an indication that\n  the card must be processed through the Electron debit network.\n\n- `ELO`:\n  Elo card network.\n\n  Note that this option can only be set when\n  [[TransactionInfo.countryCode|`TransactionInfo.countryCode`]] is set\n  to `\"BR\"`.\n\n- `ELO_DEBIT`:\n  Elo's debit network rail.\n\n  Note that this option can only be set when\n  [[TransactionInfo.countryCode|`TransactionInfo.countryCode`]] is set\n  to\n  `\"BR\"`, and\n  [[CardParameters.allowedCardNetworks|`CardParameters.allowedCardNetworks`]]\n  must also contain [[CardNetwork|`ELO`]]\n\n  For processing purposes, you should use this as an indication that\n  the card must be processed through the ELO debit network.\n\n- `INTERAC`:\n  Interac card network.\n\n- `JCB`:\n  JCB card network.\n\n- `MAESTRO`:\n  Maestro card network.\n\n  Note that this option can only be set when\n  [[TransactionInfo.countryCode|`TransactionInfo.countryCode`]] is set\n  to `\"BR\"`, and\n  [[CardParameters.allowedCardNetworks|`CardParameters.allowedCardNetworks`]]\n  must also contain [[CardNetwork|`MASTERCARD`]]\n\n  For processing purposes, you should use this as an indication that\n  the card must be processed through the Maestro debit network.\n\n- `MASTERCARD`:\n  Mastercard card network.\n\n- `VISA`:\n  Visa card network.","title":"google.payments.api.CardNetwork"},"google.payments.api.CardInfo":{"type":"object","properties":{"assuranceDetails":{"$ref":"#/components/schemas/google.payments.api.AssuranceDetails"},"cardNetwork":{"$ref":"#/components/schemas/google.payments.api.CardNetwork"},"cardDetails":{"type":"string","description":"The details about the card.\n\nThis value will be generally the last 4 digits of the card.\n\nThese details **should not** be displayed to the buyer,\nbut can be used when the details of a buyer's card are needed. An\nexample would be for customer support to help the buyer identify the\ncard used for this transaction. For a user-visible description, use\n[[PaymentMethodData.description|`PaymentMethodData.description`]]\ninstead."},"billingAddress":{"$ref":"#/components/schemas/google.payments.api.Address"}},"required":["cardNetwork","cardDetails"],"description":"Data for a [[PaymentMethodType|`PaymentMethodType.CARD`]] payment\nmethod.","title":"google.payments.api.CardInfo"},"google.payments.api.PaymentMethodTokenizationType":{"type":"string","enum":["PAYMENT_GATEWAY","DIRECT"],"description":"Payment method tokenization type enum string.\n\nOptions:\n\n- `PAYMENT_GATEWAY`:\n  Tokenize a payment response to be consumed or charged by a specified\n  third-party gateway service.\n\n- `DIRECT`:\n  Tokenize to be consumed/charged directly by the merchant.","title":"google.payments.api.PaymentMethodTokenizationType"},"google.payments.api.PaymentMethodTokenizationData":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/google.payments.api.PaymentMethodTokenizationType"},"token":{"type":"string","description":"The generated payment method token.\n\nThe contents of this token and how it should be used will depend on\nthe selected\n[[PaymentMethodTokenizationSpecification.type|`PaymentMethodTokenizationSpecification.type`]]."}},"required":["type","token"],"description":"Tokenization data for the payment method.","title":"google.payments.api.PaymentMethodTokenizationData"},"google.payments.api.PaymentMethodData":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/google.payments.api.PaymentMethodType"},"info":{"$ref":"#/components/schemas/google.payments.api.CardInfo"},"description":{"type":"string","description":"User-facing message to describe the payment method funding this\ntransaction.\n\nYou are required to show this message to the buyer as confirmation of\ntheir funding source. Please refer to the\n[documentation](https://developers.google.com/pay/api/|documentation)\nfor more information.\n\n**IMPORTANT:** Do not attempt to parse the contents of this string as\nthe format, contents, and length may change at any time. If you need\nadditional details, see\n[[PaymentMethodData.info|`PaymentMethodData.info`]]."},"tokenizationData":{"$ref":"#/components/schemas/google.payments.api.PaymentMethodTokenizationData"}},"required":["type","tokenizationData"],"description":"Data for a payment method.","title":"google.payments.api.PaymentMethodData"},"google.payments.api.OfferData":{"type":"object","properties":{"redemptionCodes":{"type":"array","items":{"type":"string"},"description":"Redemption codes of the offers applied by the user."}},"required":["redemptionCodes"],"description":"Definition for each offer to be applied to this payment request.","title":"google.payments.api.OfferData"},"google.payments.api.SelectionOptionData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of a [[SelectionOption|`SelectionOption`]].\nMust match with [[SelectionOption.id|`SelectionOption.id`]]\nfield."}},"required":["id"],"description":"Data for a [[SelectionOption|`SelectionOption`]].","title":"google.payments.api.SelectionOptionData"},"GooglePayCheckoutArgsPaymentData":{"type":"object","properties":{"apiVersion":{"type":"number","format":"double","description":"Major API version.\n\nThis value will match what was set in\n[[PaymentDataRequest.apiVersion|`PaymentDataRequest.apiVersion`]]."},"apiVersionMinor":{"type":"number","format":"double","description":"Minor API version.\n\nThis value will match what was set in\n[[PaymentDataRequest.apiVersionMinor|`PaymentDataRequest.apiVersionMinor`]]."},"email":{"type":"string","description":"The buyer's email.\n\nThis value will only be set if\n[[PaymentDataRequest.emailRequired|`PaymentDataRequest.emailRequired`]]\nwas set to `true`."},"shippingAddress":{"$ref":"#/components/schemas/google.payments.api.Address"},"paymentMethodData":{"$ref":"#/components/schemas/google.payments.api.PaymentMethodData"},"offerData":{"$ref":"#/components/schemas/google.payments.api.OfferData"},"shippingOptionData":{"$ref":"#/components/schemas/google.payments.api.SelectionOptionData"},"bin":{"type":"string"}},"required":["apiVersion","apiVersionMinor","paymentMethodData"],"description":"Payment data.\n\nContains the payment data requested in\n[[PaymentDataRequest|`PaymentDataRequest`]]","title":"GooglePayCheckoutArgsPaymentData"},"GooglePayCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/GooglePayCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"presentment":{"$ref":"#/components/schemas/Currency"},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"paymentData":{"$ref":"#/components/schemas/GooglePayCheckoutArgsPaymentData"}},"required":["subtotal","paymentData"],"title":"GooglePayCheckoutArgs"},"NewInteracCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"NewInteracCheckoutArgsRentLamports"},"NewInteracCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/NewInteracCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"NewInteracCheckoutArgsRent"},"NewInteracCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/NewInteracCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"merchantId":{"type":"string","description":"Merchant Identifier"},"email":{"type":"string","description":"Consumer email address. Optional — used to create the Coinflow customer\nrecord. Also used as the Interac payin handle when `phone` is not\nprovided."},"phone":{"type":"string","description":"Consumer phone number. Optional — when provided, the\nInterac payin request is sent to the phone instead of the email."},"firstName":{"type":"string","description":"Consumer first name. Required."},"lastName":{"type":"string","description":"Consumer last name. Required"}},"required":["subtotal","merchantId","firstName","lastName"],"title":"NewInteracCheckoutArgs"},"InteracCheckoutResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."},"email":{"type":"string","description":"The email the Interac e-Transfer request was sent to, if applicable."},"phone":{"type":"string","description":"The phone number the Interac e-Transfer request was sent to, if applicable."}},"required":["paymentId"],"title":"InteracCheckoutResponse"},"SavedTokenCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"SavedTokenCheckoutArgsRentLamports"},"SavedTokenCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/SavedTokenCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"SavedTokenCheckoutArgsRent"},"SavedTokenCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/SavedTokenCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"merchantId":{"type":"string","description":"Merchant Identifier"},"token":{"type":"string","description":"Token for the account to be used for checkout"}},"required":["subtotal","merchantId","token"],"title":"SavedTokenCheckoutArgs"},"MerchantInitiatedStandardTransactionArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"MerchantInitiatedStandardTransactionArgsRentLamports"},"MerchantInitiatedStandardTransactionArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/MerchantInitiatedStandardTransactionArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"MerchantInitiatedStandardTransactionArgsRent"},"MerchantInitiatedStandardTransactionArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"rent":{"$ref":"#/components/schemas/MerchantInitiatedStandardTransactionArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"presentment":{"$ref":"#/components/schemas/Currency"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"originalPaymentId":{"type":"string","description":"The payment ID of the original authorization."}},"required":["subtotal","originalPaymentId"],"title":"MerchantInitiatedStandardTransactionArgs"},"MerchantInitiatedSubscriptionTransactionArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"subscriptionPlanCode":{"type":"string","description":"Specify if using Subscription Plans that are Merchant Initiated - otherwise must specify originalPaymentId."}},"required":["subscriptionPlanCode"],"title":"MerchantInitiatedSubscriptionTransactionArgs"},"MerchantInitiatedTransactionArgs":{"oneOf":[{"$ref":"#/components/schemas/MerchantInitiatedStandardTransactionArgs"},{"$ref":"#/components/schemas/MerchantInitiatedSubscriptionTransactionArgs"}],"title":"MerchantInitiatedTransactionArgs"},"NewPayPalCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"NewPayPalCheckoutArgsRentLamports"},"NewPayPalCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/NewPayPalCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"NewPayPalCheckoutArgsRent"},"NewPayPalCheckoutArgsPaypal0":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"],"title":"NewPayPalCheckoutArgsPaypal0"},"NewPayPalCheckoutArgsPaypalOneOf1PhoneNumber":{"type":"object","properties":{"nationalNumber":{"type":"string"},"countryCode":{"type":"string"}},"required":["nationalNumber","countryCode"],"title":"NewPayPalCheckoutArgsPaypalOneOf1PhoneNumber"},"NewPayPalCheckoutArgsPaypal1":{"type":"object","properties":{"phoneNumber":{"$ref":"#/components/schemas/NewPayPalCheckoutArgsPaypalOneOf1PhoneNumber"}},"required":["phoneNumber"],"title":"NewPayPalCheckoutArgsPaypal1"},"NewPayPalCheckoutArgsPaypal":{"oneOf":[{"$ref":"#/components/schemas/NewPayPalCheckoutArgsPaypal0"},{"$ref":"#/components/schemas/NewPayPalCheckoutArgsPaypal1"}],"description":"The email or phone number tied to the PayPal account","title":"NewPayPalCheckoutArgsPaypal"},"NewPayPalCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/NewPayPalCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"presentment":{"$ref":"#/components/schemas/Currency"},"returnUrl":{"type":"string","description":"The URL to redirect the customer to after they approve the payment.\nIf provided, cancelUrl must also be provided."},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to if they cancel the payment.\nIf provided, returnUrl must also be provided."},"simulateAuthorizationFailure":{"type":"boolean","description":"Sandbox Only. Will force the authorization of the payment to fail."},"simulateCaptureFailure":{"type":"boolean","description":"Sandbox Only. Will force the capture of the payment to fail."},"simulateRefundFailure":{"type":"boolean","description":"Sandbox Only. Will force the refund of the payment to fail."},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"vault":{"type":"boolean","description":"Request that PayPal vault the customer's account on successful payment so\nlater checkouts can charge it with one click. Requires vaulting to be\nenabled on your Coinflow account, and requires returnUrl and cancelUrl —\nPayPal rejects vaulting orders without redirect URLs."},"email":{"type":"string","description":"Required if for a new customer"},"paypal":{"$ref":"#/components/schemas/NewPayPalCheckoutArgsPaypal","description":"The email or phone number tied to the PayPal account"}},"required":["subtotal","paypal"],"title":"NewPayPalCheckoutArgs"},"PayPalCheckoutResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."}},"required":["paymentId"],"title":"PayPalCheckoutResponse"},"SavedPayPalCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"SavedPayPalCheckoutArgsRentLamports"},"SavedPayPalCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/SavedPayPalCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"SavedPayPalCheckoutArgsRent"},"SavedPayPalCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/SavedPayPalCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"presentment":{"$ref":"#/components/schemas/Currency"},"returnUrl":{"type":"string","description":"The URL to redirect the customer to after they approve the payment.\nIf provided, cancelUrl must also be provided."},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to if they cancel the payment.\nIf provided, returnUrl must also be provided."},"simulateAuthorizationFailure":{"type":"boolean","description":"Sandbox Only. Will force the authorization of the payment to fail."},"simulateCaptureFailure":{"type":"boolean","description":"Sandbox Only. Will force the capture of the payment to fail."},"simulateRefundFailure":{"type":"boolean","description":"Sandbox Only. Will force the refund of the payment to fail."},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"vault":{"type":"boolean","description":"Request that PayPal vault the customer's account on successful payment so\nlater checkouts can charge it with one click. Requires vaulting to be\nenabled on your Coinflow account, and requires returnUrl and cancelUrl —\nPayPal rejects vaulting orders without redirect URLs."},"token":{"type":"string","description":"The saved token of the PayPal account"}},"required":["subtotal","token"],"title":"SavedPayPalCheckoutArgs"},"VaultedPayPalCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"VaultedPayPalCheckoutArgsRentLamports"},"VaultedPayPalCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/VaultedPayPalCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"VaultedPayPalCheckoutArgsRent"},"VaultedPayPalCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/VaultedPayPalCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"presentment":{"$ref":"#/components/schemas/Currency"},"returnUrl":{"type":"string","description":"The URL to redirect the customer to after they approve the payment.\nIf provided, cancelUrl must also be provided."},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to if they cancel the payment.\nIf provided, returnUrl must also be provided."},"simulateAuthorizationFailure":{"type":"boolean","description":"Sandbox Only. Will force the authorization of the payment to fail."},"simulateCaptureFailure":{"type":"boolean","description":"Sandbox Only. Will force the capture of the payment to fail."},"simulateRefundFailure":{"type":"boolean","description":"Sandbox Only. Will force the refund of the payment to fail."},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"token":{"type":"string","description":"The saved token of the PayPal account"},"clientMetadataId":{"type":"string","pattern":"^[a-zA-Z0-9-]+$","maxLength":36,"description":"The PayPal FraudNet client metadata ID (CMID) collected on the checkout\npage, forwarded to PayPal as the PayPal-Client-Metadata-Id header so\nPayPal Risk can correlate the order with the browser data FraudNet\ncollected."}},"required":["subtotal","token","clientMetadataId"],"title":"VaultedPayPalCheckoutArgs"},"ReviewPaymentRequest":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."},"accept":{"type":"boolean"}},"required":["paymentId","accept"],"title":"ReviewPaymentRequest"},"TokenCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"TokenCheckoutArgsRentLamports"},"TokenCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/TokenCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"TokenCheckoutArgsRent"},"TokenCheckoutArgsAddress":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"state":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string","minLength":1},"address1":{"type":"string"}},"required":["country","city","address1"],"description":"The address field is not needed here unless explicitly given instructions to do so.","title":"TokenCheckoutArgsAddress"},"TokenCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/TokenCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"presentment":{"$ref":"#/components/schemas/Currency"},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"token":{"type":"string","description":"Token for the card to be used for the checkout."},"address":{"$ref":"#/components/schemas/TokenCheckoutArgsAddress","description":"The address field is not needed here unless explicitly given instructions to do so."}},"required":["subtotal","token"],"title":"TokenCheckoutArgs"},"NewIbanCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"NewIbanCheckoutArgsRentLamports"},"NewIbanCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/NewIbanCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"NewIbanCheckoutArgsRent"},"IbanData":{"type":"object","properties":{"number":{"type":"string","description":"The IBAN number or in the case of the UK the 8-digit account number"},"sortCode":{"type":"string","description":"Only used for the UK, the 6-digit sort code"},"bic":{"type":"string","description":"Only used for the Sepa, the bank identifier code - required when requested"},"accountHolder":{"type":"string","description":"The account holder name registered with the bank - required when requested\n(e.g. when a Verification of Payee check needs the exact name)"},"alias":{"type":"string"},"businessName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"}},"required":["number","firstName","lastName","country"],"title":"IbanData"},"NewIbanCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/NewIbanCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"merchantId":{"type":"string","description":"Merchant Identifier"},"data":{"$ref":"#/components/schemas/IbanData"}},"required":["subtotal","merchantId","data"],"title":"NewIbanCheckoutArgs"},"Pick_Address.Exclude_keyofAddress.state__":{"type":"object","properties":{"country":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"}},"required":["country","city","zip","address1"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_Address.Exclude_keyofAddress.state__"},"IbanPaymentDetails":{"type":"object","properties":{"paymentId":{"type":"string"},"account":{"type":"string"},"sortCode":{"type":"string"},"expires":{"type":"string"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"address":{"$ref":"#/components/schemas/Pick_Address.Exclude_keyofAddress.state__"},"accountHolderName":{"type":"string"},"reference":{"type":"string"}},"required":["paymentId","account","expires","amount","address","accountHolderName"],"title":"IbanPaymentDetails"},"NewWireCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"NewWireCheckoutArgsRentLamports"},"NewWireCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/NewWireCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"NewWireCheckoutArgsRent"},"AddUSWireBankAccountData":{"type":"object","properties":{"account_number":{"type":"string","description":"Must be the raw bank account number, not a Plaid tokenized number."},"alias":{"type":"string"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"firstName":{"type":"string","minLength":1},"lastName":{"type":"string","minLength":1},"address1":{"type":"string","minLength":1},"address2":{"type":"string"},"city":{"type":"string","minLength":1},"state":{"type":"string","pattern":"^[A-Z]{2}$","minLength":2,"maxLength":2},"zip":{"type":"string","pattern":"^\\d{5}$","minLength":5,"maxLength":5},"country":{"type":"string"},"businessName":{"type":"string"},"plaidAccountId":{"type":"string"},"plaidAccessToken":{"type":"string"},"plaidAccountType":{"type":"string"},"plaidAccountSubtype":{"type":"string"},"rtpEligible":{"type":"boolean"},"isTokenized":{"type":"boolean"},"wireRoutingNumber":{"type":"string"}},"required":["account_number","alias","email","firstName","lastName","address1","city","state","zip","wireRoutingNumber"],"title":"AddUSWireBankAccountData"},"NewWireCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/NewWireCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"merchantId":{"type":"string","description":"Merchant Identifier"},"data":{"$ref":"#/components/schemas/AddUSWireBankAccountData"}},"required":["subtotal","merchantId","data"],"title":"NewWireCheckoutArgs"},"Address":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["address1","city","state","zip","country"],"title":"Address"},"USWirePaymentDetails":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"account_number":{"type":"string","description":"The bank account number that funds should be directed to."},"wireRoutingNumber":{"type":"string","description":"The wire routing number that funds should be directed to."},"paymentId":{"type":"string"},"recipientName":{"type":"string"},"memo":{"type":"string"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"expires":{"type":"string"}},"required":["address","account_number","wireRoutingNumber","paymentId","recipientName","memo","amount","expires"],"title":"USWirePaymentDetails"},"SavedWireTokenCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"SavedWireTokenCheckoutArgsRentLamports"},"SavedWireTokenCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/SavedWireTokenCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"SavedWireTokenCheckoutArgsRent"},"SavedWireTokenCheckoutArgs":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"rent":{"$ref":"#/components/schemas/SavedWireTokenCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"merchantId":{"type":"string","description":"Merchant Identifier"},"token":{"type":"string","description":"Token for the account to be used for checkout"},"wireRoutingNumber":{"type":"string"},"accountNumber":{"type":"string"}},"required":["subtotal","merchantId","token"],"title":"SavedWireTokenCheckoutArgs"},"NewVenmoCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"NewVenmoCheckoutArgsRentLamports"},"NewVenmoCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/NewVenmoCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"NewVenmoCheckoutArgsRent"},"NewVenmoCheckoutArgsVenmo0":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"],"title":"NewVenmoCheckoutArgsVenmo0"},"NewVenmoCheckoutArgsVenmoOneOf1PhoneNumber":{"type":"object","properties":{"nationalNumber":{"type":"string"},"countryCode":{"type":"string"}},"required":["nationalNumber","countryCode"],"title":"NewVenmoCheckoutArgsVenmoOneOf1PhoneNumber"},"NewVenmoCheckoutArgsVenmo1":{"type":"object","properties":{"phoneNumber":{"$ref":"#/components/schemas/NewVenmoCheckoutArgsVenmoOneOf1PhoneNumber"}},"required":["phoneNumber"],"title":"NewVenmoCheckoutArgsVenmo1"},"NewVenmoCheckoutArgsVenmo":{"oneOf":[{"$ref":"#/components/schemas/NewVenmoCheckoutArgsVenmo0"},{"$ref":"#/components/schemas/NewVenmoCheckoutArgsVenmo1"}],"description":"The email or phone number tied to the Venmo account","title":"NewVenmoCheckoutArgsVenmo"},"NewVenmoCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/NewVenmoCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"presentment":{"$ref":"#/components/schemas/Currency"},"returnUrl":{"type":"string","description":"The URL to redirect the customer to after they approve the payment.\nIf provided, cancelUrl must also be provided."},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to if they cancel the payment.\nIf provided, returnUrl must also be provided."},"simulateAuthorizationFailure":{"type":"boolean","description":"Sandbox Only. Will force the authorization of the payment to fail."},"simulateCaptureFailure":{"type":"boolean","description":"Sandbox Only. Will force the capture of the payment to fail."},"simulateRefundFailure":{"type":"boolean","description":"Sandbox Only. Will force the refund of the payment to fail."},"vault":{"type":"boolean","description":"Request that Venmo vault the customer's account on successful payment so\nlater checkouts can charge it with one click. Requires vaulting to be\nenabled on your Coinflow account, and requires returnUrl and cancelUrl —\nPayPal rejects vaulting orders without redirect URLs."},"email":{"type":"string","description":"Required if for a new customer"},"venmo":{"$ref":"#/components/schemas/NewVenmoCheckoutArgsVenmo","description":"The email or phone number tied to the Venmo account"}},"required":["subtotal","venmo"],"title":"NewVenmoCheckoutArgs"},"VenmoCheckoutResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"The ID of the payment that was created."},"approvalLink":{"type":"string","description":"PayPal payer-action link for approving the order via redirect (used by\nmobile flows where the SDK session cannot run, e.g. in-app browsers).\nOnly present when returnUrl/cancelUrl were provided."}},"required":["paymentId"],"title":"VenmoCheckoutResponse"},"SavedVenmoCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"SavedVenmoCheckoutArgsRentLamports"},"SavedVenmoCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/SavedVenmoCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"SavedVenmoCheckoutArgsRent"},"SavedVenmoCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/SavedVenmoCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"presentment":{"$ref":"#/components/schemas/Currency"},"returnUrl":{"type":"string","description":"The URL to redirect the customer to after they approve the payment.\nIf provided, cancelUrl must also be provided."},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to if they cancel the payment.\nIf provided, returnUrl must also be provided."},"simulateAuthorizationFailure":{"type":"boolean","description":"Sandbox Only. Will force the authorization of the payment to fail."},"simulateCaptureFailure":{"type":"boolean","description":"Sandbox Only. Will force the capture of the payment to fail."},"simulateRefundFailure":{"type":"boolean","description":"Sandbox Only. Will force the refund of the payment to fail."},"vault":{"type":"boolean","description":"Request that Venmo vault the customer's account on successful payment so\nlater checkouts can charge it with one click. Requires vaulting to be\nenabled on your Coinflow account, and requires returnUrl and cancelUrl —\nPayPal rejects vaulting orders without redirect URLs."},"token":{"type":"string","description":"The saved token of the Venmo account"}},"required":["subtotal","token"],"title":"SavedVenmoCheckoutArgs"},"VaultedVenmoCheckoutArgsRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"VaultedVenmoCheckoutArgsRentLamports"},"VaultedVenmoCheckoutArgsRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/VaultedVenmoCheckoutArgsRentLamports"}},"required":["lamports"],"description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"VaultedVenmoCheckoutArgsRent"},"VaultedVenmoCheckoutArgs":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/Subtotal"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"rent":{"$ref":"#/components/schemas/VaultedVenmoCheckoutArgsRent","description":"(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"redemptionCheck":{"type":"boolean","description":"(Solana only) If a transaction involved in the purchase, should payment be checked for redemption"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"authOnly":{"type":"boolean","description":"Only authorize the purchase. This will not actually capture the payment.(default: false)"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"destinationAuthKey":{"type":"string","description":"If utilizing USDC settlement to addresses other than your main merchant\nsettlement address. Utilize this destinationAuthKey which is a JWT encoded\nwith the information for which address to send the USDC to."},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"presentment":{"$ref":"#/components/schemas/Currency"},"returnUrl":{"type":"string","description":"The URL to redirect the customer to after they approve the payment.\nIf provided, cancelUrl must also be provided."},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to if they cancel the payment.\nIf provided, returnUrl must also be provided."},"simulateAuthorizationFailure":{"type":"boolean","description":"Sandbox Only. Will force the authorization of the payment to fail."},"simulateCaptureFailure":{"type":"boolean","description":"Sandbox Only. Will force the capture of the payment to fail."},"simulateRefundFailure":{"type":"boolean","description":"Sandbox Only. Will force the refund of the payment to fail."},"token":{"type":"string","description":"The saved token of the Venmo account"},"clientMetadataId":{"type":"string","pattern":"^[a-zA-Z0-9-]+$","maxLength":36,"description":"The PayPal FraudNet client metadata ID (CMID) collected on the checkout\npage, forwarded to PayPal as the PayPal-Client-Metadata-Id header so\nPayPal Risk can correlate the order with the browser data FraudNet\ncollected."}},"required":["subtotal","token","clientMetadataId"],"title":"VaultedVenmoCheckoutArgs"},"VoidPaymentRequest":{"type":"object","properties":{"paymentId":{"type":"string"}},"required":["paymentId"],"title":"VoidPaymentRequest"},"ZeroAuthorizationCheckoutArgsNewCardWithoutReasonCard":{"oneOf":[{"$ref":"#/components/schemas/CardData"},{"$ref":"#/components/schemas/CardDataWithoutAddress"}],"title":"ZeroAuthorizationCheckoutArgsNewCardWithoutReasonCard"},"ZeroAuthorizationCheckoutArgsNewCardWithoutReason":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"},"card":{"$ref":"#/components/schemas/ZeroAuthorizationCheckoutArgsNewCardWithoutReasonCard"}},"required":["card"],"title":"ZeroAuthorizationCheckoutArgsNewCardWithoutReason"},"ZeroAuthorizationCheckoutArgsSavedCardWithoutReason":{"type":"object","properties":{"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"token":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"statementDescriptor":{"type":"string","description":"If the bank supports dynamic descriptors, this will appear on the customer's\nstatement."},"stellarTransaction":{"type":"string","description":"(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.\n\nFor transaction purchases, pass the base64 XDR string created using `.toXDR()` on a transaction\nbuilt with generated TypeScript bindings (e.g., `NftClientWrapper.buildNftPurchaseTx`).\n\nFor direct USDC transfers (no merchant transaction), omit this field or pass undefined.\n\nGas fees for the transaction will be automatically calculated and added to the total charged to the customer."},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"overrideChargebackProtectionDecision":{"type":"boolean"},"doNotReviewChargebackProtection":{"type":"boolean"}},"required":["token"],"title":"ZeroAuthorizationCheckoutArgsSavedCardWithoutReason"},"ZeroAuthorizationCheckoutArgsWithoutReason":{"oneOf":[{"$ref":"#/components/schemas/ZeroAuthorizationCheckoutArgsNewCardWithoutReason"},{"$ref":"#/components/schemas/ZeroAuthorizationCheckoutArgsSavedCardWithoutReason"}],"title":"ZeroAuthorizationCheckoutArgsWithoutReason"},"BankAccountType":{"type":"string","enum":["checking","savings"],"title":"BankAccountType"},"Pick_AddACHBankAccountData.Exclude_keyofAddACHBankAccountData.plaidAccountId__":{"type":"object","properties":{"country":{"type":"string"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"firstName":{"type":"string","minLength":1},"city":{"type":"string","minLength":1},"state":{"type":"string","pattern":"^[A-Z]{2}$","minLength":2,"maxLength":2},"zip":{"type":"string","pattern":"^\\d{5}$","minLength":5,"maxLength":5},"isTokenized":{"type":"boolean"},"alias":{"type":"string"},"type":{"$ref":"#/components/schemas/BankAccountType"},"address1":{"type":"string","minLength":1},"address2":{"type":"string"},"account_number":{"type":"string"},"rtpEligible":{"type":"boolean"},"routingNumber":{"type":"string"},"lastName":{"type":"string","minLength":1},"businessName":{"type":"string"},"plaidAccessToken":{"type":"string"},"plaidAccountType":{"type":"string"},"plaidAccountSubtype":{"type":"string"}},"required":["email","firstName","city","state","zip","alias","type","address1","account_number","routingNumber","lastName"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_AddACHBankAccountData.Exclude_keyofAddACHBankAccountData.plaidAccountId__"},"CustomerPlaidCheckPostRequestBodyContentApplicationJsonSchemaAccountsItems":{"type":"object","properties":{"bankAccountToken":{"type":"string"},"customerId":{"type":"string"}},"required":["customerId"],"title":"CustomerPlaidCheckPostRequestBodyContentApplicationJsonSchemaAccountsItems"},"PlaidAccountStatus":{"type":"string","enum":["active","pending_expiration","login_required","removed","error"],"title":"PlaidAccountStatus"},"PlaidBalanceData":{"type":"object","properties":{"current":{"type":["number","null"],"format":"double"},"available":{"type":["number","null"],"format":"double"},"limit":{"type":["number","null"],"format":"double"},"isoCurrencyCode":{"type":["string","null"]},"unofficialCurrencyCode":{"type":["string","null"]}},"required":["current","available","limit","isoCurrencyCode","unofficialCurrencyCode"],"title":"PlaidBalanceData"},"MultiPlaidAccountStatusResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PlaidAccountStatus"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"balance":{"oneOf":[{"$ref":"#/components/schemas/PlaidBalanceData"},{"type":"null"}]},"accountType":{"type":"string"},"accountSubtype":{"type":"string"},"customerId":{"type":"string"},"bankAccountToken":{"type":"string"}},"required":["status","customerId"],"title":"MultiPlaidAccountStatusResponse"},"CustomerVenmoAccountType":{"type":"string","enum":["venmo"],"title":"CustomerVenmoAccountType"},"CustomerVenmoAccount":{"type":"object","properties":{"isDeleted":{"type":"boolean"},"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/CustomerVenmoAccountType"},"vaulted":{"type":"boolean","description":"Derived, not persisted: true when the account holds a Venmo vault token\nand the merchant has vaulting enabled — the frontend's signal to use the\none-click vaulted checkout."}},"required":["alias","token","type"],"description":"Saved Venmo account as returned on customer responses.","title":"CustomerVenmoAccount"},"CustomerPayPalAccountType":{"type":"string","enum":["paypal"],"title":"CustomerPayPalAccountType"},"CustomerPayPalAccount":{"type":"object","properties":{"isDeleted":{"type":"boolean"},"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/CustomerPayPalAccountType"},"vaulted":{"type":"boolean","description":"Derived, not persisted: true when the account holds a PayPal vault token\nand the merchant has vaulting enabled — the frontend's signal to use the\none-click vaulted checkout."}},"required":["alias","token","type"],"description":"Saved PayPal account as returned on customer responses.","title":"CustomerPayPalAccount"},"PortalBrand":{"type":"string","enum":["approvely","seamlesschex","coinflow","yourbrandhere","Plan2Play","tango","interlace","tapvia","decal"],"title":"PortalBrand"},"MerchantBrandSettings":{"type":"object","properties":{"portalBrand":{"$ref":"#/components/schemas/PortalBrand"},"logo":{"type":"string"},"displayName":{"type":"string"}},"title":"MerchantBrandSettings"},"Partial_WithdrawLimit_":{"type":"object","properties":{"singleTxLimit":{"$ref":"#/components/schemas/Cents"},"dailyLimit":{"$ref":"#/components/schemas/Cents"},"monthlyLimit":{"$ref":"#/components/schemas/Cents"}},"description":"Make all properties in T optional","title":"Partial_WithdrawLimit_"},"WithdrawFeeConfig":{"type":"object","properties":{"fixed":{"$ref":"#/components/schemas/Cents"},"variableBps":{"type":"number","format":"double"},"minimum":{"$ref":"#/components/schemas/Cents"},"maximum":{"$ref":"#/components/schemas/Cents"},"limit":{"$ref":"#/components/schemas/Partial_WithdrawLimit_"}},"required":["fixed","variableBps","minimum"],"title":"WithdrawFeeConfig"},"Partial_Record_WithdrawSpeed.WithdrawFeeConfig__":{"type":"object","properties":{"asap":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"same_day":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"standard":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"card":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"iban":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"pix":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"eft":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"venmo":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"paypal":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"wire":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"interac":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"swift":{"$ref":"#/components/schemas/WithdrawFeeConfig"},"crypto":{"$ref":"#/components/schemas/WithdrawFeeConfig"}},"description":"Make all properties in T optional","title":"Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"IMerchantStringWithdrawFees":{"type":"object","properties":{"firstParty":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"business":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"user":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"swapBps":{"type":"number","format":"double"}},"required":["firstParty","business","user","swapBps"],"title":"IMerchantStringWithdrawFees"},"CustomWithdrawFeeValue0":{"type":"object","properties":{"maxFeeCents":{"type":["number","null"],"format":"double"},"minFeeCents":{"type":["number","null"],"format":"double"},"coverProcessingFees":{"type":"boolean"},"cents":{"type":"number","format":"double"},"currency":{"$ref":"#/components/schemas/Currency"},"percent":{"type":["number","null"],"format":"double"},"isFixed":{"type":"boolean"}},"required":["maxFeeCents","minFeeCents","coverProcessingFees","cents","currency","percent","isFixed"],"title":"CustomWithdrawFeeValue0"},"CustomWithdrawFeeValue1":{"type":"object","properties":{"maxFeeCents":{"type":["number","null"],"format":"double"},"minFeeCents":{"type":["number","null"],"format":"double"},"coverProcessingFees":{"type":"boolean"},"cents":{"type":["number","null"],"format":"double"},"currency":{"oneOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"percent":{"type":"number","format":"double"},"isFixed":{"type":"boolean"}},"required":["maxFeeCents","minFeeCents","coverProcessingFees","cents","percent","isFixed"],"title":"CustomWithdrawFeeValue1"},"CustomWithdrawFeeValue":{"oneOf":[{"$ref":"#/components/schemas/CustomWithdrawFeeValue0"},{"$ref":"#/components/schemas/CustomWithdrawFeeValue1"}],"title":"CustomWithdrawFeeValue"},"CustomWithdrawFeesConfig":{"type":"object","properties":{"asap":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"same_day":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"standard":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"card":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"iban":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"pix":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"eft":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"venmo":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"paypal":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"wire":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"interac":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"swift":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"crypto":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"global":{"$ref":"#/components/schemas/CustomWithdrawFeeValue"},"lineItemLabel":{"type":"string"},"isBundled":{"type":"boolean"}},"required":["global","lineItemLabel","isBundled"],"description":"Make all properties in T optional","title":"CustomWithdrawFeesConfig"},"IMerchantStringWalletsStellar":{"type":"object","properties":{"usdcPayer":{"type":"string"}},"required":["usdcPayer"],"title":"IMerchantStringWalletsStellar"},"IMerchantStringWalletsEvm":{"type":"object","properties":{"usdcPayer":{"type":"string"},"feePayer":{"type":"string"}},"required":["usdcPayer","feePayer"],"title":"IMerchantStringWalletsEvm"},"IMerchantStringWalletsSolana":{"type":"object","properties":{"usdcPayer":{"type":"string"},"feePayer":{"type":"string"}},"required":["usdcPayer","feePayer"],"title":"IMerchantStringWalletsSolana"},"IMerchantStringWallets":{"type":"object","properties":{"stellar":{"$ref":"#/components/schemas/IMerchantStringWalletsStellar"},"evm":{"$ref":"#/components/schemas/IMerchantStringWalletsEvm"},"solana":{"$ref":"#/components/schemas/IMerchantStringWalletsSolana"}},"required":["stellar","evm","solana"],"title":"IMerchantStringWallets"},"MerchantScope":{"type":"string","enum":["admin","editor","chargeback","chargeback_analyst","chargeback_analyst_read","viewer","seller","pos_device","destructive"],"description":"Which monthly-minimum model bills the merchant, selectable in merchant\nsettings. `Off` assesses no minimum; `Legacy` and `Tiered` read their\nnumbers from the merchant's MonthlyMinimum MerchantFeeSchedule row.","title":"MerchantScope"},"IMerchantStringApiKeysItems":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/MerchantScope"},"ips":{"type":"array","items":{"type":"string"}},"disabled":{"type":"boolean"},"privateUuid":{"type":"string"},"publicUuid":{"type":"string"}},"required":["ips","privateUuid","publicUuid"],"title":"IMerchantStringApiKeysItems"},"KycType":{"type":"string","enum":["person","business","both"],"title":"KycType"},"StableCoin":{"type":"string","enum":["USDC","SBC","EUROe","FXUSD","HSUSD","CFUSD","YPUSD"],"title":"StableCoin"},"DirectVendorSettlement":{"type":"string","enum":["brale"],"title":"DirectVendorSettlement"},"MpcWalletProvider":{"type":"string","enum":["metakeep","brale"],"title":"MpcWalletProvider"},"IMerchantStringSettlementAddressesRecipientAddressesItems":{"type":"object","properties":{"info":{"$ref":"#/components/schemas/Record_string.any_"},"createdAt":{"type":"string","format":"date-time"},"recipient":{"type":"string"}},"required":["createdAt","recipient"],"title":"IMerchantStringSettlementAddressesRecipientAddressesItems"},"IMerchantStringSettlementAddresses":{"type":"object","properties":{"solana":{"type":"string"},"eth":{"type":"string"},"polygon":{"type":"string"},"base":{"type":"string"},"user":{"type":"string"},"arbitrum":{"type":"string"},"stellar":{"type":"string"},"monad":{"type":"string"},"tempo":{"type":"string"},"directVendor":{"$ref":"#/components/schemas/DirectVendorSettlement"},"mpcWalletProvider":{"$ref":"#/components/schemas/MpcWalletProvider"},"recipientAddresses":{"type":"array","items":{"$ref":"#/components/schemas/IMerchantStringSettlementAddressesRecipientAddressesItems"}},"verification":{"$ref":"#/components/schemas/Verification"}},"title":"IMerchantStringSettlementAddresses"},"SsoProvider":{"type":"string","enum":["google"],"title":"SsoProvider"},"IMerchantUser":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"scope":{"$ref":"#/components/schemas/MerchantScope"},"secret":{"type":"string"},"resetNonce":{"type":"string"},"resetNonceUsed":{"type":"boolean"},"ssoProvider":{"$ref":"#/components/schemas/SsoProvider"},"ssoId":{"type":"string"}},"required":["email","scope"],"title":"IMerchantUser"},"UboEntry":{"type":"object","properties":{"reference":{"type":"string"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"vendor":{"$ref":"#/components/schemas/VerificationVendor"},"name":{"type":"string"},"attested":{"type":"boolean"},"shareToken":{"type":"string"},"shareTokenStatus":{"type":"string"},"sessionToken":{"type":"string"},"rejectionReasons":{"type":"array","items":{"type":"string"}},"ownershipPct":{"type":"number","format":"double"},"isControllingPerson":{"type":"boolean"}},"required":["reference","status","vendor"],"title":"UboEntry"},"ProgramWhitelistStatus":{"type":"string","enum":["approved","pending","rejected"],"title":"ProgramWhitelistStatus"},"ProgramWhitelistRequest":{"type":"object","properties":{"programId":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"status":{"$ref":"#/components/schemas/ProgramWhitelistStatus"}},"required":["programId","blockchain","status"],"title":"ProgramWhitelistRequest"},"RfiStatus":{"type":"string","enum":["pending","completed"],"title":"RfiStatus"},"MerchantRfiRef":{"type":"object","properties":{"name":{"type":"string"},"status":{"$ref":"#/components/schemas/RfiStatus"},"url":{"type":"string"},"assignmentFormId":{"type":"string"}},"required":["name","status","url"],"title":"MerchantRfiRef"},"MerchantGoLiveChecklist":{"type":"object","properties":{"acceptedToS":{"type":"boolean"},"programWhitelistRequests":{"type":"array","items":{"$ref":"#/components/schemas/ProgramWhitelistRequest"}},"rfis":{"type":"array","items":{"$ref":"#/components/schemas/MerchantRfiRef"}},"onboardingFormSubmitted":{"type":"boolean"},"onboardingProfileSubmitted":{"type":"boolean"},"applicationSubmitted":{"type":"boolean"},"applicationSubmittedAt":{"type":"string","format":"date-time"},"lockIndustry":{"type":"boolean"}},"title":"MerchantGoLiveChecklist"},"WebhookVersion":{"type":"string","enum":["Legacy","Version 1","Version 2","Version 3"],"title":"WebhookVersion"},"WebhookEventType":{"type":"string","enum":["Card Payment Authorized","Card Payment Declined","Card Payment Voided","Credits Minted","ACH Initiated","ACH Success","ACH Returned","ACH Failed","ACH Chargeback","ACH Batched","PIX Failed","PIX Expiration","Payment Authorized","Payment Expiration","Settled","Wire Initiated","USDC Payment Received","Subscription Created","Subscription Canceled","Subscription Expired","Subscription Failure","Subscription Concluded","Card Payment Chargeback Opened","Card Payment Chargeback Won","Card Payment Chargeback Lost","Card Payment Suspected Fraud","Payment Pending Review","KYC Created","KYC Success","KYC Failure","Sub-merchant KYB Created","Sub-merchant KYB Success","Sub-merchant KYB Failure","Withdraw Pending","Withdraw Success","Withdraw Failure","Withdraw Unclaimed","Interac PIN","Seller Blocked","Refund","Refund Complete","Refund Failure","Refund Returned","Wire Failure","Iban Failure","Interac Failure","CashApp Failure","PayPal Failure","Venmo Failure","Reserve Released","Crypto Overpayment","Crypto Underpayment","Iban RFI Created","Iban RFI Submitted","Crypto Deposit Funds Received","Customer Override Limit Threshold","Crypto Payin Funds Received","PayPal Payment Authorized","PayPal Payment Voided","PayPal Payment Chargeback Opened","PayPal Payment Chargeback Won","PayPal Payment Chargeback Lost","Venmo Payment Authorized","Venmo Payment Voided","Venmo Payment Chargeback Opened","Venmo Payment Chargeback Won","Venmo Payment Chargeback Lost","Disbursed Funds","Unknown Wire Payment Received"],"title":"WebhookEventType"},"WebhookSettings":{"type":"object","properties":{"webhookUrls":{"type":"array","items":{"type":"string"}},"version":{"$ref":"#/components/schemas/WebhookVersion"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"disableAuthorizationHeader":{"type":"boolean"},"disableSubmerchantToParentWebhooks":{"type":"boolean"}},"required":["webhookUrls","version","subscriptions"],"title":"WebhookSettings"},"PaymentProcessor":{"type":"string","enum":["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"],"title":"PaymentProcessor"},"FeePayerMode":{"type":"string","enum":["user","merchant","invoice"],"title":"FeePayerMode"},"CardSettingsVerificationSettings":{"type":"object","properties":{"threshold3DS":{"$ref":"#/components/schemas/Cents"},"verificationLimit":{"$ref":"#/components/schemas/Cents"}},"title":"CardSettingsVerificationSettings"},"GreenlightMerchantArgs":{"type":"object","properties":{"securityKey":{"type":"string"},"mid":{"type":"string"}},"required":["securityKey","mid"],"title":"GreenlightMerchantArgs"},"NuveiV1MerchantArgs":{"type":"object","properties":{"merchantId":{"type":"string"},"merchantSiteId":{"type":"string"},"conversionAffiliateCountryCode":{"type":"string"}},"required":["merchantId","merchantSiteId"],"title":"NuveiV1MerchantArgs"},"CrbEnvironment":{"type":"string","enum":["sandbox","production"],"title":"CrbEnvironment"},"CrbMerchantSettings":{"type":"object","properties":{"customerId":{"type":"string"},"cifNumber":{"type":"string"},"subledgerAccountNumber":{"type":"string"},"controllingPersonId":{"type":"string"},"environment":{"$ref":"#/components/schemas/CrbEnvironment"}},"required":["customerId"],"description":"The merchant's CRB banking identity. CRB is onboarded manually in CRB's\ndashboard — these values are pasted into our merchant dashboard and\nverified live against CRB before being persisted.","title":"CrbMerchantSettings"},"HighnoteMerchantSettings":{"type":"object","properties":{"businessId":{"type":"string"},"primaryAuthorizedPersonId":{"type":"string","description":"Highnote id of the primary business person, captured from the\ncreateBusiness response — onboardBusiness attributes its consent to it."},"merchantAcceptorId":{"type":"string"},"applicationSubmittedAt":{"type":"string","format":"date-time","description":"Set when onboardBusiness (the ProductApplication submission) succeeded.\nA re-run while underwriting is still Pending must not re-submit the\napplication — Highnote rejects duplicates, which would overwrite a\nhealthy Pending status with an error."}},"required":["businessId"],"title":"HighnoteMerchantSettings"},"PayarcMerchantArgs":{"type":"object","properties":{"apiKey":{"type":"string"},"merchantId":{"type":"string"}},"required":["apiKey"],"title":"PayarcMerchantArgs"},"AcquirerInfo":{"type":"object","properties":{"merchantId":{"type":"string"},"bin":{"type":"string"},"name":{"type":"string"},"mcc":{"type":"string"}},"required":["merchantId","bin","name"],"title":"AcquirerInfo"},"ThreeDSArgs":{"type":"object","properties":{"VISA":{"$ref":"#/components/schemas/AcquirerInfo"},"MSTR":{"$ref":"#/components/schemas/AcquirerInfo"},"AMEX":{"$ref":"#/components/schemas/AcquirerInfo"},"DISC":{"$ref":"#/components/schemas/AcquirerInfo"},"scaOnly":{"type":"boolean"},"allowAttempts":{"type":"boolean"},"mcc":{"type":"string"}},"required":["VISA","MSTR","AMEX","DISC","allowAttempts","mcc"],"description":"Construct a type with a set of properties K of type T","title":"ThreeDSArgs"},"TokenizationProviderOption":{"type":"string","enum":["bt","tokenex"],"title":"TokenizationProviderOption"},"ApplePayIntegratorRegistration":{"type":"object","properties":{"domainNames":{"type":"array","items":{"type":"string"}},"partnerMerchantName":{"type":"string"},"partnerMerchantValidationURI":{"type":"string"},"partnerInternalMerchantIdentifier":{"type":"string"}},"required":["domainNames","partnerMerchantName","partnerMerchantValidationURI","partnerInternalMerchantIdentifier"],"title":"ApplePayIntegratorRegistration"},"CardSettingsApplePayCertificates":{"type":"object","properties":{"merchantIdCert":{"type":"string"},"privatePem":{"type":"string"},"certPem":{"type":"string"},"merchantDisplay":{"type":"string"},"merchantIdentifier":{"type":"string"}},"required":["merchantIdCert","privatePem","certPem","merchantDisplay","merchantIdentifier"],"title":"CardSettingsApplePayCertificates"},"AftType":{"type":"string","enum":["disbursement","personToPerson","accountToAccount","topUp","purchase","cash","walletLoad"],"title":"AftType"},"AftPurpose":{"type":"string","enum":["businessToBusiness","creditCardRepayment","crypto","crowdLending","debitCard","education","emergency","familySupport","gift","giftCard","gaming","highRiskSecurities","liquidAssets","medical","payroll","prepaidCard","salary","savings","travel","other"],"title":"AftPurpose"},"AftSettingsMerchantA2AMastercardAftRecipient":{"type":"object","properties":{"walletReference":{"type":"string"},"countryCode":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"}},"required":["walletReference","countryCode","state","postalCode","city","address1","lastName","firstName"],"title":"AftSettingsMerchantA2AMastercardAftRecipient"},"AftSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"$ref":"#/components/schemas/AftType"},"purpose":{"$ref":"#/components/schemas/AftPurpose"},"merchantA2AMastercardAftRecipient":{"$ref":"#/components/schemas/AftSettingsMerchantA2AMastercardAftRecipient"}},"required":["enabled","type","purpose"],"title":"AftSettings"},"CardOnFileSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"period":{"type":"number","format":"double"},"maxCount":{"type":"number","format":"double"},"maxMultiple":{"type":"number","format":"double"},"expiration":{"type":"number","format":"double"},"maxZeroAuthAmount":{"$ref":"#/components/schemas/Cents"},"maxAmountLookback":{"type":"number","format":"double"},"amountLimitThreshold":{"$ref":"#/components/schemas/Cents"}},"required":["enabled","period","maxCount","maxMultiple","expiration"],"title":"CardOnFileSettings"},"CardType":{"type":"string","enum":["VISA","MSTR","AMEX","DISC"],"title":"CardType"},"RefundFeeSettings":{"type":"object","properties":{"feeBps":{"type":"number","format":"double"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"minFee":{"$ref":"#/components/schemas/Cents"},"maxFee":{"$ref":"#/components/schemas/Cents"}},"title":"RefundFeeSettings"},"CardSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"orchestrationRuleId":{"type":"string"},"applePayProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"googlePayProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"creditCardFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"chargebackProtectionFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"gasFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"networkFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"variableFeeBps":{"type":"number","format":"double"},"networkFeeBps":{"type":"number","format":"double"},"networkFixedFee":{"$ref":"#/components/schemas/Cents"},"supportsGooglePay":{"type":"boolean"},"supportsApplePay":{"type":"boolean"},"saveCardDefault":{"type":"boolean"},"ignoreProcessorLimit":{"type":"boolean"},"nameMatchThreshold":{"type":"number","format":"double"},"verificationSettings":{"$ref":"#/components/schemas/CardSettingsVerificationSettings"},"avsCheck":{"type":"boolean"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"enforce3DSWhenProtectionExempt":{"type":"boolean"},"greenlightMerchantArgs":{"$ref":"#/components/schemas/GreenlightMerchantArgs"},"nuveiV1MerchantArgs":{"$ref":"#/components/schemas/NuveiV1MerchantArgs"},"crbMerchantArgs":{"$ref":"#/components/schemas/CrbMerchantSettings"},"highnoteMerchantArgs":{"$ref":"#/components/schemas/HighnoteMerchantSettings"},"payarcMerchantArgs":{"$ref":"#/components/schemas/PayarcMerchantArgs"},"threeDSArgs":{"$ref":"#/components/schemas/ThreeDSArgs"},"statementDescriptor":{"type":"string"},"tokenizationProvider":{"$ref":"#/components/schemas/TokenizationProviderOption"},"applePayIntegratorRegistration":{"$ref":"#/components/schemas/ApplePayIntegratorRegistration"},"applePayMerchantDecryption":{"type":"boolean"},"applePayCertificates":{"$ref":"#/components/schemas/CardSettingsApplePayCertificates"},"aftSettings":{"$ref":"#/components/schemas/AftSettings"},"customStatementDescriptor":{"type":"boolean"},"cardOnFileSettings":{"$ref":"#/components/schemas/CardOnFileSettings"},"mitSettings":{"$ref":"#/components/schemas/CardOnFileSettings"},"blockCardReuseAcrossCustomers":{"type":"boolean","description":"When true, blocks a card payment if the same card token has been used by a different customer for this merchant."},"allowedCardNetworks":{"type":"array","items":{"$ref":"#/components/schemas/CardType"}},"allowServerToServerTokenization":{"type":"boolean"},"visaFraudMonitoringProgram":{"type":"boolean"},"debitOnly":{"type":"boolean"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"}},"required":["customerEmailNotifications","merchantEmailNotifications","avsCheck","threeDsChallengePreference","enforce3DSWhenProtectionExempt"],"title":"CardSettings"},"AchProcessor":{"type":"string","enum":["mock","aptpay","coinfx","braid"],"title":"AchProcessor"},"ACHSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/AchProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"maxAmount":{"$ref":"#/components/schemas/Cents"},"nameMatchThreshold":{"type":"number","format":"double"},"requireKycBeforePurchase":{"type":"boolean"},"withdrawNameMatchThreshold":{"type":"number","format":"double"},"allowDelayedTransactions":{"type":"boolean"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"instantSettle":{"type":"boolean"},"minFee":{"$ref":"#/components/schemas/Cents"},"maxFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"settlementDays":{"type":"number","format":"double"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"},"allowedOrderTypes":{"type":"array","items":{"$ref":"#/components/schemas/OrderType"},"description":"If set and non-empty, `achCheckout` requires `orderType` to be one of\nthese values, and also requires a valid `achAuthorizationId`\nreferencing an existing ACH authorization."},"achReturnFeeCents":{"type":"number","format":"double"}},"required":["allowDelayedTransactions","customerEmailNotifications","merchantEmailNotifications","instantSettle"],"title":"ACHSettings"},"CitconSettingsFundPurpose":{"type":"string","enum":["goods","services","prizes","rebates","others"],"title":"CitconSettingsFundPurpose"},"CitconSettings":{"type":"object","properties":{"fundPurpose":{"$ref":"#/components/schemas/CitconSettingsFundPurpose"},"apiKey":{"type":"string"},"apiKeyPreview":{"type":"string"}},"required":["fundPurpose"],"title":"CitconSettings"},"AptpayCanadaMerchantSettings":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"AptpayCanadaMerchantSettings"},"AptpayCanadaCoinflowSettings":{"type":"object","properties":{"coinflow":{"type":"boolean"}},"required":["coinflow"],"title":"AptpayCanadaCoinflowSettings"},"AptPayCanadaSettings":{"oneOf":[{"$ref":"#/components/schemas/AptpayCanadaMerchantSettings"},{"$ref":"#/components/schemas/AptpayCanadaCoinflowSettings"}],"title":"AptPayCanadaSettings"},"WireProcessor":{"type":"string","enum":["braid","mock"],"title":"WireProcessor"},"IWireProviderSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/WireProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"minFee":{"$ref":"#/components/schemas/Cents"},"maxFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"dailyLimit":{"$ref":"#/components/schemas/Cents"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"title":"IWireProviderSettings"},"PixProcessor":{"type":"string","enum":["brla","mock"],"title":"PixProcessor"},"PixSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/PixProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"title":"PixSettings"},"IbanProcessor":{"type":"string","enum":["merge","ivy","mock"],"title":"IbanProcessor"},"IbanSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/IbanProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"minFee":{"$ref":"#/components/schemas/Cents"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"title":"IbanSettings"},"TierSettings":{"type":"object","properties":{"feeBps":{"type":"number","format":"double"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"enabled":{"type":"boolean"}},"required":["feeBps","enabled"],"title":"TierSettings"},"CryptoPayInSettings":{"type":"object","properties":{"stables":{"$ref":"#/components/schemas/TierSettings"},"majors":{"$ref":"#/components/schemas/TierSettings"},"volatile":{"$ref":"#/components/schemas/TierSettings"},"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"enabled":{"type":"boolean"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"maxGasFeePayment":{"$ref":"#/components/schemas/Cents"},"coinbaseDisabled":{"type":"boolean"},"transferOnly":{"type":"boolean"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"enableStableDepositAddresses":{"type":"boolean"},"maxActivePassiveAddresses":{"type":"number","format":"double","description":"Cap on the number of simultaneously-active customer pay-in passive\ndeposit addresses for this merchant. Undefined = no cap. Paused\naddresses don't count against the cap."}},"required":["stables","majors","volatile","enabled","maxGasFeePayment","coinbaseDisabled","customerEmailNotifications","merchantEmailNotifications"],"title":"CryptoPayInSettings"},"CryptoPayoutTierSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"feeBps":{"type":"number","format":"double"},"feeFixedCents":{"type":"number","format":"double"}},"required":["enabled","feeBps","feeFixedCents"],"title":"CryptoPayoutTierSettings"},"Record_CryptoPayoutTiers.CryptoPayoutTierSettings_":{"type":"object","properties":{"stables":{"$ref":"#/components/schemas/CryptoPayoutTierSettings"},"majors":{"$ref":"#/components/schemas/CryptoPayoutTierSettings"}},"required":["stables","majors"],"description":"Construct a type with a set of properties K of type T","title":"Record_CryptoPayoutTiers.CryptoPayoutTierSettings_"},"PassiveWithdrawSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"maxActiveAddresses":{"type":"number","format":"double","description":"Cap on the number of simultaneously-active withdraw passive deposit\naddresses for this merchant. Undefined = no cap."}},"required":["enabled"],"description":"Merchant-level settings for the withdrawer-side passive deposit address\nflow (CryptoWithdrawService). Independent from CryptoPayInSettings.","title":"PassiveWithdrawSettings"},"CashAppProcessor":{"type":"string","enum":["mock","flashnet"],"title":"CashAppProcessor"},"CashAppSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/CashAppProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"minFee":{"$ref":"#/components/schemas/Cents"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"title":"CashAppSettings"},"RainCardApplicationStatus":{"type":"string","enum":["approved","pending","needsInformation","needsVerification","manualReview","denied","locked","canceled"],"title":"RainCardApplicationStatus"},"RainAccountDetails":{"type":"object","properties":{"beneficiaryName":{"type":"string"},"beneficiaryAddress":{"type":"string"},"beneficiaryBankName":{"type":"string"},"beneficiaryBankAddress":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"}},"required":["beneficiaryName","beneficiaryAddress","accountNumber","routingNumber"],"title":"RainAccountDetails"},"RainContractInfoOnramp":{"type":"object","properties":{"wire":{"$ref":"#/components/schemas/RainAccountDetails"},"rtp":{"$ref":"#/components/schemas/RainAccountDetails"},"ach":{"$ref":"#/components/schemas/RainAccountDetails"}},"title":"RainContractInfoOnramp"},"RainContractInfo":{"type":"object","properties":{"contractId":{"type":"string"},"chainId":{"type":"number","format":"double"},"depositAddress":{"type":"string"},"programAddress":{"type":"string"},"proxyAddress":{"type":"string"},"controllerAddress":{"type":"string"},"contractVersion":{"type":"number","format":"double"},"adminAddresses":{"type":"array","items":{"type":"string"}},"onramp":{"$ref":"#/components/schemas/RainContractInfoOnramp"},"createdAt":{"type":"string","format":"date-time"},"lastSyncedAt":{"type":"string","format":"date-time"}},"required":["contractId","chainId","depositAddress","createdAt","lastSyncedAt"],"title":"RainContractInfo"},"RainAutoTopUpCadence":{"type":"string","enum":["transaction","hour","day","week","month"],"title":"RainAutoTopUpCadence"},"RainAutoTopUpSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"targetUsdc":{"type":"number","format":"double"},"cadence":{"$ref":"#/components/schemas/RainAutoTopUpCadence"},"lastRunAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}},"required":["enabled","targetUsdc","cadence"],"title":"RainAutoTopUpSettings"},"RainPendingTopUp":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"queuedAt":{"type":"string","format":"date-time"},"transactionId":{"type":"string"}},"required":["amount","queuedAt","transactionId"],"title":"RainPendingTopUp"},"RainCompanyCardsSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"rainCompanyId":{"type":"string"},"externalId":{"type":"string"},"applicationStatus":{"$ref":"#/components/schemas/RainCardApplicationStatus"},"applicationReason":{"type":"string"},"completionLink":{"type":"string"},"submittedAt":{"type":"string","format":"date-time"},"lastSyncedAt":{"type":"string","format":"date-time"},"contract":{"$ref":"#/components/schemas/RainContractInfo"},"autoTopUp":{"$ref":"#/components/schemas/RainAutoTopUpSettings"},"pendingTopUps":{"type":"array","items":{"$ref":"#/components/schemas/RainPendingTopUp"}},"processedSpendTxnIds":{"type":"array","items":{"type":"string"}}},"title":"RainCompanyCardsSettings"},"PayPalProcessor":{"type":"string","enum":["mock","paypal"],"title":"PayPalProcessor"},"PayPalSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/PayPalProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"maxFee":{"$ref":"#/components/schemas/Cents"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"minFee":{"$ref":"#/components/schemas/Cents"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"},"requireLogin":{"type":"boolean","description":"When set, new PayPal payout accounts must be linked via the verified\n\"Log in with PayPal\" flow — raw phone/email adds are rejected. Not\nretroactive: already-linked accounts remain payable."},"blockPayerReuseAcrossCustomers":{"type":"boolean","description":"When true, blocks a PayPal payment if the same PayPal payer identity (payerId/email) has been used by a different customer for this merchant."},"nameMatchThreshold":{"type":"number","format":"double","description":"0–100 fuzzy-match floor for the PayPal buyer name vs. the customer's name; below it the payment is failed before authorizing. Unset = disabled."},"vaultingEnabled":{"type":"boolean"}},"required":["fixedFee","feeBps","minFee","customerEmailNotifications","merchantEmailNotifications"],"title":"PayPalSettings"},"VenmoProcessor":{"type":"string","enum":["mock","paypal"],"title":"VenmoProcessor"},"VenmoSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/VenmoProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"maxFee":{"$ref":"#/components/schemas/Cents"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"minFee":{"$ref":"#/components/schemas/Cents"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"},"refundFeeSettings":{"$ref":"#/components/schemas/RefundFeeSettings"},"blockPayerReuseAcrossCustomers":{"type":"boolean","description":"When true, blocks a Venmo payment if the same Venmo payer identity (payerId/email) has been used by a different customer for this merchant."},"nameMatchThreshold":{"type":"number","format":"double","description":"0–100 fuzzy-match floor for the Venmo buyer name vs. the customer's name; below it the payment is failed before authorizing. Unset = disabled."},"vaultingEnabled":{"type":"boolean"}},"required":["fixedFee","feeBps","customerEmailNotifications","merchantEmailNotifications"],"title":"VenmoSettings"},"ApaProcessor":{"type":"string","enum":["apa","mock"],"title":"ApaProcessor"},"ApaSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/ApaProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"minFee":{"$ref":"#/components/schemas/Cents"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"title":"ApaSettings"},"VerisoulRiskThresholds":{"type":"object","properties":{"device_risk":{"type":"number","format":"double"},"proxy":{"type":"number","format":"double"},"vpn":{"type":"number","format":"double"},"tor":{"type":"number","format":"double"},"spoofed_ip":{"type":"number","format":"double"},"datacenter":{"type":"number","format":"double"},"recent_fraud_ip":{"type":"number","format":"double"},"impossible_travel":{"type":"number","format":"double"},"device_network_mismatch":{"type":"number","format":"double"},"account_score":{"type":"number","format":"double"},"risk_signals":{"type":"number","format":"double"},"email_score":{"type":"number","format":"double"}},"title":"VerisoulRiskThresholds"},"VerisoulSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"riskThresholds":{"$ref":"#/components/schemas/VerisoulRiskThresholds"}},"required":["enabled","riskThresholds"],"title":"VerisoulSettings"},"ChargebackFightSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Master enrollment switch. When false, shouldFight is always false."}},"required":["enabled"],"description":"Per-merchant chargeback-fight enrollment. This is the only per-merchant\ndimension of the `shouldFight` flag: when `enabled` is false (or the settings\nare absent) `shouldFight` is always false for that merchant. The actual match\nrules (processor + protection decision) live in the global\n{@link ChargebackFightRuleset }, configured by ops on the Chargeback Ops page.","title":"ChargebackFightSettings"},"BlockingRuleScope":{"type":"string","enum":["WITHDRAWAL","CHECKOUT","GLOBAL"],"title":"BlockingRuleScope"},"BlockingRuleMethod":{"type":"string","enum":["KYC_ADDRESS","IP","BILLING_ADDRESS","GEOLOCATION","BIN"],"title":"BlockingRuleMethod"},"BlockingRuleListMode":{"type":"string","enum":["DENY","ALLOW"],"title":"BlockingRuleListMode"},"USState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"USState"},"Country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AX","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CD","CG","CK","CR","HR","CU","CW","CY","CZ","CI","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","EH","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","XK","YE","ZM","ZW"],"title":"Country"},"IBlockingRule":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/BlockingRuleScope"},"method":{"$ref":"#/components/schemas/BlockingRuleMethod"},"listMode":{"$ref":"#/components/schemas/BlockingRuleListMode"},"states":{"type":"array","items":{"$ref":"#/components/schemas/USState"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"required":["scope","method","states"],"description":"A single geo-blocking rule on a merchant. Multiple rules of the same scope\nare OR-combined: any matching rule blocks the request. When both DENY and\nALLOW rules are configured, DENY rules are evaluated first — a matching\nDENY blocks the request even if the user is on a separate ALLOW list.\n\n`listMode` controls interpretation (defaults to `DENY`):\n- `DENY`: the listed countries/states are blocked.\n- `ALLOW`: ONLY the listed countries/states are permitted; everything else\n  is blocked.\n\nA rule may specify `countries` (ISO 3166-1 alpha-2 codes), `states`\n(US state codes), or both.\n\n- `scope: GLOBAL` applies to BOTH withdrawal and checkout flows; only valid\n  with `method: IP` (the only method that makes sense for both flows).\n- `method: KYC_ADDRESS` is only valid with `scope: WITHDRAWAL`.\n- `method: BILLING_ADDRESS` is only valid with `scope: CHECKOUT`.\n- `method: IP` is **strictly** fail-closed in both DENY and ALLOW modes:\n  missing IP, failed lookup, or an unresolvable US state resolved from\n  the IP rejects the withdrawal. Both the resolved country and the\n  resolved state (US-only) are evaluated on every request against the\n  rule's `countries` and `states` lists. Skipped on merchant-initiated\n  payouts where no end-user IP exists (`merchantInitiated: true`).\n- `method: GEOLOCATION` is a **best-effort, optional** signal and only\n  valid with `scope: WITHDRAWAL`. When the caller supplies a fresh,\n  resolvable `userLocation`, the rule enforces strictly against the\n  block list. When the signal is absent (browser permission denied,\n  merchant did not send coords, stale capture, or reverse-geocode\n  failure), enforcement is skipped — pair with an `IP` rule for hard\n  real-time enforcement.","title":"IBlockingRule"},"IMerchantStringBlockConfig":{"type":"object","properties":{"disableMultiCardAttemptCheck":{"type":"boolean","description":"When true, skips the multi-card attempt check (2+ distinct cards failing in 1 hour)."},"maxDistinctTokensPer30Days":{"type":"number","format":"double","description":"Maximum number of distinct card tokens a single customer may use across\nnon-failed/voided card payments for this merchant in a rolling 30-day\nwindow. Apple Pay / Google Pay payments are excluded. Unset or 0 disables\nthe check. Customers with `failedAttemptSetting: Exempt` bypass it."},"disableDestinationAuthKey":{"type":"boolean","description":"When true, prevents usage of destinationAuthKey for custom settlement addresses."},"enableNmiSettlement":{"type":"boolean","description":"When true, enables the settlement pipeline for NMI transactions (converts card payments to USDC)."},"disableInvoiceWalletPayment":{"type":"boolean","description":"When true, disables wallet balance payments for invoices. Merchants must use checkout."},"blockingRules":{"type":"array","items":{"$ref":"#/components/schemas/IBlockingRule"},"description":"Independent geo-blocking rules for withdrawals vs card checkout, with\nexplicit per-rule enforcement methods (KYC address / IP / billing address).\nRead via `getBlockingRules` so callers transparently see the legacy\n`bannedWithdrawalStates` for un-migrated merchants."},"bannedWithdrawalStates":{"type":"array","items":{"$ref":"#/components/schemas/USState"},"deprecated":true},"whitelistedBinLocations":{"type":"array","items":{"$ref":"#/components/schemas/Country"},"deprecated":true},"failedPaymentAttemptLimit":{"type":"number","format":"double"}},"title":"IMerchantStringBlockConfig"},"InvoiceFrequency":{"type":"string","enum":["Monthly","BiWeekly","Weekly"],"title":"InvoiceFrequency"},"Partial_Record_Blockchain.boolean__":{"type":"object","properties":{"solana":{"type":"boolean"},"eth":{"type":"boolean"},"polygon":{"type":"boolean"},"base":{"type":"boolean"},"user":{"type":"boolean"},"arbitrum":{"type":"boolean"},"stellar":{"type":"boolean"},"monad":{"type":"boolean"},"tempo":{"type":"boolean"}},"description":"Make all properties in T optional","title":"Partial_Record_Blockchain.boolean__"},"IMerchantStringWithdrawFeePayment":{"type":"object","properties":{"paysGasFees":{"$ref":"#/components/schemas/Partial_Record_Blockchain.boolean__"},"bundleDelegatedPayoutFees":{"type":"boolean"},"paysSwapFees":{"type":"boolean"},"paysWithdrawFees":{"type":"boolean"}},"title":"IMerchantStringWithdrawFeePayment"},"PayoutProviderOption":{"type":"string","enum":["aptpay","coinfx","checkbook","BRAID","brale","mock"],"title":"PayoutProviderOption"},"IbanPayoutProvider":{"type":"string","enum":["merge","mock","ivy"],"title":"IbanPayoutProvider"},"SwiftPayoutProvider":{"type":"string","enum":["manual","mock"],"title":"SwiftPayoutProvider"},"RtpPayoutProvider":{"type":"string","enum":["dwolla","mock","aptpay","aptpayRtp","checkbook","brale"],"title":"RtpPayoutProvider"},"PixPayoutProvider":{"type":"string","enum":["brla","mock"],"title":"PixPayoutProvider"},"EftPayoutProvider":{"type":"string","enum":["checkbook","aptpay","mock"],"title":"EftPayoutProvider"},"CardPayoutProvider":{"type":"string","enum":["aptpay","checkbook","shift4","citcon","MOCK"],"title":"CardPayoutProvider"},"ApplePayPayoutProvider":{"type":"string","enum":["aptpay","MOCK"],"title":"ApplePayPayoutProvider"},"VenmoPayoutProvider":{"type":"string","enum":["checkbook","citcon","mock","paypal"],"title":"VenmoPayoutProvider"},"PayPalPayoutProvider":{"type":"string","enum":["checkbook","citcon","mock","paypal"],"title":"PayPalPayoutProvider"},"WirePayoutProvider":{"type":"string","enum":["MOCK","BRAID"],"title":"WirePayoutProvider"},"CryptoPayoutProvider":{"type":"string","enum":["glide","relay","direct","mock"],"title":"CryptoPayoutProvider"},"InteracPayoutProvider":{"type":"string","enum":["checkbook","mock","aptpay"],"title":"InteracPayoutProvider"},"InteracProcessor":{"type":"string","enum":["mock","aptpay"],"title":"InteracProcessor"},"InteracSettings":{"type":"object","properties":{"rebateBps":{"type":"number","format":"double"},"rebateFixed":{"$ref":"#/components/schemas/Cents"},"processor":{"$ref":"#/components/schemas/InteracProcessor"},"feeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fxFeeMode":{"$ref":"#/components/schemas/FeePayerMode"},"fixedFee":{"$ref":"#/components/schemas/Cents"},"feeBps":{"type":"number","format":"double"},"minFee":{"$ref":"#/components/schemas/Cents"},"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"title":"InteracSettings"},"WithdrawSort":{"type":"string","enum":["DEFAULT","CHEAPEST","ORDERED","LIMIT_CONSUMPTION"],"title":"WithdrawSort"},"Partial_Record_WithdrawSpeed.WithdrawSort__":{"type":"object","properties":{"asap":{"$ref":"#/components/schemas/WithdrawSort"},"same_day":{"$ref":"#/components/schemas/WithdrawSort"},"standard":{"$ref":"#/components/schemas/WithdrawSort"},"card":{"$ref":"#/components/schemas/WithdrawSort"},"iban":{"$ref":"#/components/schemas/WithdrawSort"},"pix":{"$ref":"#/components/schemas/WithdrawSort"},"eft":{"$ref":"#/components/schemas/WithdrawSort"},"venmo":{"$ref":"#/components/schemas/WithdrawSort"},"paypal":{"$ref":"#/components/schemas/WithdrawSort"},"wire":{"$ref":"#/components/schemas/WithdrawSort"},"interac":{"$ref":"#/components/schemas/WithdrawSort"},"swift":{"$ref":"#/components/schemas/WithdrawSort"},"crypto":{"$ref":"#/components/schemas/WithdrawSort"}},"description":"Make all properties in T optional","title":"Partial_Record_WithdrawSpeed.WithdrawSort__"},"IMerchantStringFirstPartyPayoutOverrides":{"type":"object","properties":{"interacPayoutProvider":{"$ref":"#/components/schemas/InteracPayoutProvider"},"wirePayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/WirePayoutProvider"}},"paypalPayoutProvider":{"$ref":"#/components/schemas/PayPalPayoutProvider"},"venmoPayoutProvider":{"$ref":"#/components/schemas/VenmoPayoutProvider"},"appleP2cPayoutProvider":{"$ref":"#/components/schemas/ApplePayPayoutProvider"},"globalP2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"p2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"eftPayoutProvider":{"$ref":"#/components/schemas/EftPayoutProvider"},"pixPayoutProvider":{"$ref":"#/components/schemas/PixPayoutProvider"},"rtpPayoutProvider":{"$ref":"#/components/schemas/RtpPayoutProvider"},"ibanPayoutProvider":{"$ref":"#/components/schemas/IbanPayoutProvider"},"bankPayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/PayoutProviderOption"}}},"title":"IMerchantStringFirstPartyPayoutOverrides","deprecated":true},"OnboardingVersion":{"type":"string","enum":["legacy","sdd","global"],"title":"OnboardingVersion"},"SettlementLocations":{"type":"string","enum":["circle","brale","paper","brale_youpay","bastion"],"title":"SettlementLocations"},"Partial_Record_Currency.number__":{"type":"object","properties":{"USD":{"type":"number","format":"double"},"AED":{"type":"number","format":"double"},"AFN":{"type":"number","format":"double"},"ALL":{"type":"number","format":"double"},"AMD":{"type":"number","format":"double"},"ANG":{"type":"number","format":"double"},"AOA":{"type":"number","format":"double"},"ARS":{"type":"number","format":"double"},"AUD":{"type":"number","format":"double"},"AWG":{"type":"number","format":"double"},"AZN":{"type":"number","format":"double"},"BAM":{"type":"number","format":"double"},"BBD":{"type":"number","format":"double"},"BDT":{"type":"number","format":"double"},"BGN":{"type":"number","format":"double"},"BHD":{"type":"number","format":"double"},"BIF":{"type":"number","format":"double"},"BMD":{"type":"number","format":"double"},"BND":{"type":"number","format":"double"},"BOB":{"type":"number","format":"double"},"BRL":{"type":"number","format":"double"},"BSD":{"type":"number","format":"double"},"BTN":{"type":"number","format":"double"},"BWP":{"type":"number","format":"double"},"BYN":{"type":"number","format":"double"},"BZD":{"type":"number","format":"double"},"CAD":{"type":"number","format":"double"},"CHF":{"type":"number","format":"double"},"CLF":{"type":"number","format":"double"},"CLP":{"type":"number","format":"double"},"CNY":{"type":"number","format":"double"},"COP":{"type":"number","format":"double"},"CRC":{"type":"number","format":"double"},"CUP":{"type":"number","format":"double"},"CVE":{"type":"number","format":"double"},"CZK":{"type":"number","format":"double"},"DJF":{"type":"number","format":"double"},"DKK":{"type":"number","format":"double"},"DOP":{"type":"number","format":"double"},"DZD":{"type":"number","format":"double"},"EGP":{"type":"number","format":"double"},"ETB":{"type":"number","format":"double"},"EUR":{"type":"number","format":"double"},"FJD":{"type":"number","format":"double"},"GBP":{"type":"number","format":"double"},"GEL":{"type":"number","format":"double"},"GHS":{"type":"number","format":"double"},"GMD":{"type":"number","format":"double"},"GNF":{"type":"number","format":"double"},"GTQ":{"type":"number","format":"double"},"GYD":{"type":"number","format":"double"},"HKD":{"type":"number","format":"double"},"HNL":{"type":"number","format":"double"},"HTG":{"type":"number","format":"double"},"HUF":{"type":"number","format":"double"},"IDR":{"type":"number","format":"double"},"ILS":{"type":"number","format":"double"},"INR":{"type":"number","format":"double"},"IQD":{"type":"number","format":"double"},"IRR":{"type":"number","format":"double"},"ISK":{"type":"number","format":"double"},"JMD":{"type":"number","format":"double"},"JOD":{"type":"number","format":"double"},"JPY":{"type":"number","format":"double"},"KES":{"type":"number","format":"double"},"KGS":{"type":"number","format":"double"},"KHR":{"type":"number","format":"double"},"KMF":{"type":"number","format":"double"},"KRW":{"type":"number","format":"double"},"KWD":{"type":"number","format":"double"},"KYD":{"type":"number","format":"double"},"KZT":{"type":"number","format":"double"},"LAK":{"type":"number","format":"double"},"LBP":{"type":"number","format":"double"},"LKR":{"type":"number","format":"double"},"LRD":{"type":"number","format":"double"},"LSL":{"type":"number","format":"double"},"LYD":{"type":"number","format":"double"},"MAD":{"type":"number","format":"double"},"MDL":{"type":"number","format":"double"},"MGA":{"type":"number","format":"double"},"MKD":{"type":"number","format":"double"},"MMK":{"type":"number","format":"double"},"MNT":{"type":"number","format":"double"},"MOP":{"type":"number","format":"double"},"MRU":{"type":"number","format":"double"},"MUR":{"type":"number","format":"double"},"MWK":{"type":"number","format":"double"},"MVR":{"type":"number","format":"double"},"MXN":{"type":"number","format":"double"},"MYR":{"type":"number","format":"double"},"MZN":{"type":"number","format":"double"},"NAD":{"type":"number","format":"double"},"NGN":{"type":"number","format":"double"},"NIO":{"type":"number","format":"double"},"NOK":{"type":"number","format":"double"},"NPR":{"type":"number","format":"double"},"NZD":{"type":"number","format":"double"},"OMR":{"type":"number","format":"double"},"PAB":{"type":"number","format":"double"},"PEN":{"type":"number","format":"double"},"PGK":{"type":"number","format":"double"},"PHP":{"type":"number","format":"double"},"PKR":{"type":"number","format":"double"},"PLN":{"type":"number","format":"double"},"PYG":{"type":"number","format":"double"},"QAR":{"type":"number","format":"double"},"RON":{"type":"number","format":"double"},"RSD":{"type":"number","format":"double"},"RWF":{"type":"number","format":"double"},"SAR":{"type":"number","format":"double"},"SCR":{"type":"number","format":"double"},"SDG":{"type":"number","format":"double"},"SEK":{"type":"number","format":"double"},"SGD":{"type":"number","format":"double"},"SLE":{"type":"number","format":"double"},"SLL":{"type":"number","format":"double"},"SOS":{"type":"number","format":"double"},"SRD":{"type":"number","format":"double"},"STN":{"type":"number","format":"double"},"SVC":{"type":"number","format":"double"},"SYP":{"type":"number","format":"double"},"SZL":{"type":"number","format":"double"},"THB":{"type":"number","format":"double"},"TJS":{"type":"number","format":"double"},"TMT":{"type":"number","format":"double"},"TND":{"type":"number","format":"double"},"TOP":{"type":"number","format":"double"},"TRY":{"type":"number","format":"double"},"TTD":{"type":"number","format":"double"},"TWD":{"type":"number","format":"double"},"TZS":{"type":"number","format":"double"},"UAH":{"type":"number","format":"double"},"UGX":{"type":"number","format":"double"},"UYU":{"type":"number","format":"double"},"UZS":{"type":"number","format":"double"},"VND":{"type":"number","format":"double"},"VUV":{"type":"number","format":"double"},"WST":{"type":"number","format":"double"},"XAF":{"type":"number","format":"double"},"XCD":{"type":"number","format":"double"},"XOF":{"type":"number","format":"double"},"XPF":{"type":"number","format":"double"},"YER":{"type":"number","format":"double"},"ZAR":{"type":"number","format":"double"},"ZMW":{"type":"number","format":"double"},"ZWL":{"type":"number","format":"double"},"CDF":{"type":"number","format":"double"},"ERN":{"type":"number","format":"double"},"FKP":{"type":"number","format":"double"},"KPW":{"type":"number","format":"double"},"RUB":{"type":"number","format":"double"},"SBD":{"type":"number","format":"double"},"SHP":{"type":"number","format":"double"},"SSP":{"type":"number","format":"double"},"VES":{"type":"number","format":"double"}},"description":"Make all properties in T optional","title":"Partial_Record_Currency.number__"},"BlockedLevel":{"type":"string","enum":["Unverified","Suspended"],"title":"BlockedLevel"},"BlockedStatus":{"type":"object","properties":{"level":{"$ref":"#/components/schemas/BlockedLevel"},"reason":{"type":"string"},"editor":{"type":"string"},"blockedAt":{"type":"string","format":"date-time"},"recoverySignature":{"type":"string"}},"required":["level","reason","editor","blockedAt"],"title":"BlockedStatus"},"BraidMerchantSettings":{"type":"object","properties":{"businessId":{"type":"number","format":"double"},"accountId":{"type":"number","format":"double","description":"the Braid operating accountId"},"accountNumber":{"type":"string","description":"the Braid operating account number"},"reserveAccountId":{"type":"number","format":"double","description":"the Braid reserve accountId"},"reserveAccountNumber":{"type":"string","description":"the Braid reserve account number"},"rollingAccountId":{"type":"number","format":"double","description":"the Braid rolling accountId"},"rollingAccountNumber":{"type":"string","description":"the Braid rolling account number"}},"required":["businessId","accountId","accountNumber","reserveAccountId","reserveAccountNumber"],"title":"BraidMerchantSettings"},"IvySettings":{"type":"object","properties":{"gbpPayinAccountId":{"type":"string"},"eurAccountId":{"type":"string"}},"required":["gbpPayinAccountId","eurAccountId"],"title":"IvySettings"},"PayPalVendorSettings":{"type":"object","properties":{"accountId":{"type":"string"},"status":{"type":"string","description":"PAY_WITH_PAYPAL capability status (ACTIVE / NEED_DATA / SUSPENDED)."},"requirements":{"type":"array","items":{"type":"string"},"description":"Outstanding requirements blocking PAY_WITH_PAYPAL."},"venmoStatus":{"type":"string","description":"VENMO_PAY_PROCESSING capability status — same account, separate status."},"venmoRequirements":{"type":"array","items":{"type":"string"},"description":"Outstanding requirements blocking VENMO_PAY_PROCESSING."},"stakeholderIds":{"type":"array","items":{"type":"string"}},"verificationTriggered":{"type":"boolean","description":"True once we've asked PayPal to (re)verify this account's capabilities.\ntriggerVerification itself makes PayPal emit a CAPABILITY_UPDATED webhook,\nso this flag stops that webhook from triggering verification again forever."}},"required":["accountId"],"title":"PayPalVendorSettings"},"VendorSettingsKoard":{"type":"object","properties":{"enabled":{"type":"boolean"},"apiKeyPreview":{"type":"string"},"apiKey":{"type":"string"},"accountId":{"type":"string"}},"required":["accountId"],"title":"VendorSettingsKoard"},"VendorSettings":{"type":"object","properties":{"aptPayIdentity":{"type":"number","format":"double"},"aptPayUSCoinflow":{"type":"boolean"},"braid":{"$ref":"#/components/schemas/BraidMerchantSettings"},"ivy":{"$ref":"#/components/schemas/IvySettings"},"paypal":{"$ref":"#/components/schemas/PayPalVendorSettings"},"koard":{"$ref":"#/components/schemas/VendorSettingsKoard"}},"title":"VendorSettings"},"MerchantBankSettlementOptions":{"type":"object","properties":{"token":{"type":"string"},"minRemainingBalance":{"$ref":"#/components/schemas/Cents"},"useWire":{"type":"boolean"}},"required":["token","minRemainingBalance"],"title":"MerchantBankSettlementOptions"},"VelocityLimitMode":{"type":"string","enum":["custom","no_limit"],"title":"VelocityLimitMode"},"VelocityControlSettings":{"type":"object","properties":{"limitMode":{"$ref":"#/components/schemas/VelocityLimitMode"},"customLimit":{"type":"number","format":"double"},"haltOnThreshold":{"type":"boolean"},"lastHaltNotificationSentAt":{"type":"string","format":"date-time"},"lastSettlementPausedNotificationSentAt":{"type":"string","format":"date-time"}},"required":["limitMode"],"title":"VelocityControlSettings"},"Partial_Record_PaymentType.VelocityControlSettings__":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/VelocityControlSettings"},"ach":{"$ref":"#/components/schemas/VelocityControlSettings"},"pix":{"$ref":"#/components/schemas/VelocityControlSettings"},"iban":{"$ref":"#/components/schemas/VelocityControlSettings"},"crypto":{"$ref":"#/components/schemas/VelocityControlSettings"},"wire":{"$ref":"#/components/schemas/VelocityControlSettings"},"CashApp":{"$ref":"#/components/schemas/VelocityControlSettings"},"paypal":{"$ref":"#/components/schemas/VelocityControlSettings"},"venmo":{"$ref":"#/components/schemas/VelocityControlSettings"},"apa":{"$ref":"#/components/schemas/VelocityControlSettings"},"interac":{"$ref":"#/components/schemas/VelocityControlSettings"}},"description":"Make all properties in T optional","title":"Partial_Record_PaymentType.VelocityControlSettings__"},"InterchangeSettings":{"type":"object","properties":{"useType":{"type":"boolean"},"useRegion":{"type":"boolean"},"useScheme":{"type":"boolean"},"useBrand":{"type":"boolean"},"useDurbin":{"type":"boolean"}},"required":["useType","useRegion","useScheme","useBrand","useDurbin"],"title":"InterchangeSettings"},"Record_string.InterchangeRate_":{"type":"object","properties":{},"description":"Construct a type with a set of properties K of type T","title":"Record_string.InterchangeRate_"},"InterchangeFees":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/InterchangeSettings"},"rates":{"$ref":"#/components/schemas/Record_string.InterchangeRate_"}},"required":["settings"],"title":"InterchangeFees"},"IMerchantStringCheckbookSettings":{"type":"object","properties":{"merchantName":{"type":"string"},"secret":{"type":"string"},"key":{"type":"string"},"walletId":{"type":"string"},"id":{"type":"string"}},"required":["merchantName","secret","key","walletId","id"],"title":"IMerchantStringCheckbookSettings"},"ReserveStatus":{"type":"string","enum":["Disabled","Active","SweepFixed"],"title":"ReserveStatus"},"ReserveSettings":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ReserveStatus"},"rollingBps":{"type":"number","format":"double"},"rollingDuration":{"type":"number","format":"double"},"notes":{"type":"string"}},"required":["status","rollingBps","rollingDuration"],"title":"ReserveSettings"},"EmbeddedAccountSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"maxOperatingPercentage":{"type":"number","format":"double"},"minBalance":{"$ref":"#/components/schemas/Cents"},"allowInternalTransfers":{"type":"boolean"}},"required":["enabled","allowInternalTransfers"],"title":"EmbeddedAccountSettings"},"TopupRiskControls":{"type":"object","properties":{"minAmountCents":{"type":"number","format":"double","description":"Minimum topup amount in cents"},"maxAmountCents":{"type":"number","format":"double","description":"Maximum topup amount in cents"}},"title":"TopupRiskControls"},"IMerchantStringRiskControls":{"type":"object","properties":{"topup":{"$ref":"#/components/schemas/TopupRiskControls"}},"title":"IMerchantStringRiskControls"},"MerchantSsoSettings":{"type":"object","properties":{"requireSso":{"type":"boolean"}},"required":["requireSso"],"title":"MerchantSsoSettings"},"LinkedBankAccountAccountType":{"type":"string","enum":["checking","savings"],"title":"LinkedBankAccountAccountType"},"LinkedBankAccount":{"type":"object","properties":{"routingNumber":{"type":"string"},"accountNumber":{"type":"string"},"accountType":{"$ref":"#/components/schemas/LinkedBankAccountAccountType"},"institutionName":{"type":"string"},"plaidAccessToken":{"type":"string"},"plaidAccountId":{"type":"string"}},"required":["routingNumber","accountNumber","accountType","plaidAccessToken","plaidAccountId"],"title":"LinkedBankAccount"},"IMerchantStringProcessing":{"type":"object","properties":{"msaSigned":{"type":"boolean"},"statementsOnFile":{"type":"boolean"}},"required":["msaSigned","statementsOnFile"],"title":"IMerchantStringProcessing"},"IMerchant_string_":{"type":"object","properties":{"_id":{"type":"string"},"merchantId":{"type":"string"},"verification":{"$ref":"#/components/schemas/Verification"},"brand":{"$ref":"#/components/schemas/MerchantBrandSettings"},"colors":{"$ref":"#/components/schemas/MerchantTheme"},"url":{"type":"string"},"supportEmail":{"type":"string"},"withdrawFees":{"$ref":"#/components/schemas/IMerchantStringWithdrawFees"},"customWithdrawFees":{"$ref":"#/components/schemas/CustomWithdrawFeesConfig"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"wallets":{"$ref":"#/components/schemas/IMerchantStringWallets"},"apiKey":{"type":"string"},"webhookValidationKey":{"type":"string"},"nmiWebhookValidationKey":{"type":"string"},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/IMerchantStringApiKeysItems"}},"kycType":{"$ref":"#/components/schemas/KycType"},"settlementToken":{"$ref":"#/components/schemas/StableCoin"},"settlementAddresses":{"$ref":"#/components/schemas/IMerchantStringSettlementAddresses"},"users":{"type":"array","items":{"$ref":"#/components/schemas/IMerchantUser"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}},"goLiveChecklist":{"$ref":"#/components/schemas/MerchantGoLiveChecklist"},"webhookSettings":{"$ref":"#/components/schemas/WebhookSettings"},"cardSettings":{"$ref":"#/components/schemas/CardSettings"},"achSettings":{"$ref":"#/components/schemas/ACHSettings"},"citconSettings":{"$ref":"#/components/schemas/CitconSettings"},"aptPayCanadaSettings":{"$ref":"#/components/schemas/AptPayCanadaSettings"},"wireSettings":{"$ref":"#/components/schemas/IWireProviderSettings"},"pixSettings":{"$ref":"#/components/schemas/PixSettings"},"ibanSettings":{"$ref":"#/components/schemas/IbanSettings"},"cryptoPayinSettings":{"$ref":"#/components/schemas/CryptoPayInSettings"},"cryptoPayoutSettings":{"$ref":"#/components/schemas/Record_CryptoPayoutTiers.CryptoPayoutTierSettings_"},"passiveWithdrawSettings":{"$ref":"#/components/schemas/PassiveWithdrawSettings"},"cashAppSettings":{"$ref":"#/components/schemas/CashAppSettings"},"rainCompanyCards":{"$ref":"#/components/schemas/RainCompanyCardsSettings"},"paypalSettings":{"$ref":"#/components/schemas/PayPalSettings"},"venmoSettings":{"$ref":"#/components/schemas/VenmoSettings"},"apaSettings":{"$ref":"#/components/schemas/ApaSettings"},"verisoulSettings":{"$ref":"#/components/schemas/VerisoulSettings"},"chargebackFightSettings":{"$ref":"#/components/schemas/ChargebackFightSettings"},"blockConfig":{"$ref":"#/components/schemas/IMerchantStringBlockConfig"},"hideBranding":{"type":"boolean"},"onlyShowTotal":{"type":"boolean"},"skipSendWithdrawEmail":{"type":"boolean"},"sendInvoiceNotifications":{"type":"boolean"},"invoiceFrequency":{"$ref":"#/components/schemas/InvoiceFrequency"},"advancedAnalytics":{"type":"boolean"},"riskInsights":{"type":"boolean","description":"Gates the Risk Insights dashboard. Admins see it regardless."},"billingEmails":{"type":"array","items":{"type":"string"}},"withdrawFeePayment":{"$ref":"#/components/schemas/IMerchantStringWithdrawFeePayment"},"pushToCardEnabled":{"type":"boolean","deprecated":true},"requireAniCheck":{"type":"boolean"},"bankPayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/PayoutProviderOption"}},"ibanPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/IbanPayoutProvider"}},"swiftPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/SwiftPayoutProvider"}},"ibanPayoutProvider":{"$ref":"#/components/schemas/IbanPayoutProvider"},"rtpPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/RtpPayoutProvider"}},"rtpPayoutProvider":{"$ref":"#/components/schemas/RtpPayoutProvider"},"pixPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/PixPayoutProvider"}},"pixPayoutProvider":{"$ref":"#/components/schemas/PixPayoutProvider"},"eftPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/EftPayoutProvider"}},"eftPayoutProvider":{"$ref":"#/components/schemas/EftPayoutProvider"},"p2cPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/CardPayoutProvider"}},"p2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"globalP2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"appleP2cPayoutProvider":{"$ref":"#/components/schemas/ApplePayPayoutProvider"},"venmoPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/VenmoPayoutProvider"}},"venmoPayoutProvider":{"$ref":"#/components/schemas/VenmoPayoutProvider"},"paypalPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/PayPalPayoutProvider"}},"paypalPayoutProvider":{"$ref":"#/components/schemas/PayPalPayoutProvider"},"wirePayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/WirePayoutProvider"}},"cryptoPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/CryptoPayoutProvider"}},"interacPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/InteracPayoutProvider"}},"interacPayoutProvider":{"$ref":"#/components/schemas/InteracPayoutProvider"},"interacPaymentProvider":{"$ref":"#/components/schemas/InteracProcessor"},"interacSettings":{"$ref":"#/components/schemas/InteracSettings"},"withdrawSorting":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawSort__"},"withdrawRules":{"type":"array","items":{"type":"string"}},"firstPartyPayoutOverrides":{"$ref":"#/components/schemas/IMerchantStringFirstPartyPayoutOverrides","deprecated":true},"maxTransactionAmount":{"$ref":"#/components/schemas/Cents"},"minTransactionAmount":{"$ref":"#/components/schemas/Cents"},"refundBalanceLimit":{"$ref":"#/components/schemas/Cents"},"parent":{"type":"string"},"onboardingVersion":{"$ref":"#/components/schemas/OnboardingVersion"},"childDefaultOnboardingVersion":{"$ref":"#/components/schemas/OnboardingVersion"},"creditSeed":{"type":"string"},"withdrawSettlementLocation":{"$ref":"#/components/schemas/SettlementLocations"},"enforceJwt":{"type":"boolean"},"enforceCheckoutJwt":{"type":"boolean"},"externalVerificationLinks":{"type":"boolean"},"whitelistedAncestorUrls":{"type":"array","items":{"type":"string"}},"banDuplicateAccounts":{"type":"boolean"},"fxFees":{"$ref":"#/components/schemas/Partial_Record_Currency.number__"},"blocked":{"$ref":"#/components/schemas/BlockedStatus"},"dealOwnerAdminId":{"type":"string"},"referralPartner":{"type":"string"},"signedMsaUrl":{"type":"string"},"crmSyncedAt":{"type":"string","format":"date-time"},"vendorSettings":{"$ref":"#/components/schemas/VendorSettings"},"generatedDescription":{"type":"string"},"bankSettlementOptions":{"$ref":"#/components/schemas/MerchantBankSettlementOptions"},"allowAttestedKyc":{"type":"boolean"},"attestedKycSsnNotRequired":{"type":"boolean"},"allowAccountSharing":{"type":"boolean"},"personaKycShareTokenTemplate":{"type":"string"},"delayedSettlementDays":{"type":"number","format":"double","description":"Number of business days to delay stablecoin settlement after payment capture.\nOnly applies to USDC settlements. 0 means no delay (immediate settlement).\nMaximum value is 5 days."},"sendPresettleWebhooks":{"type":"boolean"},"velocitySettings":{"$ref":"#/components/schemas/VelocityControlSettings"},"velocitySettingsByRail":{"$ref":"#/components/schemas/Partial_Record_PaymentType.VelocityControlSettings__"},"interchangeFees":{"$ref":"#/components/schemas/InterchangeFees"},"enforceLivenessKyc":{"type":"boolean"},"kycMinAge":{"type":"number","format":"double"},"canCreateBankAccounts":{"type":"boolean"},"checkbookSettings":{"$ref":"#/components/schemas/IMerchantStringCheckbookSettings"},"reserveSettings":{"$ref":"#/components/schemas/ReserveSettings"},"embeddedAccountSettings":{"$ref":"#/components/schemas/EmbeddedAccountSettings"},"globalRateLimit":{"type":"number","format":"double"},"banProxiesForCheckoutEndpoints":{"type":"boolean"},"riskControls":{"$ref":"#/components/schemas/IMerchantStringRiskControls"},"acceptedToS":{"type":"boolean"},"ssoSettings":{"$ref":"#/components/schemas/MerchantSsoSettings"},"chargebackFeeCents":{"type":"number","format":"double"},"chargebackEmails":{"type":"array","items":{"type":"string"}},"fraudEmails":{"type":"array","items":{"type":"string"}},"linkedBankAccount":{"$ref":"#/components/schemas/LinkedBankAccount"},"customerDefaultOverrideLimit":{"$ref":"#/components/schemas/Cents"},"customerOverrideLimitCeiling":{"$ref":"#/components/schemas/Cents"},"customerDefaultExposureLimit":{"$ref":"#/components/schemas/Cents"},"dailyExposureLimit":{"$ref":"#/components/schemas/Cents"},"monthlyExposureLimit":{"$ref":"#/components/schemas/Cents"},"sendExposureCapSlackAlerts":{"type":"boolean"},"mcc":{"type":"string"},"processing":{"$ref":"#/components/schemas/IMerchantStringProcessing"}},"required":["_id","merchantId","verification","withdrawFees","wallets","apiKey","apiKeys","kycType","settlementToken","users","ubos","goLiveChecklist","cardSettings","achSettings","wireSettings","pixSettings","ibanSettings","cryptoPayinSettings","cashAppSettings","paypalSettings","venmoSettings","apaSettings","hideBranding","onlyShowTotal","skipSendWithdrawEmail","sendInvoiceNotifications","advancedAnalytics","riskInsights","pushToCardEnabled","requireAniCheck","interacSettings","refundBalanceLimit","creditSeed","withdrawSettlementLocation","enforceJwt","delayedSettlementDays","interchangeFees"],"title":"IMerchant_string_"},"PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsMerchant"},"IGeoBlockOverride":{"type":"object","properties":{"reason":{"type":"string"},"setBy":{"type":"string"},"setAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["reason","setBy","setAt"],"description":"Per-customer exemption from real-time geographic enforcement.\n\nWhen set and not expired, withdrawal blocking rules with method\n`GEOLOCATION` or `IP` are skipped for this withdrawer. `KYC_ADDRESS` rules\nstill apply — KYC is the compliance floor and must remain enforceable.\n\nAuditable by construction: `reason` and `setBy` are required so admins can\nreview why a specific user was exempted. `expiresAt` is optional but\nstrongly recommended; long-lived overrides should be avoided.","title":"IGeoBlockOverride"},"PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsBlockConfigOverride":{"type":"object","properties":{"maxDistinctTokensPer30Days":{"type":"number","format":"double"}},"description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit.","title":"PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsBlockConfigOverride"},"Pick_IBankAccount.Exclude_keyofIBankAccount.vendorData-or-accountOwnerNames-or-nameMatchStatus__":{"type":"object","properties":{"last4":{"type":"string"},"accountHash":{"type":"string"},"accountNumberOnlyHash":{"type":"string"},"isDeleted":{"type":"boolean"},"isTokenized":{"type":"boolean"},"accountNumber":{"type":"string"},"alias":{"type":"string"},"token":{"type":"string"},"reference":{"type":"string"}},"required":["last4","accountHash","alias","token","reference"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_IBankAccount.Exclude_keyofIBankAccount.vendorData-or-accountOwnerNames-or-nameMatchStatus__"},"DisbursementStatus":{"type":"string","enum":["Immediate","Business Day","Ineligible","Unknown"],"title":"DisbursementStatus"},"ICardAccountWithExpiry":{"type":"object","properties":{"last4":{"type":"string"},"isDeleted":{"type":"boolean"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/CardType"},"disbursementStatus":{"$ref":"#/components/schemas/DisbursementStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"nameOnCard":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"hasAddress":{"type":"boolean"},"expMonth":{"type":"string"},"expYear":{"type":"string"}},"required":["last4","token","type","disbursementStatus","createdAt","hasAddress"],"title":"ICardAccountWithExpiry"},"Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__":{"type":"object","properties":{"last4":{"type":"string"},"accountHash":{"type":"string"},"alias":{"type":"string"},"token":{"type":"string"},"reference":{"type":"string"},"sortCode":{"type":"string"},"bic":{"type":"string"}},"required":["last4","accountHash","alias","token","reference","sortCode"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__"},"PickIInteracExcludeKeyofIInteracVendorDataType":{"type":"string","enum":["interac"],"title":"PickIInteracExcludeKeyofIInteracVendorDataType"},"Pick_IInterac.Exclude_keyofIInterac.vendorData__":{"type":"object","properties":{"isDeleted":{"type":"boolean"},"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/PickIInteracExcludeKeyofIInteracVendorDataType"}},"required":["alias","token","type"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_IInterac.Exclude_keyofIInterac.vendorData__"},"IMobileAccountWithExpiryType":{"type":"string","enum":["mobile"],"title":"IMobileAccountWithExpiryType"},"MobileGenus":{"type":"string","enum":["applepay"],"title":"MobileGenus"},"IMobileAccountWithExpiry":{"type":"object","properties":{"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/IMobileAccountWithExpiryType"},"disbursementStatus":{"$ref":"#/components/schemas/DisbursementStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"genus":{"$ref":"#/components/schemas/MobileGenus"},"deletedAt":{"type":"string","format":"date-time"},"hasAddress":{"type":"boolean"},"expMonth":{"type":"string"},"expYear":{"type":"string"}},"required":["alias","token","type","genus","hasAddress"],"title":"IMobileAccountWithExpiry"},"Pick_ICustomerWithAccounts.Exclude_keyofICustomerWithAccounts.FraudControlFields__":{"type":"object","properties":{"_id":{"type":"string"},"email":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"venmo":{"$ref":"#/components/schemas/CustomerVenmoAccount"},"paypal":{"$ref":"#/components/schemas/CustomerPayPalAccount"},"merchant":{"$ref":"#/components/schemas/PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsMerchant"},"customerId":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockConfigOverride":{"$ref":"#/components/schemas/PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsBlockConfigOverride","description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit."},"customerOverrideLimit":{"$ref":"#/components/schemas/Cents"},"overrideExposureLimit":{"$ref":"#/components/schemas/Cents"},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IBankAccount.Exclude_keyofIBankAccount.vendorData-or-accountOwnerNames-or-nameMatchStatus__"}},"cards":{"type":"array","items":{"$ref":"#/components/schemas/ICardAccountWithExpiry"}},"sepas":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__"}},"fasterPayments":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__"}},"interacs":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IInterac.Exclude_keyofIInterac.vendorData__"}},"mobiles":{"type":"array","items":{"$ref":"#/components/schemas/IMobileAccountWithExpiry"}}},"required":["_id","email","createdAt","merchant","customerId","bankAccounts","cards","sepas","fasterPayments","interacs"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_ICustomerWithAccounts.Exclude_keyofICustomerWithAccounts.FraudControlFields__"},"GetCustomerResponse":{"type":"object","properties":{"customer":{"oneOf":[{"$ref":"#/components/schemas/Pick_ICustomerWithAccounts.Exclude_keyofICustomerWithAccounts.FraudControlFields__"},{"type":"null"}],"description":"The object representing the customer, will be null on the first purchase."},"kycApproved":{"type":"boolean","description":"True when the customer (or the wallet's linked withdrawer/business) has an\nApproved KYC, the UI uses to decide whether to show the KYC gate"}},"required":["customer"],"title":"GetCustomerResponse"},"CustomerBalances":{"type":"object","properties":{"credits":{"$ref":"#/components/schemas/Cents"},"usdc":{"$ref":"#/components/schemas/Cents"}},"required":["credits","usdc"],"title":"CustomerBalances"},"SubscriptionStatus":{"type":"string","enum":["Active","Canceled","Expired","Concluded","Failed","Blocked"],"title":"SubscriptionStatus"},"SubscriptionDisplay":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"merchantId":{"type":"string"},"email":{"type":"string"},"plan":{"type":"string"},"planCode":{"type":"string"},"nextPaymentAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/SubscriptionStatus"}},"required":["id","customerId","merchantId","email","plan","planCode","status"],"title":"SubscriptionDisplay"},"PaymentHistory":{"type":"object","properties":{"paymentId":{"type":"string"},"merchant":{"type":"string"},"totals":{"$ref":"#/components/schemas/TotalsResponse"},"createdAt":{"type":"string","format":"date-time"},"status":{"type":"string"},"signature":{"type":"string"},"subscription":{"$ref":"#/components/schemas/SubscriptionDisplay"}},"required":["paymentId","merchant","totals","createdAt","status"],"title":"PaymentHistory"},"Customers_GetHistory_Response_200":{"type":"object","properties":{"history":{"type":"array","items":{"$ref":"#/components/schemas/PaymentHistory"}}},"required":["history"],"title":"Customers_GetHistory_Response_200"},"Customers_GetCustomerPaymentById_Response_200":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/PaymentHistory"}},"required":["payment"],"title":"Customers_GetCustomerPaymentById_Response_200"},"EventType.SignUp":{"type":"string","enum":["SignUp"],"title":"EventType.SignUp"},"SignUpEvent":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventType.SignUp"},"customerId":{"type":"string","minLength":1,"description":"The id of the customer"},"country":{"type":"string","description":"The country where the customer is located (if available)"},"username":{"type":"string","minLength":1,"description":"The username or userID of the customer"},"email":{"type":"string","description":"The email of the customer"},"firstName":{"type":"string","description":"The first name of the customer (if available)"},"lastName":{"type":"string","description":"The last name of the customer (if available)"}},"required":["eventType","customerId","username"],"description":"Sign up event - Call this event when your customer signs up for your service.","title":"SignUpEvent"},"EventType.BuyerChallenge":{"type":"string","enum":["BuyerChallenge"],"title":"EventType.BuyerChallenge"},"Record_string.string-or-number_":{"type":"object","properties":{},"description":"Construct a type with a set of properties K of type T","title":"Record_string.string-or-number_"},"EmailVerificationChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"EmailVerificationChallengeStatus"},"EmailVerificationChallengeType":{"type":"string","enum":["emailVerification"],"title":"EmailVerificationChallengeType"},"EmailVerificationChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/EmailVerificationChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"email":{"type":"string"},"type":{"$ref":"#/components/schemas/EmailVerificationChallengeType"}},"required":["status","email","type"],"description":"Verification challenge that is sent by email","title":"EmailVerificationChallenge"},"OtpVerificationChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"OtpVerificationChallengeStatus"},"OtpVerificationChallengeOtpProvider":{"type":"string","enum":["Google Authenticator","Octa","Authy","Protectimus Smart OTP","Microsoft Authenticator","FreeOTP Authenticator","Sophos Authenticator","Authenticator Plus","LastPass Authenticator","SoundLogin","Yubikey","Protectimus Slim NFC","Other"],"description":"The OTP Provider","title":"OtpVerificationChallengeOtpProvider"},"OtpVerificationChallengeType":{"type":"string","enum":["otpVerification"],"title":"OtpVerificationChallengeType"},"OtpVerificationChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/OtpVerificationChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"otpProvider":{"$ref":"#/components/schemas/OtpVerificationChallengeOtpProvider","description":"The OTP Provider"},"type":{"$ref":"#/components/schemas/OtpVerificationChallengeType"}},"required":["status","otpProvider","type"],"description":"The relevant challenge info","title":"OtpVerificationChallenge"},"PhoneChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"PhoneChallengeStatus"},"PhoneChallengePhoneInfo":{"type":"object","properties":{"carrier":{"type":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"The country code (leading + is optional)"},"phone":{"type":"string","pattern":"^[0-9]+$","description":"The phone number of the user.\nMust match the regex: ^[0-9]+$"}},"required":["carrier","countryCode","phone"],"title":"PhoneChallengePhoneInfo"},"PhoneChallengeType":{"type":"string","enum":["phoneCall","phoneVerification"],"title":"PhoneChallengeType"},"PhoneChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/PhoneChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"phoneInfo":{"$ref":"#/components/schemas/PhoneChallengePhoneInfo"},"type":{"$ref":"#/components/schemas/PhoneChallengeType"}},"required":["status","phoneInfo","type"],"description":"Verification challenge that is performed by calling the user.","title":"PhoneChallenge"},"ThirdPartyKycChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"ThirdPartyKycChallengeStatus"},"ThirdPartyKycChallengeType":{"type":"string","enum":["3rdPartyKyc"],"title":"ThirdPartyKycChallengeType"},"ThirdPartyKycChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/ThirdPartyKycChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"kycProvider":{"type":"string","description":"The name of the third party KYC provider through which the challenge is presented"},"type":{"$ref":"#/components/schemas/ThirdPartyKycChallengeType"}},"required":["status","kycProvider","type"],"description":"KYC verification conducted by a third party","title":"ThirdPartyKycChallenge"},"InternalKycChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"InternalKycChallengeStatus"},"InternalKycChallengeType":{"type":"string","enum":["internalKyc"],"title":"InternalKycChallengeType"},"InternalKycChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/InternalKycChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"type":{"$ref":"#/components/schemas/InternalKycChallengeType"}},"required":["status","type"],"title":"InternalKycChallenge"},"SoftApprovalChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"SoftApprovalChallengeStatus"},"SoftApprovalChallengeType":{"type":"string","enum":["softApproval"],"title":"SoftApprovalChallengeType"},"SoftApprovalChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/SoftApprovalChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"type":{"$ref":"#/components/schemas/SoftApprovalChallengeType"}},"required":["status","type"],"title":"SoftApprovalChallenge"},"OtherChallengeStatus":{"type":"string","enum":["triggered","successfullyFulfilled","failed","timedOut"],"description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined).","title":"OtherChallengeStatus"},"OtherChallengeType":{"type":"string","enum":["cardVerification","questionnaire"],"title":"OtherChallengeType"},"OtherChallenge":{"type":"object","properties":{"timeLimit":{"type":"number","format":"double","description":"The time limit in seconds of the challenge, after which the challenge is considered as failed.\nOnly allowed when status is set to triggered"},"rawChallengeData":{"$ref":"#/components/schemas/Record_string.string-or-number_"},"status":{"$ref":"#/components/schemas/OtherChallengeStatus","description":"Indicates the challenge status. Possible values are:\ntriggered - the user has been presented with the challenge.\nsuccessfullyFulfilled - the user has successfully fulfilled the challenge.\nfailed - the user did not successfully fulfill the challenge.\ntimedOut - the user did not answer the challenge at all within the challenge timeout period (if one is defined)."},"type":{"$ref":"#/components/schemas/OtherChallengeType"}},"required":["status","type"],"title":"OtherChallenge"},"BuyerChallengeInfo":{"oneOf":[{"$ref":"#/components/schemas/EmailVerificationChallenge"},{"$ref":"#/components/schemas/OtpVerificationChallenge"},{"$ref":"#/components/schemas/PhoneChallenge"},{"$ref":"#/components/schemas/ThirdPartyKycChallenge"},{"$ref":"#/components/schemas/InternalKycChallenge"},{"$ref":"#/components/schemas/SoftApprovalChallenge"},{"$ref":"#/components/schemas/OtherChallenge"}],"title":"BuyerChallengeInfo"},"BuyerChallengeEvent":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventType.BuyerChallenge"},"customerId":{"type":"string","minLength":1,"description":"The id of the customer"},"country":{"type":"string","description":"The country where the customer is located (if available)"},"challengeInfo":{"$ref":"#/components/schemas/BuyerChallengeInfo"}},"required":["eventType","customerId","challengeInfo"],"description":"The Buyer Challenge Event type is for reporting any type of verification on the buyer.\nex: Email verification link, SMS 2FA text, buyer is KYC'd","title":"BuyerChallengeEvent"},"EventType.SignInFailure":{"type":"string","enum":["SignInFailure"],"title":"EventType.SignInFailure"},"SignInFailureEvent":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventType.SignInFailure"},"customerId":{"type":"string","minLength":1,"description":"The id of the customer"},"country":{"type":"string","description":"The country where the customer is located (if available)"},"email":{"type":"string","description":"The email of the customer"},"failureReason":{"type":"string","description":"The reason that the failure occurred\nex: \"Incorrect Password\", \"Incorrect 2FA code\""}},"required":["eventType","customerId"],"description":"Sign In Failure event - Call this event when a customer attempts to sign into\nyour service, but sign in attempt is unsuccessful.","title":"SignInFailureEvent"},"EventType.SignIn":{"type":"string","enum":["SignIn"],"title":"EventType.SignIn"},"SignInEvent":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventType.SignIn"},"customerId":{"type":"string","minLength":1,"description":"The id of the customer"},"country":{"type":"string","description":"The country where the customer is located (if available)"},"email":{"type":"string","description":"The email of the customer"}},"required":["eventType","customerId"],"description":"Sign in event - Call this event when your customer signs into your service.","title":"SignInEvent"},"EventData":{"oneOf":[{"$ref":"#/components/schemas/SignUpEvent"},{"$ref":"#/components/schemas/BuyerChallengeEvent"},{"$ref":"#/components/schemas/SignInFailureEvent"},{"$ref":"#/components/schemas/SignInEvent"}],"title":"EventData"},"KybInformationBusiness":{"type":"object","properties":{"country":{"type":"string","description":"Main business country"},"zip":{"type":"string","description":"Main business zip code"},"state":{"type":"string","description":"Main business state/providence"},"city":{"type":"string","description":"Main business city"},"address2":{"type":"string"},"address1":{"type":"string","description":"Main business street address"}},"required":["country","zip","state","city","address1"],"title":"KybInformationBusiness"},"KybInformationPerson":{"type":"object","properties":{"email":{"type":"string","description":"Email of the main business contact"},"lastName":{"type":"string","description":"Last name of the main business contact"},"firstName":{"type":"string","description":"First name of the main business contact"}},"required":["email","lastName","firstName"],"title":"KybInformationPerson"},"KybInformation":{"type":"object","properties":{"name":{"type":"string","description":"Name of the business"},"dateFormed":{"type":"string"},"tin":{"type":"string","description":"Tax ID Number of the business.\n\n- In the US this is the 9 digital TIN\n- In Canada this is the 9 digit business id\n- In the rest of the world it varys"},"website":{"type":"string","description":"Main website to the landing page of the business"},"phoneNumber":{"type":"string","description":"Business contact phone number, when the KYB vendor collected one"},"entityType":{"type":"string","description":"Type of business"},"business":{"$ref":"#/components/schemas/KybInformationBusiness"},"person":{"$ref":"#/components/schemas/KybInformationPerson"},"merchantId":{"type":"string","description":"The merchant the business is interacting with"}},"required":["name","tin","website","business","person"],"title":"KybInformation"},"UboInfo":{"type":"object","properties":{"ssn":{"type":"string"},"dob":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country codes"},"zip":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"physicalAddress":{"type":"string"},"surName":{"type":"string","minLength":1},"firstName":{"type":"string","minLength":1}},"required":["ssn","dob","country","zip","state","city","physicalAddress","surName","firstName"],"title":"UboInfo"},"SellerUsKybBody":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"onboardingToken":{"type":"string","description":"Server-signed onboarding token minted by the parent marketplace. The\nparent is derived from this token — it cannot be supplied directly.\nNot required when the request is authenticated with the marketplace's\nAPI key; the parent is then derived from the key."},"sellerId":{"type":"string","description":"MerchantId of the individual seller"},"redirectUrl":{"type":"string","description":"(optional): The URL to which the seller will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller to\ndirect the seller to verificationLink first. Defaults to the marketplace's\nCoinflow seller login page.\n\nWeb (http/https) URLs must point at an origin you have registered with\nCoinflow — a whitelisted embedding URL or your account's website. Native\napp deep links (for example `myapp://verified`) are also accepted."},"business":{"type":"boolean"},"info":{"$ref":"#/components/schemas/KybInformation"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboInfo"},"description":"Ultimate Beneficiary owners, these are Officers, Directors, Investors and Beneficiaries who own more than 20% of the company."}},"required":["email","sellerId","business","info","ubos"],"title":"SellerUsKybBody"},"KycUserInformation":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"firstName":{"type":"string","minLength":1},"surName":{"type":"string","minLength":1},"physicalAddress":{"type":"string","minLength":1},"city":{"type":"string","minLength":1},"state":{"type":"string","minLength":2},"zip":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country codes"},"dob":{"type":"string","pattern":"^\\d{4}[-/]?(\\d{2}[-/]?){2}$","description":"Date of birth in YYYYMMDD format"},"ssn":{"type":"string","pattern":"^\\d{4}$","description":"4 Digit SSN"}},"required":["email","firstName","surName","physicalAddress","city","state","zip","country","dob","ssn"],"title":"KycUserInformation"},"SellerUsKycBody":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"onboardingToken":{"type":"string","description":"Server-signed onboarding token minted by the parent marketplace. The\nparent is derived from this token — it cannot be supplied directly.\nNot required when the request is authenticated with the marketplace's\nAPI key; the parent is then derived from the key."},"sellerId":{"type":"string","description":"MerchantId of the individual seller"},"redirectUrl":{"type":"string","description":"(optional): The URL to which the seller will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller to\ndirect the seller to verificationLink first. Defaults to the marketplace's\nCoinflow seller login page.\n\nWeb (http/https) URLs must point at an origin you have registered with\nCoinflow — a whitelisted embedding URL or your account's website. Native\napp deep links (for example `myapp://verified`) are also accepted."},"individual":{"type":"boolean"},"info":{"$ref":"#/components/schemas/KycUserInformation"}},"required":["email","sellerId","individual","info"],"title":"SellerUsKycBody"},"SellerDocVKybBody":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"onboardingToken":{"type":"string","description":"Server-signed onboarding token minted by the parent marketplace. The\nparent is derived from this token — it cannot be supplied directly.\nNot required when the request is authenticated with the marketplace's\nAPI key; the parent is then derived from the key."},"sellerId":{"type":"string","description":"MerchantId of the individual seller"},"redirectUrl":{"type":"string","description":"(optional): The URL to which the seller will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller to\ndirect the seller to verificationLink first. Defaults to the marketplace's\nCoinflow seller login page.\n\nWeb (http/https) URLs must point at an origin you have registered with\nCoinflow — a whitelisted embedding URL or your account's website. Native\napp deep links (for example `myapp://verified`) are also accepted."},"business":{"type":"boolean"},"country":{"type":"string"}},"required":["email","sellerId","business","country"],"title":"SellerDocVKybBody"},"SellerDocVKycBody":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"onboardingToken":{"type":"string","description":"Server-signed onboarding token minted by the parent marketplace. The\nparent is derived from this token — it cannot be supplied directly.\nNot required when the request is authenticated with the marketplace's\nAPI key; the parent is then derived from the key."},"sellerId":{"type":"string","description":"MerchantId of the individual seller"},"redirectUrl":{"type":"string","description":"(optional): The URL to which the seller will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller to\ndirect the seller to verificationLink first. Defaults to the marketplace's\nCoinflow seller login page.\n\nWeb (http/https) URLs must point at an origin you have registered with\nCoinflow — a whitelisted embedding URL or your account's website. Native\napp deep links (for example `myapp://verified`) are also accepted."},"individual":{"type":"boolean"},"country":{"type":"string"},"disableAutoApprove":{"type":"boolean"}},"required":["email","sellerId","individual","country"],"title":"SellerDocVKycBody"},"CreateSellerRequest":{"oneOf":[{"$ref":"#/components/schemas/SellerUsKybBody"},{"$ref":"#/components/schemas/SellerUsKycBody"},{"$ref":"#/components/schemas/SellerDocVKybBody"},{"$ref":"#/components/schemas/SellerDocVKycBody"}],"title":"CreateSellerRequest"},"SellerUsdcWithdrawRequest":{"type":"object","properties":{"destination":{"type":"string"},"amount":{"$ref":"#/components/schemas/Cents"}},"required":["destination","amount"],"title":"SellerUsdcWithdrawRequest"},"SellerUsdcWithdrawResponse":{"type":"object","properties":{"transaction":{"type":"string"}},"required":["transaction"],"title":"SellerUsdcWithdrawResponse"},"GetMarketplacePurchaseLinkRequest":{"type":"object","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"sellerId":{"type":"string","description":"ID of the Seller"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))","description":"The email of the end user who is making the purchase."},"theme":{"$ref":"#/components/schemas/MerchantTheme"},"redirectUri":{"type":"string","description":"(Optional) URL to redirect on successful purchase"},"deviceId":{"type":"string","description":"If using Chargeback Protection pass the users DeviceID here"},"supportEmail":{"type":"string","description":"The support email for your marketplace, will be displayed to users so they can contact your team to request support."},"subtotal":{"$ref":"#/components/schemas/Cents"}},"required":["sellerId","email","subtotal"],"title":"GetMarketplacePurchaseLinkRequest"},"GetMarketplaceLinkResponse":{"type":"object","properties":{"link":{"type":"string","description":"URL to redirect or present via IFrame"}},"required":["link"],"title":"GetMarketplaceLinkResponse"},"GetMarketplaceSellerEmailLoginLinkRequest":{"type":"object","properties":{"email":{"type":"string","description":"Email which the seller will use the login to their seller dashboard."}},"required":["email"],"title":"GetMarketplaceSellerEmailLoginLinkRequest"},"GetMarketplaceSellerIdLoginLinkRequest":{"type":"object","properties":{"sellerId":{"type":"string"}},"required":["sellerId"],"title":"GetMarketplaceSellerIdLoginLinkRequest"},"Marketplace_GetSellerLoginLink_Request":{"oneOf":[{"$ref":"#/components/schemas/GetMarketplaceSellerEmailLoginLinkRequest"},{"$ref":"#/components/schemas/GetMarketplaceSellerIdLoginLinkRequest"}],"title":"Marketplace_GetSellerLoginLink_Request"},"GetMarketplaceSellerRegistrationLinkRequest":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"sellerId":{"type":"string","description":"ID of the seller"},"country":{"type":"string","description":"Country in which the seller is located"},"redirectUrl":{"type":"string","description":"Optional url for post registration navigation"}},"required":["email","sellerId"],"title":"GetMarketplaceSellerRegistrationLinkRequest"},"GetMarketplaceSubscribeLinkRequest":{"type":"object","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"sellerId":{"type":"string","description":"ID of the Seller"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))","description":"The email of the end user who is making the purchase."},"theme":{"$ref":"#/components/schemas/MerchantTheme"},"redirectUri":{"type":"string","description":"(Optional) URL to redirect on successful purchase"},"deviceId":{"type":"string","description":"If using Chargeback Protection pass the users DeviceID here"},"supportEmail":{"type":"string","description":"The support email for your marketplace, will be displayed to users so they can contact your team to request support."},"planCode":{"type":"string","description":"The code of the plan to use for the subscription"}},"required":["sellerId","email","planCode"],"title":"GetMarketplaceSubscribeLinkRequest"},"Email":{"type":"object","properties":{"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"}},"required":["email"],"title":"Email"},"Marketplace_GetWalletAddressByEmail_Response_200":{"type":"object","properties":{"blockchain":{"type":"string"},"wallet":{"type":"string"}},"required":["blockchain","wallet"],"title":"Marketplace_GetWalletAddressByEmail_Response_200"},"Merchant_AcceptChargeback_Response_200":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"Merchant_AcceptChargeback_Response_200"},"WithdrawSpeed":{"type":"string","enum":["asap","same_day","standard","card","iban","pix","eft","venmo","paypal","wire","interac","swift","crypto"],"title":"WithdrawSpeed"},"CreateCryptoWithdrawBody":{"type":"object","properties":{"account":{"type":"string","description":"The payout account token (e.g., bank account or debit card token)"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"chain":{"type":"string","description":"The supported chain name (e.g., \"Ethereum\", \"Polygon\", \"Solana\")"},"token":{"type":"string","description":"The token symbol to deposit (e.g., \"USDC\")"},"returnAddress":{"type":"string","description":"Optional end-user wallet address to send funds back to if a withdrawal\nfails, instead of returning them to the originating wallet. When it is on\na different chain than the received funds (Solana USDC), the refund is\nrouted back out through the same cross-chain provider."}},"required":["account","speed","chain","token"],"title":"CreateCryptoWithdrawBody"},"PassiveDepositAddressStatusResponseStatus":{"type":"string","enum":["active","paused"],"title":"PassiveDepositAddressStatusResponseStatus"},"PassiveDepositAddressStatusResponse":{"type":"object","properties":{"depositAddress":{"type":"string"},"status":{"$ref":"#/components/schemas/PassiveDepositAddressStatusResponseStatus"}},"required":["depositAddress","status"],"title":"PassiveDepositAddressStatusResponse"},"BlockSellerRequest":{"type":"object","properties":{"merchantId":{"type":"string"},"reason":{"type":"string"},"level":{"$ref":"#/components/schemas/BlockedLevel"}},"required":["merchantId","reason","level"],"title":"BlockSellerRequest"},"RefundReason":{"type":"string","enum":["userCancellation","failedFulfillment","buyerFraud","other"],"title":"RefundReason"},"BatchRefundRequest":{"type":"object","properties":{"paymentIds":{"type":"array","items":{"type":"string"},"description":"Ids of the payments to refund in full. Maximum of 100 per request."},"refundReason":{"$ref":"#/components/schemas/RefundReason"}},"required":["paymentIds","refundReason"],"title":"BatchRefundRequest"},"BatchRefundResult":{"type":"object","properties":{"paymentId":{"type":"string"},"success":{"type":"boolean"},"jobId":{"type":"string","description":"Id of the queued refund job, present when the refund was queued."},"error":{"type":"string","description":"Why the refund could not be queued, present when it was not."},"skipped":{"type":"boolean","description":"True when this payment is unsupported by batch refunds and was skipped.\nRefund it on its own instead; retrying the batch will not help."}},"required":["paymentId","success"],"title":"BatchRefundResult"},"BatchRefundResponse":{"type":"object","properties":{"queued":{"type":"number","format":"double","description":"Number of refunds successfully queued."},"failed":{"type":"number","format":"double","description":"Number of payments that failed to queue and may be worth retrying."},"skipped":{"type":"number","format":"double","description":"Number of payments skipped because batch refunds cannot process them."},"results":{"type":"array","items":{"$ref":"#/components/schemas/BatchRefundResult"}}},"required":["queued","failed","skipped","results"],"title":"BatchRefundResponse"},"AvailabilityStatus":{"type":"string","enum":["Functional","Blocked","Override"],"title":"AvailabilityStatus"},"FailedAttemptSetting":{"type":"string","enum":["Standard","Exempt"],"title":"FailedAttemptSetting"},"MerchantRespondRequest0":{"type":"object","properties":{"response":{"type":"string"}},"required":["response"],"title":"MerchantRespondRequest0"},"MerchantRespondRequest1":{"type":"object","properties":{"fileKey":{"type":"string"}},"required":["fileKey"],"title":"MerchantRespondRequest1"},"Merchant_Respond_Request":{"oneOf":[{"$ref":"#/components/schemas/MerchantRespondRequest0"},{"$ref":"#/components/schemas/MerchantRespondRequest1"}],"title":"Merchant_Respond_Request"},"CryptoWithdrawDepositResponse":{"type":"object","properties":{"depositAddress":{"type":"string"},"paymentChainName":{"type":"string"},"paymentCurrencySymbol":{"type":"string"},"paymentAmount":{"type":"string"},"chainLogoUrl":{"type":"string"},"currencyLogoUrl":{"type":"string"},"idempotencyKey":{"type":"string","description":"The id for this deposit. Use it as the `search` value on\n`GET /api/merchant/withdraws` to look up the resulting payout once funds\nare received."}},"required":["depositAddress","paymentChainName","paymentCurrencySymbol","paymentAmount","chainLogoUrl","currencyLogoUrl","idempotencyKey"],"title":"CryptoWithdrawDepositResponse"},"ExportType":{"type":"string","enum":["Payments","FraudReports","StatementLineItems","Chargebacks","AccruingInvoices"],"title":"ExportType"},"ExportFormat":{"type":"string","enum":["Simple","Raw"],"title":"ExportFormat"},"ExportFilters":{"type":"object","properties":{"since":{"type":"string"},"until":{"type":"string"},"status":{"type":"string"},"method":{"type":"string"},"search":{"type":"string"},"protection":{"type":"string"},"processor":{"type":"string"},"amount":{"type":"string"},"authCode":{"type":"string"},"timezone":{"type":"string"},"merchantId":{"type":"string"},"statementMonth":{"type":"number","format":"double"},"statementYear":{"type":"number","format":"double"},"responded":{"type":"string"},"discrepancy":{"type":"string"},"threeDSecure":{"type":"string"},"reasonCode":{"type":"string"},"month":{"type":"string","description":"Billing-window month as `YYYY-MM`."},"agingBucket":{"type":"string","description":"One `AccruingAgingBucketKey`."},"overdue":{"type":"boolean"}},"title":"ExportFilters"},"CreateExportRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ExportType"},"format":{"$ref":"#/components/schemas/ExportFormat"},"filters":{"$ref":"#/components/schemas/ExportFilters"}},"required":["type","format","filters"],"title":"CreateExportRequest"},"IExportMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IExportMerchant"},"EditorType":{"type":"string","enum":["Coinflow","Merchant"],"title":"EditorType"},"MerchantEditor":{"type":"object","properties":{"editor":{"type":"string"},"editorType":{"$ref":"#/components/schemas/EditorType"},"ipAddress":{"type":"string"}},"required":["editor","editorType","ipAddress"],"title":"MerchantEditor"},"ExportStatus":{"type":"string","enum":["Pending","Processing","Completed","Failed"],"title":"ExportStatus"},"ExportProgress":{"type":"object","properties":{"processed":{"type":"number","format":"double"},"total":{"type":"number","format":"double"}},"required":["processed"],"title":"ExportProgress"},"ExportDownloadLog":{"type":"object","properties":{"editor":{"type":"string"},"editorType":{"$ref":"#/components/schemas/EditorType"},"ipAddress":{"type":"string"},"downloadedAt":{"type":"string","format":"date-time"}},"required":["editor","editorType","ipAddress","downloadedAt"],"title":"ExportDownloadLog"},"IExport":{"type":"object","properties":{"_id":{"type":"string"},"exportId":{"type":"string"},"merchant":{"$ref":"#/components/schemas/IExportMerchant"},"createdBy":{"$ref":"#/components/schemas/MerchantEditor"},"type":{"$ref":"#/components/schemas/ExportType"},"format":{"$ref":"#/components/schemas/ExportFormat"},"status":{"$ref":"#/components/schemas/ExportStatus"},"progress":{"$ref":"#/components/schemas/ExportProgress"},"filters":{"$ref":"#/components/schemas/ExportFilters"},"filtersHash":{"type":"string"},"r2Key":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"number","format":"double"},"recordCount":{"type":"number","format":"double"},"downloadLogs":{"type":"array","items":{"$ref":"#/components/schemas/ExportDownloadLog"}},"errorMessage":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["_id","exportId","createdBy","type","format","status","filters","filtersHash","createdAt","updatedAt","expiresAt"],"title":"IExport"},"PassiveDepositAddressBody":{"type":"object","properties":{"depositAddress":{"type":"string","description":"The previously-issued deposit address to re-activate or deactivate"}},"required":["depositAddress"],"title":"PassiveDepositAddressBody"},"MerchantPutRequestBodyContentApplicationJsonSchemaSettlementAddresses":{"type":"object","properties":{"solana":{"type":"string"},"eth":{"type":"string"},"polygon":{"type":"string"},"base":{"type":"string"},"user":{"type":"string"},"arbitrum":{"type":"string"},"stellar":{"type":"string"},"monad":{"type":"string"},"tempo":{"type":"string"}},"title":"MerchantPutRequestBodyContentApplicationJsonSchemaSettlementAddresses"},"Pick_CryptoPayInSettings.customerEmailNotifications-or-merchantEmailNotifications_":{"type":"object","properties":{"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_CryptoPayInSettings.customerEmailNotifications-or-merchantEmailNotifications_"},"Pick_ACHSettings.customerEmailNotifications-or-merchantEmailNotifications_":{"type":"object","properties":{"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_ACHSettings.customerEmailNotifications-or-merchantEmailNotifications_"},"Pick_CardSettings.customerEmailNotifications-or-merchantEmailNotifications_":{"type":"object","properties":{"customerEmailNotifications":{"type":"boolean"},"merchantEmailNotifications":{"type":"boolean"}},"required":["customerEmailNotifications","merchantEmailNotifications"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_CardSettings.customerEmailNotifications-or-merchantEmailNotifications_"},"Pick_WebhookSettings.Exclude_keyofWebhookSettings.webhookUrls__":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/WebhookVersion"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"disableAuthorizationHeader":{"type":"boolean"},"disableSubmerchantToParentWebhooks":{"type":"boolean"}},"required":["version","subscriptions"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_WebhookSettings.Exclude_keyofWebhookSettings.webhookUrls__"},"AchReturnRate":{"type":"object","properties":{"settled":{"type":"number","format":"double"},"chargeback":{"type":"number","format":"double"},"failed":{"type":"number","format":"double"}},"required":["settled","chargeback","failed"],"title":"AchReturnRate"},"IAvailability":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/AvailabilityStatus"},"reason":{"type":"string"},"editor":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["status","reason","editor","updatedAt"],"title":"IAvailability"},"ICustomerStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"ICustomerStringMerchant"},"CustomerVerificationSetting":{"type":"string","enum":["Enforced","Exempt"],"title":"CustomerVerificationSetting"},"OverrideMethod.CustomerOverride":{"type":"string","enum":["customer_override"],"title":"OverrideMethod.CustomerOverride"},"CustomerOverrideAuditLog":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/OverrideMethod.CustomerOverride"},"editor":{"type":"string"},"editorType":{"$ref":"#/components/schemas/EditorType"},"overriddenAt":{"type":"string","format":"date-time"},"ipAddress":{"type":"string"}},"required":["reason"],"title":"CustomerOverrideAuditLog"},"ICustomerStringBlockConfigOverride":{"type":"object","properties":{"maxDistinctTokensPer30Days":{"type":"number","format":"double"}},"description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit.","title":"ICustomerStringBlockConfigOverride"},"ICustomer_string_":{"type":"object","properties":{"_id":{"type":"string"},"customerId":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"createdAt":{"type":"string","format":"date-time"},"verification":{"$ref":"#/components/schemas/Verification"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"chargebackProtectionEnabled":{"type":"boolean"},"merchant":{"$ref":"#/components/schemas/ICustomerStringMerchant"},"failedAttemptSetting":{"$ref":"#/components/schemas/FailedAttemptSetting"},"verificationSetting":{"$ref":"#/components/schemas/CustomerVerificationSetting"},"exempt3DS":{"type":"boolean"},"chargebackProtectionOverrideLog":{"$ref":"#/components/schemas/CustomerOverrideAuditLog"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockConfigOverride":{"$ref":"#/components/schemas/ICustomerStringBlockConfigOverride","description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit."},"customerOverrideLimit":{"$ref":"#/components/schemas/Cents"},"overrideExposureLimit":{"$ref":"#/components/schemas/Cents"},"fraudOverrideWhitelist":{"type":"boolean"},"excludeBlockCardReuseAcrossCustomers":{"type":"boolean"}},"required":["_id","customerId","email","availability","createdAt","chargebackProtectionEnabled","merchant","failedAttemptSetting","verificationSetting"],"title":"ICustomer_string_"},"IPaymentCustomer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ICustomer_string_"}],"title":"IPaymentCustomer"},"IPaymentMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IPaymentMerchant"},"ChargebackProtectionDecision":{"type":"string","enum":["approved","rejected","Not Reviewed","Not Enabled","Overridden","Pending Review"],"title":"ChargebackProtectionDecision"},"LiabilityOwner":{"type":"string","enum":["coinflow-entity","coinflow","merchant"],"title":"LiabilityOwner"},"SessionInfo":{"type":"object","properties":{"deviceId":{"type":"string"},"verisoulSessionId":{"type":"string"},"userAgent":{"type":"string"},"endUserIp":{"type":"string"}},"required":["userAgent","endUserIp"],"title":"SessionInfo"},"StoredCardTransactionType":{"type":"string","enum":["MOBILE","SAVED","NEW","MIT","COF"],"title":"StoredCardTransactionType"},"Record_any.any_":{"type":"object","properties":{},"description":"Construct a type with a set of properties K of type T","title":"Record_any.any_"},"FraudReport":{"type":"object","properties":{"requestId":{"type":"string"},"report":{"$ref":"#/components/schemas/Record_any.any_"},"reportedAt":{"type":"string","format":"date-time","description":"Timestamp when fraud was reported for this payment"}},"required":["requestId","report"],"title":"FraudReport"},"AVSResponseCode":{"type":"string","enum":["A","B","C","D","E","G","I","M","N","O","P","R","S","U","W","X","Y","Z"],"description":"AVS (Address Verification System) Response Codes\nThese codes indicate the results of address verification checks","title":"AVSResponseCode"},"CVVResponseCode":{"type":"string","enum":["M","N","P","S","U","X"],"description":"CVV (Card Verification Value) Response Codes\nThese codes indicate the results of CVV verification checks","title":"CVVResponseCode"},"Funding":{"type":"string","enum":["credit","debit","prepaid"],"title":"Funding"},"Segment":{"type":"string","enum":["consumer","business","commercial"],"title":"Segment"},"BinInfoCountry":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/Country"}],"title":"BinInfoCountry"},"BinInfo":{"type":"object","properties":{"cardType":{"$ref":"#/components/schemas/Funding"},"cardName":{"type":"string"},"cardSegment":{"$ref":"#/components/schemas/Segment"},"country":{"$ref":"#/components/schemas/BinInfoCountry"},"bankName":{"type":"string"}},"required":["cardType","cardName","cardSegment","country","bankName"],"title":"BinInfo"},"EnhancedTxInfoIpLocation":{"type":"object","properties":{"hosting":{"type":"boolean"},"mobile":{"type":"boolean"},"proxy":{"type":"boolean"},"zip":{"type":"string"},"city":{"type":"string"},"isp":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"lon":{"type":"string"},"lat":{"type":"string"}},"required":["zip","city","isp","region","country","lon","lat"],"title":"EnhancedTxInfoIpLocation"},"DeclineExplanationCache":{"type":"object","properties":{"summary":{"type":"string"},"explanation":{"type":"string"},"keyFactors":{"type":"array","items":{"type":"string"}},"remediation":{"type":"string"},"model":{"type":"string"},"promptVersion":{"type":"number","format":"double"},"generatedAt":{"type":"string","format":"date-time"}},"required":["summary","explanation","keyFactors","remediation","model","promptVersion","generatedAt"],"title":"DeclineExplanationCache"},"EnhancedTxInfoDeclineExplanationFailure":{"type":"object","properties":{"reason":{"type":"string"},"failedAt":{"type":"string","format":"date-time"}},"required":["reason","failedAt"],"title":"EnhancedTxInfoDeclineExplanationFailure"},"OrchestrationTraversalStepNodeType":{"type":"string","enum":["action","decision"],"title":"OrchestrationTraversalStepNodeType"},"OrchestrationTraversalStep":{"type":"object","properties":{"nodeId":{"type":"string"},"nodeType":{"$ref":"#/components/schemas/OrchestrationTraversalStepNodeType"},"outcome":{"type":"string"},"operation":{"type":"string"}},"required":["nodeId","nodeType"],"title":"OrchestrationTraversalStep"},"OrchestrationFailedAttempt":{"type":"object","properties":{"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"paymentId":{"type":"string"},"authCode":{"type":"string"}},"required":["processor"],"title":"OrchestrationFailedAttempt"},"OrchestrationInfo":{"type":"object","properties":{"ruleId":{"type":"string"},"ruleUsed":{"type":"string"},"resolvedPath":{"type":"string"},"graphTraversal":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationTraversalStep"}},"processorList":{"type":"array","items":{"$ref":"#/components/schemas/PaymentProcessor"}},"successfulProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"usedFallback":{"type":"boolean"},"failedAttempts":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationFailedAttempt"}}},"title":"OrchestrationInfo"},"EnhancedTxInfo":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"streetAddress":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"bin":{"type":"string"},"ip":{"type":"string"},"userAgent":{"type":"string"},"expMonth":{"type":"string"},"expYear":{"type":"string"},"eci":{"type":"string"},"avsResponseCode":{"$ref":"#/components/schemas/AVSResponseCode"},"cvvResponseCode":{"$ref":"#/components/schemas/CVVResponseCode"},"binLocation":{"$ref":"#/components/schemas/BinInfo"},"ipLocation":{"$ref":"#/components/schemas/EnhancedTxInfoIpLocation"},"declineExplanation":{"$ref":"#/components/schemas/DeclineExplanationCache"},"declineExplanationFailure":{"$ref":"#/components/schemas/EnhancedTxInfoDeclineExplanationFailure"},"orchestrationInfo":{"$ref":"#/components/schemas/OrchestrationInfo"}},"title":"EnhancedTxInfo"},"Verification3DS":{"type":"string","enum":["Required","Exempt","NotApplicable"],"title":"Verification3DS"},"MobileWallet":{"type":"string","enum":["applePay","googlePay"],"title":"MobileWallet"},"CardPaymentStatus":{"type":"string","enum":["AUTHORIZED","DEPOSITED","SETTLED","REFUNDED","FAILED","CHARGEBACK","CHARGEBACK_LOST","CHARGEBACK_WON","VOIDED"],"title":"CardPaymentStatus"},"IPaymentCardInfo":{"type":"object","properties":{"storedTransactionType":{"$ref":"#/components/schemas/StoredCardTransactionType"},"authorizationPaymentReference":{"type":"string"},"originalPaymentId":{"type":"string","description":"This is really the permissioning payment Id - what paymentId was used that had a CVV entered to authorize it"},"statementDescriptor":{"type":"string"},"interchangeKey":{"type":"string"},"fraudReport":{"$ref":"#/components/schemas/FraudReport"},"enhancedTxInfo":{"$ref":"#/components/schemas/EnhancedTxInfo"},"transaction":{"type":"string"},"secureTransactionId":{"type":"string"},"processed3DS":{"$ref":"#/components/schemas/Verification3DS"},"cardType":{"$ref":"#/components/schemas/CardType"},"last4":{"type":"string"},"token":{"type":"string"},"mobileWallet":{"$ref":"#/components/schemas/MobileWallet"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"authCode":{"type":"string"},"status":{"$ref":"#/components/schemas/CardPaymentStatus"},"authOnly":{"type":"boolean"}},"required":["processor","authCode","status"],"title":"IPaymentCardInfo"},"AchPaymentStatus":{"type":"string","enum":["PENDING","BATCHED","DEPOSITED","SETTLED","RETURNED","FAILED","CHARGEBACK","REFUND_REVIEW","REFUNDED"],"title":"AchPaymentStatus"},"IPaymentBankTransferInfo":{"type":"object","properties":{"reasonDescription":{"type":"string"},"reasonCode":{"type":"string"},"achAuthorizationId":{"type":"string","description":"The founding `AchAuthorization.paymentId` this debit belongs to, if this is a subsequent charge."},"reason":{"type":"string"},"token":{"type":"string"},"batchedAt":{"type":"string","format":"date-time"},"refundTransferId":{"type":"string"},"refundReview":{"type":"boolean"},"transaction":{"type":"string"},"processor":{"$ref":"#/components/schemas/AchProcessor"},"status":{"$ref":"#/components/schemas/AchPaymentStatus"}},"required":["refundReview","processor","status"],"title":"IPaymentBankTransferInfo"},"PixPaymentStatus":{"type":"string","enum":["INITIATED","DEPOSITED","SETTLED","FAILED","EXPIRED","REFUNDED"],"title":"PixPaymentStatus"},"IPaymentPixInfo":{"type":"object","properties":{"reason":{"type":"string"},"processed":{"type":"string","format":"date-time"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"expiration":{"type":"string","format":"date-time"},"processor":{"$ref":"#/components/schemas/PixProcessor"},"status":{"$ref":"#/components/schemas/PixPaymentStatus"}},"required":["expiration","processor","status"],"title":"IPaymentPixInfo"},"FailedIbanAttempt":{"type":"object","properties":{"transactionId":{"type":"string"},"processed":{"type":"string","format":"date-time"},"reason":{"type":"string"}},"required":["transactionId","processed","reason"],"title":"FailedIbanAttempt"},"IbanPaymentStatus":{"type":"string","enum":["INITIATED","DEPOSITED","SETTLED","FAILED","EXPIRED","REFUNDED"],"title":"IbanPaymentStatus"},"IPaymentIbanInfo":{"type":"object","properties":{"reference":{"type":"string"},"failedAttempts":{"type":"array","items":{"$ref":"#/components/schemas/FailedIbanAttempt"}},"accountHolder":{"type":"string"},"reason":{"type":"string"},"transactionId":{"type":"string"},"processed":{"type":"string","format":"date-time"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"transaction":{"type":"string"},"expiration":{"type":"string","format":"date-time"},"token":{"type":"string"},"processor":{"$ref":"#/components/schemas/IbanProcessor"},"status":{"$ref":"#/components/schemas/IbanPaymentStatus"}},"required":["expiration","token","processor","status"],"title":"IPaymentIbanInfo"},"WirePaymentStatus":{"type":"string","enum":["INITIATED","DEPOSITED","SETTLED","FAILED","EXPIRED","REFUNDED"],"title":"WirePaymentStatus"},"IWirePaymentInfo":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/WirePaymentStatus"},"processor":{"$ref":"#/components/schemas/WireProcessor"},"token":{"type":"string"},"memo":{"type":"string"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"processed":{"type":"string","format":"date-time"},"expiration":{"type":"string","format":"date-time"},"transactionId":{"type":"string"},"braidWireReferencePaymentId":{"type":"string"},"reason":{"type":"string"}},"required":["status","processor","token","memo","expiration"],"title":"IWirePaymentInfo"},"CashAppPaymentStatus":{"type":"string","enum":["INITIATED","PROCESSING","DEPOSITED","SETTLED","FAILED","EXPIRED","REFUNDED"],"title":"CashAppPaymentStatus"},"ICashAppPaymentInfo":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/CashAppPaymentStatus"},"processor":{"$ref":"#/components/schemas/CashAppProcessor"},"depositAddress":{"type":"string"},"transaction":{"type":"string"},"referenceId":{"type":"string"},"cashAppLink":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["status","processor","referenceId","cashAppLink","expiresAt"],"title":"ICashAppPaymentInfo"},"PayPalPaymentStatus":{"type":"string","enum":["INITIATED","AUTHORIZED","DEPOSITED","SETTLED","REFUNDED","FAILED","CHARGEBACK","CHARGEBACK_LOST","CHARGEBACK_WON","VOIDED"],"title":"PayPalPaymentStatus"},"IPayPalPaymentInfoSandboxSimulations":{"type":"object","properties":{"refundFailure":{"type":"boolean"},"captureFailure":{"type":"boolean"},"authorizationFailure":{"type":"boolean"}},"title":"IPayPalPaymentInfoSandboxSimulations"},"IPayPalPaymentInfo":{"type":"object","properties":{"payerId":{"type":"string"},"email":{"type":"string"},"payerName":{"type":"string"},"payerFirstName":{"type":"string"},"payerLastName":{"type":"string"},"payerCountryCode":{"type":"string"},"emailVerified":{"type":"boolean"},"phone":{"type":"string"},"merchantId":{"type":"string"},"status":{"$ref":"#/components/schemas/PayPalPaymentStatus"},"processor":{"$ref":"#/components/schemas/PayPalProcessor"},"token":{"type":"string"},"authOnly":{"type":"boolean"},"transaction":{"type":"string"},"authorizationId":{"type":"string"},"captureId":{"type":"string"},"capturePending":{"type":"boolean","description":"This means when we tried to capture from PayPal, they returned PENDING instead of COMPLETED.\nWe will use this field to determine whether to refund a completed capture or not.\nIf it was PENDING, and then it finally comletes at a later time, just refund it automatically."},"failureReason":{"type":"string","description":"Human-readable reason PayPal declined the authorization (e.g. the\ninstrument was declined by the processor or bank). Set when PayPal returns\nan expected 422 decline so the failure can be surfaced in the dashboard."},"sandboxSimulations":{"$ref":"#/components/schemas/IPayPalPaymentInfoSandboxSimulations"},"vaulted":{"type":"boolean","description":"True when the payment was charged against a vaulted PayPal account."},"clientMetadataId":{"type":"string","description":"FraudNet client metadata ID collected on the checkout page and sent to\nPayPal as the PayPal-Client-Metadata-Id header on the vaulted order."}},"required":["merchantId","status","processor","token"],"title":"IPayPalPaymentInfo"},"VenmoPaymentStatus":{"type":"string","enum":["INITIATED","AUTHORIZED","DEPOSITED","SETTLED","REFUNDED","FAILED","CHARGEBACK","CHARGEBACK_LOST","CHARGEBACK_WON","VOIDED"],"title":"VenmoPaymentStatus"},"IVenmoPaymentInfoSandboxSimulations":{"type":"object","properties":{"refundFailure":{"type":"boolean"},"captureFailure":{"type":"boolean"},"authorizationFailure":{"type":"boolean"}},"title":"IVenmoPaymentInfoSandboxSimulations"},"IVenmoPaymentInfo":{"type":"object","properties":{"payerId":{"type":"string"},"email":{"type":"string"},"payerName":{"type":"string"},"payerFirstName":{"type":"string"},"payerLastName":{"type":"string"},"payerCountryCode":{"type":"string"},"emailVerified":{"type":"boolean"},"phone":{"type":"string"},"merchantId":{"type":"string"},"status":{"$ref":"#/components/schemas/VenmoPaymentStatus"},"processor":{"$ref":"#/components/schemas/VenmoProcessor"},"token":{"type":"string"},"authOnly":{"type":"boolean"},"transaction":{"type":"string"},"authorizationId":{"type":"string"},"captureId":{"type":"string"},"capturePending":{"type":"boolean"},"failureReason":{"type":"string","description":"Human-readable reason Venmo declined the authorization. Set when the\nprocessor returns an expected 422 decline so it can be surfaced in the\ndashboard."},"vaulted":{"type":"boolean","description":"True when the payment was charged against a vaulted Venmo account."},"clientMetadataId":{"type":"string","description":"FraudNet client metadata ID collected on the checkout page and sent to\nPayPal as the PayPal-Client-Metadata-Id header on the vaulted order."},"sandboxSimulations":{"$ref":"#/components/schemas/IVenmoPaymentInfoSandboxSimulations"}},"required":["merchantId","status","processor","token"],"title":"IVenmoPaymentInfo"},"ApaPaymentStatus":{"type":"string","enum":["INITIATED","APPROVED","DEPOSITED","SETTLED","FAILED","REFUNDED"],"title":"ApaPaymentStatus"},"ApaCredentialType":{"type":"string","enum":["PHONE","EMAIL","PAN"],"title":"ApaCredentialType"},"IApaPaymentInfo":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ApaPaymentStatus"},"processor":{"$ref":"#/components/schemas/ApaProcessor"},"apaTransactionId":{"type":"string"},"credentialType":{"$ref":"#/components/schemas/ApaCredentialType"},"credentialValue":{"type":"string"},"transaction":{"type":"string"},"transactionHash":{"type":"string"},"rail":{"type":"string"},"reason":{"type":"string"},"processed":{"type":"string","format":"date-time"}},"required":["status","processor","apaTransactionId","credentialType","credentialValue"],"title":"IApaPaymentInfo"},"InteracPaymentStatus":{"type":"string","enum":["INITIATED","DEPOSITED","SETTLED","FAILED","EXPIRED","REFUNDED"],"title":"InteracPaymentStatus"},"IInteracPaymentInfo":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/InteracPaymentStatus"},"processor":{"$ref":"#/components/schemas/InteracProcessor"},"identityId":{"type":"string","description":"AptPay identity ID for the consumer. Cached so refunds can push back to\nthe same Interac contact without re-creating the identity."},"email":{"type":"string","description":"Consumer's Interac contact — exactly one of email/phone must be set.\nCaptured at payin time so a refund can issue a push payout via\nAptPayInteracPayoutProvider."},"phone":{"type":"string"},"referenceId":{"type":"string"},"transaction":{"type":"string"},"processed":{"type":"string","format":"date-time"},"expiration":{"type":"string","format":"date-time"},"reason":{"type":"string"}},"required":["status","processor","identityId","referenceId","expiration"],"title":"IInteracPaymentInfo"},"CryptoTiers":{"type":"string","enum":["stables","majors","volatile"],"title":"CryptoTiers"},"CryptoPaymentStatus":{"type":"string","enum":["INITIATED","DEPOSITED","SETTLED","FAILED","EXPIRED","REFUNDED"],"title":"CryptoPaymentStatus"},"IPaymentCryptoInfo":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/CryptoTiers"},"paymentCurrency":{"type":"string"},"overpaymentAmount":{"type":"string"},"actualPaymentAmountUSD":{"type":"string"},"depositAddress":{"type":"string"},"refundAddress":{"type":"string"},"refundTransactionHash":{"type":"string"},"sessionId":{"type":"string"},"reason":{"type":"string"},"tokenLogoUrl":{"type":"string"},"blockchainLogoUrl":{"type":"string"},"tokenAmount":{"type":"string"},"token":{"type":"string"},"sponsoredTransactionHash":{"type":"string"},"originatingTransactionHash":{"type":"string"},"originatingWallet":{"type":"string"},"processed":{"type":"string","format":"date-time"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"status":{"$ref":"#/components/schemas/CryptoPaymentStatus"}},"required":["status"],"title":"IPaymentCryptoInfo"},"ExchangeTotalsResponse":{"type":"object","properties":{"fxFees":{"$ref":"#/components/schemas/CurrencyCents"},"networkFees":{"$ref":"#/components/schemas/CurrencyCents"},"payInFees":{"$ref":"#/components/schemas/CurrencyCents"},"total":{"$ref":"#/components/schemas/CurrencyCents"},"reserve":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidCreditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedFxFees":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/CurrencyCents"},"rebate":{"$ref":"#/components/schemas/CurrencyCents"},"invoicedRebate":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/CurrencyCents"},"creditCardFees":{"$ref":"#/components/schemas/CurrencyCents"},"subtotal":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["fxFees","total"],"description":"From T, pick a set of properties whose keys are in the union K","title":"ExchangeTotalsResponse"},"ExchangeInfo":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/ExchangeTotalsResponse"},"rate":{"type":"number","format":"double"},"base":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["amount","rate"],"title":"ExchangeInfo"},"ISubscriptionStringCustomer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ICustomer_string_"}],"title":"ISubscriptionStringCustomer"},"ISubscriptionStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"ISubscriptionStringMerchant"},"ISubscriptionPlanStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"ISubscriptionPlanStringMerchant"},"SubscriptionInterval":{"type":"string","enum":["Daily","Weekly","Monthly","Yearly"],"title":"SubscriptionInterval"},"Blockchain.SOLANA":{"type":"string","enum":["solana"],"title":"Blockchain.SOLANA"},"Blockchain.ETH":{"type":"string","enum":["eth"],"title":"Blockchain.ETH"},"Blockchain.POLYGON":{"type":"string","enum":["polygon"],"title":"Blockchain.POLYGON"},"Blockchain.BASE":{"type":"string","enum":["base"],"title":"Blockchain.BASE"},"Blockchain.ARBITRUM":{"type":"string","enum":["arbitrum"],"title":"Blockchain.ARBITRUM"},"Blockchain.STELLAR":{"type":"string","enum":["stellar"],"title":"Blockchain.STELLAR"},"Blockchain.MONAD":{"type":"string","enum":["monad"],"title":"Blockchain.MONAD"},"Blockchain.TEMPO":{"type":"string","enum":["tempo"],"title":"Blockchain.TEMPO"},"OperationalBlockchain":{"oneOf":[{"$ref":"#/components/schemas/Blockchain.SOLANA"},{"$ref":"#/components/schemas/Blockchain.ETH"},{"$ref":"#/components/schemas/Blockchain.POLYGON"},{"$ref":"#/components/schemas/Blockchain.BASE"},{"$ref":"#/components/schemas/Blockchain.ARBITRUM"},{"$ref":"#/components/schemas/Blockchain.STELLAR"},{"$ref":"#/components/schemas/Blockchain.MONAD"},{"$ref":"#/components/schemas/Blockchain.TEMPO"}],"title":"OperationalBlockchain"},"ISubscriptionPlan_string_":{"type":"object","properties":{"_id":{"type":"string"},"merchant":{"$ref":"#/components/schemas/ISubscriptionPlanStringMerchant"},"name":{"type":"string"},"code":{"type":"string"},"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"duration":{"type":"integer","minimum":1,"description":"This represents the span of an interval.\nEx. duration = 3, interval = Monthly means every 3 months the subscription renews\nDefault is 1"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"description":{"type":"string"},"transaction":{"type":"string"},"settlementChain":{"$ref":"#/components/schemas/OperationalBlockchain"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"active":{"type":"boolean"},"merchantInitiated":{"type":"boolean","description":"If true this means we will not run it through our Subscription Payments Pipeline, but instead make the merchant pass us the plan code for MITs to process it"}},"required":["_id","merchant","name","code","interval","amount","active"],"title":"ISubscriptionPlan_string_"},"ISubscriptionStringPlan":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ISubscriptionPlan_string_"}],"title":"ISubscriptionStringPlan"},"Pick_MarketplaceInfo.fixedFee-or-feePercentage_":{"type":"object","properties":{"feePercentage":{"type":"number","format":"double"},"fixedFee":{"$ref":"#/components/schemas/CurrencyCents"}},"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_MarketplaceInfo.fixedFee-or-feePercentage_"},"SubscriptionVersion":{"type":"string","enum":["1","2"],"title":"SubscriptionVersion"},"ISubscription_string_":{"type":"object","properties":{"_id":{"type":"string"},"customer":{"$ref":"#/components/schemas/ISubscriptionStringCustomer"},"merchant":{"$ref":"#/components/schemas/ISubscriptionStringMerchant"},"plan":{"$ref":"#/components/schemas/ISubscriptionStringPlan"},"cardProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"achProcessor":{"$ref":"#/components/schemas/AchProcessor"},"reference":{"type":"string"},"nextPaymentAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"marketplaceInfo":{"$ref":"#/components/schemas/Pick_MarketplaceInfo.fixedFee-or-feePercentage_"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"$ref":"#/components/schemas/SubscriptionVersion"}},"required":["_id","customer","merchant","plan","reference","status","createdAt","updatedAt","version"],"title":"ISubscription_string_"},"IPaymentSubscription":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ISubscription_string_"}],"title":"IPaymentSubscription"},"MarketplaceInfo":{"type":"object","properties":{"marketplaceFee":{"$ref":"#/components/schemas/CurrencyCents"},"marketplaceSettlement":{"$ref":"#/components/schemas/CurrencyCents"},"sellerSettlement":{"$ref":"#/components/schemas/CurrencyCents"},"feePercentage":{"type":"number","format":"double"},"fixedFee":{"$ref":"#/components/schemas/CurrencyCents"}},"title":"MarketplaceInfo"},"MultiAmountDestination":{"type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/SplitAmountDestination"}}},"required":["destinations"],"title":"MultiAmountDestination"},"MultipleDestination":{"oneOf":[{"$ref":"#/components/schemas/MultiAmountDestination"},{"$ref":"#/components/schemas/MultiplePercentageDestination"}],"title":"MultipleDestination"},"IPaymentDestination":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/MultipleDestination"}],"title":"IPaymentDestination"},"OverrideMethod":{"type":"string","enum":["customer_override","ignored_rejection","pending_review","inline_override"],"title":"OverrideMethod"},"OverrideAuditLog":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/OverrideMethod"},"editor":{"type":"string"},"editorType":{"$ref":"#/components/schemas/EditorType"},"overriddenAt":{"type":"string","format":"date-time"},"ipAddress":{"type":"string"}},"required":["reason"],"title":"OverrideAuditLog"},"IPaymentDelayedSettlement":{"type":"object","properties":{"disbursedAt":{"type":"string","format":"date-time"},"isDisbursed":{"type":"boolean"},"days":{"type":"number","format":"double"},"scheduledDate":{"type":"string","format":"date-time"},"isScheduled":{"type":"boolean"}},"required":["isDisbursed","days","scheduledDate","isScheduled"],"title":"IPaymentDelayedSettlement"},"KytAlertStatus":{"type":"string","enum":["open","blocked"],"title":"KytAlertStatus"},"IPaymentRefundInfo":{"type":"object","properties":{"count":{"type":"number","format":"double"},"refundedAt":{"type":"string","format":"date-time"},"amount":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["count","refundedAt","amount"],"title":"IPaymentRefundInfo"},"IPaymentUserLocation":{"type":"object","properties":{"resolvedState":{"type":"string"},"resolvedCountry":{"type":"string"},"lng":{"type":"number","format":"double"},"lat":{"type":"number","format":"double"}},"required":["lng","lat"],"description":"Browser-captured geolocation at the time of the request, when the caller\nsupplied one. Stored independently of payment method so the merchant\ndashboard can render a map for any purchase type. `resolved*` fields are\npopulated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee.","title":"IPaymentUserLocation"},"CoinflowEntity":{"type":"string","enum":["US","Poland","Canada","EU"],"description":"The Coinflow legal entity that owns a transaction. Used for\ncompliance/finance's per-payment entity reporting (#14259).","title":"CoinflowEntity"},"EntityTag":{"type":"object","properties":{"coinflowEntity":{"$ref":"#/components/schemas/CoinflowEntity"}},"required":["coinflowEntity"],"title":"EntityTag"},"IPaymentVendorTransfer":{"type":"object","properties":{"external":{"type":"string"},"internal":{"type":"string"}},"required":["internal"],"title":"IPaymentVendorTransfer"},"Record_string.string_":{"type":"object","properties":{},"description":"Construct a type with a set of properties K of type T","title":"Record_string.string_"},"IPayment":{"type":"object","properties":{"_id":{"type":"string"},"paymentId":{"type":"string"},"paymentIntentId":{"type":"string"},"totals":{"$ref":"#/components/schemas/TotalsResponse"},"customer":{"$ref":"#/components/schemas/IPaymentCustomer"},"merchant":{"$ref":"#/components/schemas/IPaymentMerchant"},"chargebackProtectionDecision":{"$ref":"#/components/schemas/ChargebackProtectionDecision"},"liabilityOwner":{"$ref":"#/components/schemas/LiabilityOwner"},"overrideChargebackProtectionDecision":{"type":"boolean"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"doNotReviewChargebackProtection":{"type":"boolean"},"cart":{"$ref":"#/components/schemas/CartClassOmitted"},"sessionInfo":{"$ref":"#/components/schemas/SessionInfo"},"error":{"type":"string"},"signature":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"createdAt":{"type":"string","format":"date-time"},"velocityDate":{"type":"string","format":"date-time","description":"Date when velocity check was done and used to bucket payments into velocity days\nShould match when a velocity hold was created if one was"},"cardInfo":{"$ref":"#/components/schemas/IPaymentCardInfo"},"bankTransferInfo":{"$ref":"#/components/schemas/IPaymentBankTransferInfo"},"pixInfo":{"$ref":"#/components/schemas/IPaymentPixInfo"},"ibanInfo":{"$ref":"#/components/schemas/IPaymentIbanInfo"},"wireInfo":{"$ref":"#/components/schemas/IWirePaymentInfo"},"cashAppInfo":{"$ref":"#/components/schemas/ICashAppPaymentInfo"},"paypalInfo":{"$ref":"#/components/schemas/IPayPalPaymentInfo"},"venmoInfo":{"$ref":"#/components/schemas/IVenmoPaymentInfo"},"apaInfo":{"$ref":"#/components/schemas/IApaPaymentInfo"},"interacInfo":{"$ref":"#/components/schemas/IInteracPaymentInfo"},"cryptoInfo":{"$ref":"#/components/schemas/IPaymentCryptoInfo"},"exchangeInfo":{"$ref":"#/components/schemas/ExchangeInfo"},"subscription":{"$ref":"#/components/schemas/IPaymentSubscription"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"blockchain":{"$ref":"#/components/schemas/OperationalBlockchain"},"wallet":{"type":"string"},"redemptionCheck":{"type":"boolean"},"marketplaceInfo":{"$ref":"#/components/schemas/MarketplaceInfo"},"destination":{"$ref":"#/components/schemas/IPaymentDestination"},"destinationSettlementToken":{"type":"string"},"overrideAuditLog":{"$ref":"#/components/schemas/OverrideAuditLog"},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"delayedSettlement":{"$ref":"#/components/schemas/IPaymentDelayedSettlement"},"referrer":{"type":"string"},"alertStatus":{"$ref":"#/components/schemas/KytAlertStatus"},"refundInfo":{"$ref":"#/components/schemas/IPaymentRefundInfo"},"userLocation":{"$ref":"#/components/schemas/IPaymentUserLocation","description":"Browser-captured geolocation at the time of the request, when the caller\nsupplied one. Stored independently of payment method so the merchant\ndashboard can render a map for any purchase type. `resolved*` fields are\npopulated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee."},"entityTag":{"$ref":"#/components/schemas/EntityTag"},"vendorTransfer":{"$ref":"#/components/schemas/IPaymentVendorTransfer"},"feesInvoicedPeriod":{"type":"string"},"invoiceId":{"type":"string","description":"Set at settlement when the payment carries FeePayerMode.Invoice fees\n(totals.invoiced*Fees): the Accruing invoice the fees were attached to.\nMirrors the refund/chargeback invoicing pattern — presence of invoiceId\nmarks the fees as billed."},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"vendorInfo":{"$ref":"#/components/schemas/Record_string.string_"}},"required":["_id","paymentId","totals","customer","merchant","chargebackProtectionDecision","createdAt"],"title":"IPayment"},"IChargebackUpdate":{"type":"object","properties":{"transactionType":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"postedAt":{"type":"string","format":"date-time"}},"required":["transactionType","code","description","postedAt"],"title":"IChargebackUpdate"},"WalletDebitStatus":{"type":"string","enum":["pending","success","failed"],"title":"WalletDebitStatus"},"ISecureDsCustomer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ICustomer_string_"}],"title":"ISecureDsCustomer"},"AuthenticationStatus":{"type":"string","enum":["Frictionless","Challenge","Rejected","Error","External"],"title":"AuthenticationStatus"},"ChallengeState":{"type":"string","enum":["NotApplicable","Abandoned","Success","Failure","Error"],"title":"ChallengeState"},"ISecureDsErrorResponseThreeDSecureResponse":{"type":"object","properties":{"transStatusReason":{"type":"string"},"transStatus":{"type":"string"}},"required":["transStatusReason","transStatus"],"title":"ISecureDsErrorResponseThreeDSecureResponse"},"ISecureDsErrorResponse":{"type":"object","properties":{"threeDSecureResponse":{"$ref":"#/components/schemas/ISecureDsErrorResponseThreeDSecureResponse"}},"title":"ISecureDsErrorResponse"},"ISecureDS":{"type":"object","properties":{"transactionId":{"type":"string"},"customer":{"$ref":"#/components/schemas/ISecureDsCustomer"},"merchantId":{"type":"string"},"cardType":{"$ref":"#/components/schemas/CardType"},"authenticationStatus":{"$ref":"#/components/schemas/AuthenticationStatus"},"authenticationStatusReasonCode":{"type":"string"},"challengeState":{"$ref":"#/components/schemas/ChallengeState"},"errorResponse":{"$ref":"#/components/schemas/ISecureDsErrorResponse"},"cavv":{"type":"string"},"eci":{"type":"string"},"dsTransactionId":{"type":"string"},"acsTransactionId":{"type":"string"},"version":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["transactionId","customer","merchantId","cardType","authenticationStatus","challengeState","createdAt","updatedAt"],"title":"ISecureDS"},"RefundTotals":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/CurrencyCents"},"processorFees":{"$ref":"#/components/schemas/CurrencyCents"},"total":{"$ref":"#/components/schemas/CurrencyCents"},"adjustment":{"$ref":"#/components/schemas/CurrencyCents"},"rate":{"type":"number","format":"double"},"resolution":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["subtotal","processorFees","total","rate","resolution"],"title":"RefundTotals"},"IRefundCustomer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ICustomer_string_"}],"title":"IRefundCustomer"},"IRefundMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IRefundMerchant"},"IPaymentStringCustomer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ICustomer_string_"}],"title":"IPaymentStringCustomer"},"IPaymentStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IPaymentStringMerchant"},"IPaymentStringCardInfo":{"type":"object","properties":{"storedTransactionType":{"$ref":"#/components/schemas/StoredCardTransactionType"},"authorizationPaymentReference":{"type":"string"},"originalPaymentId":{"type":"string","description":"This is really the permissioning payment Id - what paymentId was used that had a CVV entered to authorize it"},"statementDescriptor":{"type":"string"},"interchangeKey":{"type":"string"},"fraudReport":{"$ref":"#/components/schemas/FraudReport"},"enhancedTxInfo":{"$ref":"#/components/schemas/EnhancedTxInfo"},"transaction":{"type":"string"},"secureTransactionId":{"type":"string"},"processed3DS":{"$ref":"#/components/schemas/Verification3DS"},"cardType":{"$ref":"#/components/schemas/CardType"},"last4":{"type":"string"},"token":{"type":"string"},"mobileWallet":{"$ref":"#/components/schemas/MobileWallet"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"authCode":{"type":"string"},"status":{"$ref":"#/components/schemas/CardPaymentStatus"},"authOnly":{"type":"boolean"}},"required":["processor","authCode","status"],"title":"IPaymentStringCardInfo"},"IPaymentStringBankTransferInfo":{"type":"object","properties":{"reasonDescription":{"type":"string"},"reasonCode":{"type":"string"},"achAuthorizationId":{"type":"string","description":"The founding `AchAuthorization.paymentId` this debit belongs to, if this is a subsequent charge."},"reason":{"type":"string"},"token":{"type":"string"},"batchedAt":{"type":"string","format":"date-time"},"refundTransferId":{"type":"string"},"refundReview":{"type":"boolean"},"transaction":{"type":"string"},"processor":{"$ref":"#/components/schemas/AchProcessor"},"status":{"$ref":"#/components/schemas/AchPaymentStatus"}},"required":["refundReview","processor","status"],"title":"IPaymentStringBankTransferInfo"},"IPaymentStringPixInfo":{"type":"object","properties":{"reason":{"type":"string"},"processed":{"type":"string","format":"date-time"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"expiration":{"type":"string","format":"date-time"},"processor":{"$ref":"#/components/schemas/PixProcessor"},"status":{"$ref":"#/components/schemas/PixPaymentStatus"}},"required":["expiration","processor","status"],"title":"IPaymentStringPixInfo"},"IPaymentStringIbanInfo":{"type":"object","properties":{"reference":{"type":"string"},"failedAttempts":{"type":"array","items":{"$ref":"#/components/schemas/FailedIbanAttempt"}},"accountHolder":{"type":"string"},"reason":{"type":"string"},"transactionId":{"type":"string"},"processed":{"type":"string","format":"date-time"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"transaction":{"type":"string"},"expiration":{"type":"string","format":"date-time"},"token":{"type":"string"},"processor":{"$ref":"#/components/schemas/IbanProcessor"},"status":{"$ref":"#/components/schemas/IbanPaymentStatus"}},"required":["expiration","token","processor","status"],"title":"IPaymentStringIbanInfo"},"IPaymentStringCryptoInfo":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/CryptoTiers"},"paymentCurrency":{"type":"string"},"overpaymentAmount":{"type":"string"},"actualPaymentAmountUSD":{"type":"string"},"depositAddress":{"type":"string"},"refundAddress":{"type":"string"},"refundTransactionHash":{"type":"string"},"sessionId":{"type":"string"},"reason":{"type":"string"},"tokenLogoUrl":{"type":"string"},"blockchainLogoUrl":{"type":"string"},"tokenAmount":{"type":"string"},"token":{"type":"string"},"sponsoredTransactionHash":{"type":"string"},"originatingTransactionHash":{"type":"string"},"originatingWallet":{"type":"string"},"processed":{"type":"string","format":"date-time"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"status":{"$ref":"#/components/schemas/CryptoPaymentStatus"}},"required":["status"],"title":"IPaymentStringCryptoInfo"},"IPaymentStringSubscription":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ISubscription_string_"}],"title":"IPaymentStringSubscription"},"IPaymentStringDestination":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/MultipleDestination"}],"title":"IPaymentStringDestination"},"IPaymentStringDelayedSettlement":{"type":"object","properties":{"disbursedAt":{"type":"string","format":"date-time"},"isDisbursed":{"type":"boolean"},"days":{"type":"number","format":"double"},"scheduledDate":{"type":"string","format":"date-time"},"isScheduled":{"type":"boolean"}},"required":["isDisbursed","days","scheduledDate","isScheduled"],"title":"IPaymentStringDelayedSettlement"},"IPaymentStringRefundInfo":{"type":"object","properties":{"count":{"type":"number","format":"double"},"refundedAt":{"type":"string","format":"date-time"},"amount":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["count","refundedAt","amount"],"title":"IPaymentStringRefundInfo"},"IPaymentStringUserLocation":{"type":"object","properties":{"resolvedState":{"type":"string"},"resolvedCountry":{"type":"string"},"lng":{"type":"number","format":"double"},"lat":{"type":"number","format":"double"}},"required":["lng","lat"],"description":"Browser-captured geolocation at the time of the request, when the caller\nsupplied one. Stored independently of payment method so the merchant\ndashboard can render a map for any purchase type. `resolved*` fields are\npopulated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee.","title":"IPaymentStringUserLocation"},"IPaymentStringVendorTransfer":{"type":"object","properties":{"external":{"type":"string"},"internal":{"type":"string"}},"required":["internal"],"title":"IPaymentStringVendorTransfer"},"IPayment_string_":{"type":"object","properties":{"_id":{"type":"string"},"paymentId":{"type":"string"},"paymentIntentId":{"type":"string"},"totals":{"$ref":"#/components/schemas/TotalsResponse"},"customer":{"$ref":"#/components/schemas/IPaymentStringCustomer"},"merchant":{"$ref":"#/components/schemas/IPaymentStringMerchant"},"chargebackProtectionDecision":{"$ref":"#/components/schemas/ChargebackProtectionDecision"},"liabilityOwner":{"$ref":"#/components/schemas/LiabilityOwner"},"overrideChargebackProtectionDecision":{"type":"boolean"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"doNotReviewChargebackProtection":{"type":"boolean"},"cart":{"$ref":"#/components/schemas/CartClassOmitted"},"sessionInfo":{"$ref":"#/components/schemas/SessionInfo"},"error":{"type":"string"},"signature":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"createdAt":{"type":"string","format":"date-time"},"velocityDate":{"type":"string","format":"date-time","description":"Date when velocity check was done and used to bucket payments into velocity days\nShould match when a velocity hold was created if one was"},"cardInfo":{"$ref":"#/components/schemas/IPaymentStringCardInfo"},"bankTransferInfo":{"$ref":"#/components/schemas/IPaymentStringBankTransferInfo"},"pixInfo":{"$ref":"#/components/schemas/IPaymentStringPixInfo"},"ibanInfo":{"$ref":"#/components/schemas/IPaymentStringIbanInfo"},"wireInfo":{"$ref":"#/components/schemas/IWirePaymentInfo"},"cashAppInfo":{"$ref":"#/components/schemas/ICashAppPaymentInfo"},"paypalInfo":{"$ref":"#/components/schemas/IPayPalPaymentInfo"},"venmoInfo":{"$ref":"#/components/schemas/IVenmoPaymentInfo"},"apaInfo":{"$ref":"#/components/schemas/IApaPaymentInfo"},"interacInfo":{"$ref":"#/components/schemas/IInteracPaymentInfo"},"cryptoInfo":{"$ref":"#/components/schemas/IPaymentStringCryptoInfo"},"exchangeInfo":{"$ref":"#/components/schemas/ExchangeInfo"},"subscription":{"$ref":"#/components/schemas/IPaymentStringSubscription"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"blockchain":{"$ref":"#/components/schemas/OperationalBlockchain"},"wallet":{"type":"string"},"redemptionCheck":{"type":"boolean"},"marketplaceInfo":{"$ref":"#/components/schemas/MarketplaceInfo"},"destination":{"$ref":"#/components/schemas/IPaymentStringDestination"},"destinationSettlementToken":{"type":"string"},"overrideAuditLog":{"$ref":"#/components/schemas/OverrideAuditLog"},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"delayedSettlement":{"$ref":"#/components/schemas/IPaymentStringDelayedSettlement"},"referrer":{"type":"string"},"alertStatus":{"$ref":"#/components/schemas/KytAlertStatus"},"refundInfo":{"$ref":"#/components/schemas/IPaymentStringRefundInfo"},"userLocation":{"$ref":"#/components/schemas/IPaymentStringUserLocation","description":"Browser-captured geolocation at the time of the request, when the caller\nsupplied one. Stored independently of payment method so the merchant\ndashboard can render a map for any purchase type. `resolved*` fields are\npopulated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee."},"entityTag":{"$ref":"#/components/schemas/EntityTag"},"vendorTransfer":{"$ref":"#/components/schemas/IPaymentStringVendorTransfer"},"feesInvoicedPeriod":{"type":"string"},"invoiceId":{"type":"string","description":"Set at settlement when the payment carries FeePayerMode.Invoice fees\n(totals.invoiced*Fees): the Accruing invoice the fees were attached to.\nMirrors the refund/chargeback invoicing pattern — presence of invoiceId\nmarks the fees as billed."},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"vendorInfo":{"$ref":"#/components/schemas/Record_string.string_"}},"required":["_id","paymentId","totals","customer","merchant","chargebackProtectionDecision","createdAt"],"title":"IPayment_string_"},"IRefundPayment":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IPayment_string_"}],"title":"IRefundPayment"},"RefundStatus":{"type":"string","enum":["Pending","Invoiced","Settled","Failed"],"title":"RefundStatus"},"ReimbursementStatus":{"type":"string","enum":["Pending","Complete","Failure","Returned"],"title":"ReimbursementStatus"},"RefundSource":{"type":"string","enum":["Credits","Usdc","Settlement","None"],"title":"RefundSource"},"RefundMethod":{"type":"string","enum":["Card","Ach","Pix","Iban","Wire","Crypto","CashApp","APA","PayPal","Venmo","Interac"],"title":"RefundMethod"},"RefundDenominationType":{"type":"string","enum":["usd","token"],"title":"RefundDenominationType"},"CryptoRefundInfo":{"type":"object","properties":{"refundTransactionHash":{"type":"string"},"refundTransactionUrl":{"type":"string"},"refundAddress":{"type":"string"},"amountUSD":{"type":"string"},"tokenAmount":{"type":"string"},"paymentCurrency":{"type":"string"},"denominationType":{"$ref":"#/components/schemas/RefundDenominationType"}},"required":["refundAddress","denominationType"],"title":"CryptoRefundInfo"},"IRefund":{"type":"object","properties":{"_id":{"type":"string"},"totals":{"$ref":"#/components/schemas/RefundTotals"},"customer":{"$ref":"#/components/schemas/IRefundCustomer"},"merchant":{"$ref":"#/components/schemas/IRefundMerchant"},"payment":{"$ref":"#/components/schemas/IRefundPayment"},"signature":{"type":"string"},"status":{"$ref":"#/components/schemas/RefundStatus"},"reimbursementStatus":{"$ref":"#/components/schemas/ReimbursementStatus"},"reimbursementId":{"type":"string"},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"source":{"$ref":"#/components/schemas/RefundSource"},"method":{"$ref":"#/components/schemas/RefundMethod"},"provider":{"type":"string"},"invoicedAt":{"type":"string","format":"date-time","description":"Legacy invoice linkage used by the original invoice system."},"invoiceId":{"type":"string","description":"The Accruing invoice this refund's uncollected remainder was billed to."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reason":{"$ref":"#/components/schemas/RefundReason"},"refundedBy":{"$ref":"#/components/schemas/MerchantEditor"},"failureReason":{"type":"string"},"cryptoRefundInfo":{"$ref":"#/components/schemas/CryptoRefundInfo"},"walletDebitStatus":{"$ref":"#/components/schemas/WalletDebitStatus"},"walletDebitTxHash":{"type":"string"},"returnSignature":{"type":"string"}},"required":["_id","totals","customer","merchant","payment","status","reimbursementStatus","outstanding","source","method","provider","createdAt","updatedAt"],"title":"IRefund"},"AllChargebackResponse":{"type":"object","properties":{"chargebackFeeCents":{"type":"number","format":"double"},"createdAt":{"type":"string","format":"date-time"},"merchant":{"type":"string"},"invoiceId":{"type":"string"},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"updatedAt":{"type":"string","format":"date-time"},"payment":{"$ref":"#/components/schemas/IPayment"},"chargebackId":{"type":"string"},"reasonCode":{"type":"string"},"reasonDescription":{"type":"string"},"respondByDate":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"merchantRespondedAt":{"type":"string","format":"date-time"},"responseFileKey":{"type":"string"},"accepted":{"type":"boolean","description":"Set when a merchant explicitly concedes the dispute via \"Accept\nChargeback\". The chargeback is marked LOST and this flag keeps the\nChargebackPipeline from reopening it if the processor later reports a\ndifferent (e.g. Won) status."},"discrepancy":{"type":"boolean"},"loadedOn":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","format":"date-time"},"updates":{"type":"array","items":{"$ref":"#/components/schemas/IChargebackUpdate"}},"disputedAmount":{"$ref":"#/components/schemas/CurrencyCents"},"autoDebitStatus":{"$ref":"#/components/schemas/WalletDebitStatus"},"autoDebitAmountCents":{"type":"number","format":"double","description":"The chargeback amount capped at the payment total, excluding the\nchargeback fee (ChargebackDebitPipeline adds the fee on top when\ndebiting). Persisted when the auto debit is enqueued; the won-credit\nreturns exactly this amount so the credit always matches the debit even\nwhen the open and resolve payloads disagree on the disputed amount."},"walletDebitTxHash":{"type":"string"},"walletCreditTxHash":{"type":"string"},"customer":{"type":"string"},"secureDs":{"$ref":"#/components/schemas/ISecureDS"},"refund":{"$ref":"#/components/schemas/IRefund"},"shouldFight":{"type":"boolean","description":"Whether Coinflow should fight (represent) this chargeback, derived\nper-request from the merchant's `chargebackFightSettings` enrollment and the\nglobal chargeback-fight ruleset matched against the payment's card processor\nand chargeback-protection decision. Always false unless the merchant is\nenrolled and the ruleset matches."}},"required":["createdAt","merchant","invoiceId","outstanding","updatedAt","payment","chargebackId","reasonCode","reasonDescription","respondByDate","responded","customer","secureDs","refund","shouldFight"],"description":"From T, pick a set of properties whose keys are in the union K","title":"AllChargebackResponse"},"MerchantPaymentsGetParametersSortBy":{"type":"string","enum":["createdAt","amount"],"title":"MerchantPaymentsGetParametersSortBy"},"ChargebackAnalyticsSummaryVamp":{"type":"object","properties":{"ratio":{"type":"number","format":"double"},"settledPayments":{"type":"number","format":"double"},"fraudCount":{"type":"number","format":"double"},"chargebackCount":{"type":"number","format":"double"}},"required":["ratio","settledPayments","fraudCount","chargebackCount"],"title":"ChargebackAnalyticsSummaryVamp"},"ChargebackProtectionSavings":{"type":"object","properties":{"balanceCents":{"type":"number","format":"double"},"feeCents":{"type":"number","format":"double"},"totalCents":{"type":"number","format":"double"},"disputesProtected":{"type":"number","format":"double"},"disputesTotal":{"type":"number","format":"double"}},"required":["balanceCents","feeCents","totalCents","disputesProtected","disputesTotal"],"title":"ChargebackProtectionSavings"},"ChargebackResponseCompliance":{"type":"object","properties":{"responseRequired":{"type":"number","format":"double"},"needsResponse":{"type":"number","format":"double"}},"required":["responseRequired","needsResponse"],"title":"ChargebackResponseCompliance"},"ChargebackBrandBreakdown":{"type":"object","properties":{"network":{"type":"string"},"settledPayments":{"type":"number","format":"double"},"chargebackCount":{"type":"number","format":"double"},"chargebackVolumeCents":{"type":"number","format":"double"},"fraudCount":{"type":"number","format":"double"},"chargebackRatio":{"type":"number","format":"double"},"fraudRatio":{"type":"number","format":"double"},"vampRatio":{"type":"number","format":"double"}},"required":["network","settledPayments","chargebackCount","chargebackVolumeCents","fraudCount","chargebackRatio","fraudRatio","vampRatio"],"title":"ChargebackBrandBreakdown"},"ChargebackDailyPoint":{"type":"object","properties":{"day":{"type":"string"},"chargebackCount":{"type":"number","format":"double"},"chargebackVolumeCents":{"type":"number","format":"double"},"fraudCount":{"type":"number","format":"double"},"fraudVolumeCents":{"type":"number","format":"double"}},"required":["day","chargebackCount","chargebackVolumeCents","fraudCount","fraudVolumeCents"],"title":"ChargebackDailyPoint"},"ChargebackAnalyticsSummary":{"type":"object","properties":{"vamp":{"$ref":"#/components/schemas/ChargebackAnalyticsSummaryVamp"},"savings":{"$ref":"#/components/schemas/ChargebackProtectionSavings"},"responseCompliance":{"$ref":"#/components/schemas/ChargebackResponseCompliance"},"byBrand":{"type":"array","items":{"$ref":"#/components/schemas/ChargebackBrandBreakdown"}},"daily":{"type":"array","items":{"$ref":"#/components/schemas/ChargebackDailyPoint"}}},"required":["vamp","savings","responseCompliance","byBrand","daily"],"title":"ChargebackAnalyticsSummary"},"IWallet":{"type":"object","properties":{"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"}},"required":["wallet","blockchain"],"title":"IWallet"},"Currency.USD":{"type":"string","enum":["USD"],"title":"Currency.USD"},"Currency.EUR":{"type":"string","enum":["EUR"],"title":"Currency.EUR"},"Currency.GBP":{"type":"string","enum":["GBP"],"title":"Currency.GBP"},"Currency.BRL":{"type":"string","enum":["BRL"],"title":"Currency.BRL"},"Currency.CAD":{"type":"string","enum":["CAD"],"title":"Currency.CAD"},"WithdrawCurrency":{"oneOf":[{"$ref":"#/components/schemas/Currency.USD"},{"$ref":"#/components/schemas/Currency.EUR"},{"$ref":"#/components/schemas/Currency.GBP"},{"$ref":"#/components/schemas/Currency.BRL"},{"$ref":"#/components/schemas/Currency.CAD"}],"title":"WithdrawCurrency"},"IUserStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IUserStringMerchant"},"DwollaVerificationStatus":{"type":"string","enum":["pending","verified","retry","document","suspended"],"title":"DwollaVerificationStatus"},"DwollaWithdrawerInfo":{"type":"object","properties":{"customerId":{"type":"string"},"status":{"$ref":"#/components/schemas/DwollaVerificationStatus"},"acceptedTerms":{"type":"string","format":"date-time"},"verification":{"$ref":"#/components/schemas/Verification"}},"required":["customerId","status","acceptedTerms"],"title":"DwollaWithdrawerInfo"},"WatchlistStatus":{"type":"string","enum":["Unknown","UnderReview","Passed","Blocked"],"title":"WatchlistStatus"},"IUser_string_":{"type":"object","properties":{"_id":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallets":{"type":"array","items":{"$ref":"#/components/schemas/IWallet"},"deprecated":true},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"currency":{"$ref":"#/components/schemas/Currency"},"originalCurrency":{"$ref":"#/components/schemas/WithdrawCurrency"},"merchant":{"$ref":"#/components/schemas/IUserStringMerchant"},"verification":{"$ref":"#/components/schemas/Verification"},"riskScoreOverride":{"type":"boolean"},"country":{"type":"string"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockCardReuseExempt":{"type":"boolean","description":"When true, this withdrawer is exempt from the merchant\n`banDuplicateAccounts` re-use check, so it may add an account that another\nwithdrawer already uses without being blocked (423 `PAYMENT_METHOD_IN_USE`)."},"createdAt":{"type":"string","format":"date-time"},"user":{"type":"boolean"},"dwolla":{"$ref":"#/components/schemas/DwollaWithdrawerInfo"},"watchlistExempt":{"$ref":"#/components/schemas/WatchlistStatus"},"watchlistId":{"type":"string"}},"required":["_id","wallet","blockchain","email","availability","currency","merchant","verification","riskScoreOverride","country","user","watchlistExempt"],"title":"IUser_string_"},"IBusinessStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IBusinessStringMerchant"},"IBusiness_string_":{"type":"object","properties":{"_id":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallets":{"type":"array","items":{"$ref":"#/components/schemas/IWallet"},"deprecated":true},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"currency":{"$ref":"#/components/schemas/Currency"},"originalCurrency":{"$ref":"#/components/schemas/WithdrawCurrency"},"merchant":{"$ref":"#/components/schemas/IBusinessStringMerchant"},"verification":{"$ref":"#/components/schemas/Verification"},"riskScoreOverride":{"type":"boolean"},"country":{"type":"string"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockCardReuseExempt":{"type":"boolean","description":"When true, this withdrawer is exempt from the merchant\n`banDuplicateAccounts` re-use check, so it may add an account that another\nwithdrawer already uses without being blocked (423 `PAYMENT_METHOD_IN_USE`)."},"createdAt":{"type":"string","format":"date-time"},"business":{"type":"boolean"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}}},"required":["_id","wallet","blockchain","email","availability","currency","merchant","verification","riskScoreOverride","country","business","ubos"],"title":"IBusiness_string_"},"IWithdrawWithdrawer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IUser_string_"},{"$ref":"#/components/schemas/IBusiness_string_"}],"title":"IWithdrawWithdrawer"},"IWithdrawUserPaidFees":{"type":"object","properties":{"processingFees":{"$ref":"#/components/schemas/CurrencyCents"},"customFees":{"$ref":"#/components/schemas/CurrencyCents"},"swapFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"fees":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["swapFees","gasFees","fees"],"title":"IWithdrawUserPaidFees"},"IWithdrawMerchantPaidFees":{"type":"object","properties":{"merchantFundedAmount":{"$ref":"#/components/schemas/CurrencyCents"},"settledInline":{"type":"boolean"},"swapFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"fees":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["swapFees","gasFees","fees"],"title":"IWithdrawMerchantPaidFees"},"WithdrawStatus":{"type":"string","enum":["completed","failed","pending"],"title":"WithdrawStatus"},"WithdrawFailedReturnStatus":{"type":"string","enum":["pending_return","return_in_progress","return_submitted","return_completed"],"title":"WithdrawFailedReturnStatus"},"IWithdrawCryptoPayoutInfo":{"type":"object","properties":{"deliveryTransactionUrl":{"type":"string","description":"Explorer URL for the transfer — the shareable receipt you send to your user as proof of payment."},"deliveryTransactionHash":{"type":"string"},"destinationAddress":{"type":"string"},"tokenLogoUrl":{"type":"string"},"chainLogoUrl":{"type":"string"},"token":{"type":"string"},"chain":{"type":"string"}},"required":["destinationAddress","token","chain"],"description":"Delivery details for crypto (speed=crypto) payouts. Chain, token and\ndestination are stamped when the withdrawal is created; the delivery\ntransaction hash is stored by the provider's completion webhook.","title":"IWithdrawCryptoPayoutInfo"},"IWithdrawMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IWithdrawMerchant"},"IWithdrawManualFailAudit":{"type":"object","properties":{"editor":{"type":"string"},"editorType":{"$ref":"#/components/schemas/EditorType"},"ipAddress":{"type":"string"},"failedAt":{"type":"string","format":"date-time"}},"required":["editor","editorType","ipAddress","failedAt"],"title":"IWithdrawManualFailAudit"},"IWithdrawManualSuccessAudit":{"type":"object","properties":{"editor":{"type":"string"},"editorType":{"$ref":"#/components/schemas/EditorType"},"ipAddress":{"type":"string"},"succeededAt":{"type":"string","format":"date-time"}},"required":["editor","editorType","ipAddress","succeededAt"],"title":"IWithdrawManualSuccessAudit"},"IWithdrawUserLocation":{"type":"object","properties":{"resolvedState":{"type":"string"},"resolvedCountry":{"type":"string"},"lng":{"type":"number","format":"double"},"lat":{"type":"number","format":"double"}},"required":["lng","lat"],"description":"Browser-captured geolocation at the time of the withdraw request, when\nthe caller supplied one. Stored independently of payout method so the\nmerchant dashboard can render a map for any withdraw. `resolved*` fields\nare populated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee.","title":"IWithdrawUserLocation"},"IWithdraw":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawWithdrawer"},"transferId":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"transaction":{"type":"string"},"accountId":{"type":"string"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"usdToForeignExchangeRate":{"type":"number","format":"double","description":"This is the conversion rate from USD to the foreign currency.\nFor example 0.90 = 0.90 USD/GBP\n\nSo if you want to convert GBP to USD you would multiply 15 GBP * 0.90 USD/GBP = 13.5 USD\nIf you want to convert USD to GBP you would multiply 13.5 USD * 1/0.90 GBP/USD = 15 GBP"},"userPaidFees":{"$ref":"#/components/schemas/IWithdrawUserPaidFees"},"merchantPaidFees":{"$ref":"#/components/schemas/IWithdrawMerchantPaidFees"},"invoiceId":{"type":"string","description":"Set on completion when merchantPaidFees were not settled inline: the\nAccruing invoice the fees were attached to. Mirrors the\nrefund/chargeback/payment invoicing pattern — presence of invoiceId\nmarks the fees as billed."},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"status":{"$ref":"#/components/schemas/WithdrawStatus"},"returnStatus":{"$ref":"#/components/schemas/WithdrawFailedReturnStatus"},"unclaimedAt":{"type":"string","format":"date-time","description":"When the provider reported the payout as unclaimed: sent to an email or phone with no account behind it, so the recipient has to claim it before the provider cancels it (30 days for PayPal)."},"cryptoPayoutInfo":{"$ref":"#/components/schemas/IWithdrawCryptoPayoutInfo","description":"Delivery details for crypto (speed=crypto) payouts. Chain, token and\ndestination are stamped when the withdrawal is created; the delivery\ntransaction hash is stored by the provider's completion webhook."},"expectedDeliveryDate":{"type":"string","format":"date-time"},"merchant":{"$ref":"#/components/schemas/IWithdrawMerchant"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"provider":{"type":"string"},"returnTransaction":{"type":"string"},"returnedAt":{"type":"string","format":"date-time"},"returnAddress":{"type":"string","description":"Optional end-user address to send a failed-withdraw refund to instead of\nthe originating wallet. Copied from the CryptoWithdrawSession at creation."},"returnCurrency":{"type":"string"},"returnGlideSessionId":{"type":"string"},"userId":{"type":"string"},"detailMessage":{"type":"string"},"errorData":{"type":"string"},"pin":{"type":"string","description":"Only used for Interac payments if the user must provide their\nbank a PIN to claim the transfer."},"isFirstParty":{"type":"boolean","description":"True when this withdraw was a first-party payout (the merchant\nwithdrawing from their own settlement wallet)."},"payoutInitiated":{"type":"boolean"},"idempotencyKey":{"type":"string"},"manuallyFailedBy":{"$ref":"#/components/schemas/IWithdrawManualFailAudit"},"manuallySucceededBy":{"$ref":"#/components/schemas/IWithdrawManualSuccessAudit"},"userLocation":{"$ref":"#/components/schemas/IWithdrawUserLocation","description":"Browser-captured geolocation at the time of the withdraw request, when\nthe caller supplied one. Stored independently of payout method so the\nmerchant dashboard can render a map for any withdraw. `resolved*` fields\nare populated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee."},"orchestrationTraceId":{"type":"string"},"achTraceId":{"type":"string","description":"The provider's ACH trace ID for this withdraw, when available. Used by\nsupport to give customers a reference the receiving bank can look up.\nCurrently populated for Braid ACH payouts (transaction.ach.traceNumber),\nAptPay ACH payouts (the settled webhook's os-trace), and AptPay\npush-to-card payouts (the transaction's RRN / Retrieval Reference Number)."},"entityTag":{"$ref":"#/components/schemas/EntityTag"}},"required":["withdrawer","transferId","wallet","blockchain","transaction","accountId","amount","usdToForeignExchangeRate","userPaidFees","merchantPaidFees","status","expectedDeliveryDate","merchant","createdAt","updatedAt","speed","provider"],"title":"IWithdraw"},"PickIPayPalExcludeKeyofIPayPalVendorDataType":{"type":"string","enum":["paypal"],"title":"PickIPayPalExcludeKeyofIPayPalVendorDataType"},"Pick_IPayPal.Exclude_keyofIPayPal.vendorData__":{"type":"object","properties":{"isDeleted":{"type":"boolean"},"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/PickIPayPalExcludeKeyofIPayPalVendorDataType"}},"required":["alias","token","type"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_IPayPal.Exclude_keyofIPayPal.vendorData__"},"PickIVenmoExcludeKeyofIVenmoVendorDataType":{"type":"string","enum":["venmo"],"title":"PickIVenmoExcludeKeyofIVenmoVendorDataType"},"Pick_IVenmo.Exclude_keyofIVenmo.vendorData__":{"type":"object","properties":{"isDeleted":{"type":"boolean"},"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/PickIVenmoExcludeKeyofIVenmoVendorDataType"}},"required":["alias","token","type"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_IVenmo.Exclude_keyofIVenmo.vendorData__"},"ISwiftAccountIntermediaryBank":{"type":"object","properties":{"swiftCode":{"type":"string"},"bankAddress":{"$ref":"#/components/schemas/Address"},"bankName":{"type":"string"}},"required":["swiftCode","bankAddress","bankName"],"title":"ISwiftAccountIntermediaryBank"},"ISwiftAccount":{"type":"object","properties":{"alias":{"type":"string"},"token":{"type":"string"},"reference":{"type":"string"},"last4":{"type":"string"},"accountHash":{"type":"string"},"beneficiaryBankName":{"type":"string"},"beneficiaryBankAddress":{"$ref":"#/components/schemas/Address"},"swiftCode":{"type":"string"},"intermediaryBank":{"$ref":"#/components/schemas/ISwiftAccountIntermediaryBank"}},"required":["alias","token","reference","last4","accountHash","beneficiaryBankName","beneficiaryBankAddress","swiftCode"],"title":"ISwiftAccount"},"IPixAccount":{"type":"object","properties":{"key":{"type":"string"},"accountHash":{"type":"string"},"token":{"type":"string"}},"required":["key","accountHash","token"],"title":"IPixAccount"},"IPopulatedCard":{"type":"object","properties":{"token":{"type":"string"},"expMonth":{"type":"string"},"expYear":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["token","expMonth","expYear","firstName","lastName","address1","city","country"],"title":"IPopulatedCard"},"ICleanPurseCardsItems":{"type":"object","properties":{"last4":{"type":"string"},"isDeleted":{"type":"boolean"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/CardType"},"disbursementStatus":{"$ref":"#/components/schemas/DisbursementStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"nameOnCard":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/IPopulatedCard"}},"required":["last4","token","type","disbursementStatus","createdAt"],"description":"From T, pick a set of properties whose keys are in the union K","title":"ICleanPurseCardsItems"},"NameMatchStatus":{"type":"string","enum":["unmatched","matched","self_reported","failed","confirmed_failure","override","grandfathered"],"description":"The accountNumber is the encrypted accountNumber\nThe accountNumberOnlyHash is computed off the account_number in the secure vault - this could differ because bank-link data may provide a tokenized account number\nThe accountHash also uses account_number, but may also include routingNumber and wireRoutingNumber","title":"NameMatchStatus"},"ICleanPurseAccountsItems":{"type":"object","properties":{"accountOwnerNames":{"type":"array","items":{"type":"string"}},"nameMatchStatus":{"$ref":"#/components/schemas/NameMatchStatus"},"last4":{"type":"string"},"accountHash":{"type":"string"},"accountNumberOnlyHash":{"type":"string"},"isDeleted":{"type":"boolean"},"isTokenized":{"type":"boolean"},"accountNumber":{"type":"string"},"alias":{"type":"string"},"token":{"type":"string"},"reference":{"type":"string"},"rtpEligible":{"type":"boolean"},"routingNumber":{"type":"string"},"plaidAccountSubtype":{"type":"string"},"plaidAccountType":{"type":"string"},"plaidLinked":{"type":"boolean"}},"required":["last4","accountHash","alias","token","reference","rtpEligible","routingNumber","plaidLinked"],"description":"From T, pick a set of properties whose keys are in the union K","title":"ICleanPurseAccountsItems"},"ReferenceKey":{"type":"object","properties":{"referenceId":{"type":"string"},"merchantId":{"type":"string"}},"required":["referenceId","merchantId"],"title":"ReferenceKey"},"ICleanPurse":{"type":"object","properties":{"interac":{"$ref":"#/components/schemas/Pick_IInterac.Exclude_keyofIInterac.vendorData__"},"paypal":{"$ref":"#/components/schemas/Pick_IPayPal.Exclude_keyofIPayPal.vendorData__"},"venmo":{"$ref":"#/components/schemas/Pick_IVenmo.Exclude_keyofIVenmo.vendorData__"},"swifts":{"type":"array","items":{"$ref":"#/components/schemas/ISwiftAccount"}},"pixes":{"type":"array","items":{"$ref":"#/components/schemas/IPixAccount"}},"ibans":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__"}},"cards":{"type":"array","items":{"$ref":"#/components/schemas/ICleanPurseCardsItems"}},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ICleanPurseAccountsItems"}},"keys":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceKey"}},"_id":{"type":"string"}},"required":["swifts","pixes","ibans","cards","accounts","keys","_id"],"title":"ICleanPurse"},"CustomerData":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/IPayment"}},"payouts":{"type":"array","items":{"$ref":"#/components/schemas/IWithdraw"}},"purses":{"type":"array","items":{"$ref":"#/components/schemas/ICleanPurse"}},"verifications":{"type":"array","items":{"$ref":"#/components/schemas/Verification"}},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"kycName":{"type":"string","description":"The name on file with the KYC vendor (Persona, SumSub, …) for the\ncustomer's verification, falling back to the related withdrawer's\nverification. Undefined when no verification resolves to a name."}},"required":["emails","payments","payouts","purses","verifications"],"title":"CustomerData"},"ChargebackWithShouldFightPayment":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IPayment_string_"}],"title":"ChargebackWithShouldFightPayment"},"ChargebackWithShouldFightMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"ChargebackWithShouldFightMerchant"},"ChargebackWithShouldFight":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/ChargebackWithShouldFightPayment"},"merchant":{"$ref":"#/components/schemas/ChargebackWithShouldFightMerchant"},"chargebackId":{"type":"string"},"reasonCode":{"type":"string"},"reasonDescription":{"type":"string"},"respondByDate":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"merchantRespondedAt":{"type":"string","format":"date-time"},"draftResponse":{"type":"string"},"responseFileKey":{"type":"string"},"notes":{"type":"string"},"accepted":{"type":"boolean","description":"Set when a merchant explicitly concedes the dispute via \"Accept\nChargeback\". The chargeback is marked LOST and this flag keeps the\nChargebackPipeline from reopening it if the processor later reports a\ndifferent (e.g. Won) status."},"discrepancy":{"type":"boolean"},"loadedOn":{"type":"string","format":"date-time"},"chargebackFeeCents":{"type":"number","format":"double"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","format":"date-time"},"updates":{"type":"array","items":{"$ref":"#/components/schemas/IChargebackUpdate"}},"disputedAmount":{"$ref":"#/components/schemas/CurrencyCents"},"autoDebitStatus":{"$ref":"#/components/schemas/WalletDebitStatus"},"autoDebitAmountCents":{"type":"number","format":"double","description":"The chargeback amount capped at the payment total, excluding the\nchargeback fee (ChargebackDebitPipeline adds the fee on top when\ndebiting). Persisted when the auto debit is enqueued; the won-credit\nreturns exactly this amount so the credit always matches the debit even\nwhen the open and resolve payloads disagree on the disputed amount."},"walletDebitTxHash":{"type":"string"},"walletCreditTxHash":{"type":"string"},"invoiceId":{"type":"string"},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"shouldFight":{"type":"boolean","description":"Whether Coinflow should fight (represent) this chargeback, derived\nper-request from the merchant's `chargebackFightSettings` enrollment and the\nglobal chargeback-fight ruleset matched against the payment's card processor\nand chargeback-protection decision. Always false unless the merchant is\nenrolled and the ruleset matches."}},"required":["payment","merchant","chargebackId","reasonCode","reasonDescription","respondByDate","responded","createdAt","updatedAt","shouldFight"],"title":"ChargebackWithShouldFight"},"Merchant_GetChargeback_Response_200":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerData"},"payment":{"$ref":"#/components/schemas/IPayment"},"chargeback":{"$ref":"#/components/schemas/ChargebackWithShouldFight"}},"required":["customer","payment","chargeback"],"title":"Merchant_GetChargeback_Response_200"},"Merchant_GetPayoutBalance_Response_200":{"type":"object","properties":{"balance":{"$ref":"#/components/schemas/Cents"}},"required":["balance"],"title":"Merchant_GetPayoutBalance_Response_200"},"CryptoPayoutToken":{"type":"object","properties":{"tokenId":{"type":"string","description":"Pass as the payout destination's `token`"},"symbol":{"type":"string"},"name":{"type":"string"},"logoUrl":{"type":"string"}},"required":["tokenId","symbol","name","logoUrl"],"title":"CryptoPayoutToken"},"CryptoPayoutTokenChain":{"type":"object","properties":{"chainId":{"type":"string","description":"Pass as the payout destination's `chain`"},"name":{"type":"string"},"logoUrl":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/CryptoPayoutToken"}}},"required":["chainId","name","logoUrl","tokens"],"title":"CryptoPayoutTokenChain"},"CryptoPayoutTokensResponse":{"type":"object","properties":{"chains":{"type":"array","items":{"$ref":"#/components/schemas/CryptoPayoutTokenChain"}}},"required":["chains"],"description":"The chains and tokens this merchant can send crypto payouts to, keyed by\nthe canonical ids payout and quote requests accept.","title":"CryptoPayoutTokensResponse"},"MerchantCustomersGetParametersSortBy":{"type":"string","enum":["createdAt"],"title":"MerchantCustomersGetParametersSortBy"},"ICustomerWalletMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"ICustomerWalletMerchant"},"ICustomerWalletBlockConfigOverride":{"type":"object","properties":{"maxDistinctTokensPer30Days":{"type":"number","format":"double"}},"description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit.","title":"ICustomerWalletBlockConfigOverride"},"ICustomerWallet":{"type":"object","properties":{"_id":{"type":"string"},"verification":{"$ref":"#/components/schemas/Verification"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}},"email":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"merchant":{"$ref":"#/components/schemas/ICustomerWalletMerchant"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"availability":{"$ref":"#/components/schemas/IAvailability"},"chargebackProtectionEnabled":{"type":"boolean"},"failedAttemptSetting":{"$ref":"#/components/schemas/FailedAttemptSetting"},"verificationSetting":{"$ref":"#/components/schemas/CustomerVerificationSetting"},"exempt3DS":{"type":"boolean"},"chargebackProtectionOverrideLog":{"$ref":"#/components/schemas/CustomerOverrideAuditLog"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockConfigOverride":{"$ref":"#/components/schemas/ICustomerWalletBlockConfigOverride","description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit."},"customerOverrideLimit":{"$ref":"#/components/schemas/Cents"},"overrideExposureLimit":{"$ref":"#/components/schemas/Cents"},"fraudOverrideWhitelist":{"type":"boolean"},"excludeBlockCardReuseAcrossCustomers":{"type":"boolean"},"wallet":{"type":"string"}},"required":["_id","email","createdAt","merchant","availability","chargebackProtectionEnabled","failedAttemptSetting","verificationSetting","wallet"],"description":"From T, pick a set of properties whose keys are in the union K","title":"ICustomerWallet"},"Pick_DelegatedCryptoDestination.chain-or-token_":{"type":"object","properties":{"token":{"type":"string","description":"The token id to deliver from the crypto payout tokens endpoint — the\nlowercase symbol (e.g. \"usdc\"), matched case-insensitively."},"chain":{"type":"string","description":"The destination chain id from the crypto payout tokens endpoint\n(e.g. \"eip155:8453\")."}},"required":["token","chain"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_DelegatedCryptoDestination.chain-or-token_"},"DelegatedCryptoPayoutQuoteArgs":{"type":"object","properties":{"userId":{"type":"string","description":"The Merchant generated userId for the user receiving the payout."},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"account":{"$ref":"#/components/schemas/Pick_DelegatedCryptoDestination.chain-or-token_"}},"required":["userId","amount","account"],"title":"DelegatedCryptoPayoutQuoteArgs"},"DelegatedCryptoPayoutQuote":{"type":"object","properties":{"quote":{"$ref":"#/components/schemas/CurrencyCents"},"totalMerchantDebit":{"$ref":"#/components/schemas/CurrencyCents"},"userPayout":{"$ref":"#/components/schemas/CurrencyCents"},"merchantFees":{"$ref":"#/components/schemas/CurrencyCents"},"deliveryAmount":{"type":"string","description":"The amount of the requested destination token the user will receive, as\na decimal string in the token's own units. Non-stablecoin tokens are\nquoted at the current market rate and are not guaranteed — the delivered\namount is finalized when the payout is processed."}},"required":["quote","totalMerchantDebit","userPayout","merchantFees","deliveryAmount"],"title":"DelegatedCryptoPayoutQuote"},"DelegatedPayoutQuoteArgsAmount":{"type":"object","properties":{"cents":{"type":"integer","minimum":0},"currency":{"$ref":"#/components/schemas/Currency"}},"required":["cents"],"title":"DelegatedPayoutQuoteArgsAmount"},"DelegatedPayoutQuoteArgs":{"type":"object","properties":{"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"account":{"type":"string","description":"The debit card, bank or Iban pci-compliant token"},"userId":{"type":"string","description":"The Merchant generated userId for the user."},"amount":{"$ref":"#/components/schemas/DelegatedPayoutQuoteArgsAmount"}},"required":["speed","account","userId","amount"],"description":"From T, pick a set of properties whose keys are in the union K","title":"DelegatedPayoutQuoteArgs"},"CustomFeePresentment":{"type":"object","properties":{"cents":{"type":"integer","minimum":0},"currency":{"$ref":"#/components/schemas/Currency"},"label":{"type":"string"}},"required":["cents","currency","label"],"title":"CustomFeePresentment"},"WithdrawQuoteFeesAndLimit":{"type":"object","properties":{"fee":{"$ref":"#/components/schemas/CurrencyCents"},"limit":{"$ref":"#/components/schemas/CurrencyCents"},"finalSettlement":{"$ref":"#/components/schemas/CurrencyCents"},"expectedDeliveryDate":{"type":"string"},"expectedDeliveryDateISO":{"type":"string"},"customFee":{"$ref":"#/components/schemas/CustomFeePresentment"},"accountIneligible":{"type":"boolean"}},"required":["fee","limit","finalSettlement","expectedDeliveryDate"],"description":"Represents the fees and limits associated with a withdrawal quote.","title":"WithdrawQuoteFeesAndLimit"},"GasFeeEstimate":{"type":"object","properties":{"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFeesWei":{"type":"string"}},"required":["gasFees","gasFeesWei"],"description":"Represents an estimate of gas fees for a transaction.","title":"GasFeeEstimate"},"DelegatedPayoutQuote":{"type":"object","properties":{"asap":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"same_day":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"standard":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"card":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"iban":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"pix":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"eft":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"venmo":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"paypal":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"wire":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"interac":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"swift":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"crypto":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"quote":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/GasFeeEstimate"},"swapFees":{"$ref":"#/components/schemas/CurrencyCents"},"totalMerchantDebit":{"$ref":"#/components/schemas/CurrencyCents"},"userPayout":{"$ref":"#/components/schemas/CurrencyCents"},"merchantFees":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["asap","same_day","standard","card","iban","pix","eft","venmo","paypal","wire","interac","swift","crypto","quote","totalMerchantDebit","userPayout","merchantFees"],"title":"DelegatedPayoutQuote"},"EnhancedTxInfoResponseIpLocation":{"type":"object","properties":{"hosting":{"type":"boolean"},"mobile":{"type":"boolean"},"proxy":{"type":"boolean"},"zip":{"type":"string"},"city":{"type":"string"},"isp":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"lon":{"type":"string"},"lat":{"type":"string"}},"required":["zip","city","isp","region","country","lon","lat"],"title":"EnhancedTxInfoResponseIpLocation"},"EnhancedTxInfoResponseDeclineExplanationFailure":{"type":"object","properties":{"reason":{"type":"string"},"failedAt":{"type":"string","format":"date-time"}},"required":["reason","failedAt"],"title":"EnhancedTxInfoResponseDeclineExplanationFailure"},"UAParser.IBrowser":{"type":"object","properties":{"name":{"type":"string","description":"Possible values :\nAmaya, Android Browser, Arora, Avant, Baidu, Blazer, Bolt, Camino, Chimera, Chrome,\nChromium, Comodo Dragon, Conkeror, Dillo, Dolphin, Doris, Edge, Epiphany, Fennec,\nFirebird, Firefox, Flock, GoBrowser, iCab, ICE Browser, IceApe, IceCat, IceDragon,\nIceweasel, IE [Mobile], Iron, Jasmine, K-Meleon, Konqueror, Kindle, Links,\nLunascape, Lynx, Maemo, Maxthon, Midori, Minimo, MIUI Browser, [Mobile] Safari,\nMosaic, Mozilla, Netfront, Netscape, NetSurf, Nokia, OmniWeb, Opera [Mini/Mobi/Tablet],\nPhoenix, Polaris, QQBrowser, RockMelt, Silk, Skyfire, SeaMonkey, SlimBrowser, Swiftfox,\nTizen, UCBrowser, Vivaldi, w3m, Yandex"},"version":{"type":"string","description":"Determined dynamically"},"major":{"type":"string","description":"Determined dynamically","deprecated":true}},"title":"UAParser.IBrowser"},"UAParser.IDevice":{"type":"object","properties":{"model":{"type":"string","description":"Determined dynamically"},"type":{"type":"string","description":"Possible type:\nconsole, mobile, tablet, smarttv, wearable, embedded"},"vendor":{"type":"string","description":"Possible vendor:\nAcer, Alcatel, Amazon, Apple, Archos, Asus, BenQ, BlackBerry, Dell, GeeksPhone,\nGoogle, HP, HTC, Huawei, Jolla, Lenovo, LG, Meizu, Microsoft, Motorola, Nexian,\nNintendo, Nokia, Nvidia, Ouya, Palm, Panasonic, Polytron, RIM, Samsung, Sharp,\nSiemens, Sony-Ericsson, Sprint, Xbox, ZTE"}},"title":"UAParser.IDevice"},"UAParser.IEngine":{"type":"object","properties":{"name":{"type":"string","description":"Possible name:\nAmaya, EdgeHTML, Gecko, iCab, KHTML, Links, Lynx, NetFront, NetSurf, Presto,\nTasman, Trident, w3m, WebKit"},"version":{"type":"string","description":"Determined dynamically"}},"title":"UAParser.IEngine"},"UAParser.IOS":{"type":"object","properties":{"name":{"type":"string","description":"Possible 'os.name'\nAIX, Amiga OS, Android, Arch, Bada, BeOS, BlackBerry, CentOS, Chromium OS, Contiki,\nFedora, Firefox OS, FreeBSD, Debian, DragonFly, Gentoo, GNU, Haiku, Hurd, iOS,\nJoli, Linpus, Linux, Mac OS, Mageia, Mandriva, MeeGo, Minix, Mint, Morph OS, NetBSD,\nNintendo, OpenBSD, OpenVMS, OS/2, Palm, PCLinuxOS, Plan9, Playstation, QNX, RedHat,\nRIM Tablet OS, RISC OS, Sailfish, Series40, Slackware, Solaris, SUSE, Symbian, Tizen,\nUbuntu, UNIX, VectorLinux, WebOS, Windows [Phone/Mobile], Zenwalk"},"version":{"type":"string","description":"Determined dynamically"}},"title":"UAParser.IOS"},"UAParser.ICPU":{"type":"object","properties":{"architecture":{"type":"string","description":"Possible architecture:\n 68k, amd64, arm, arm64, avr, ia32, ia64, irix, irix64, mips, mips64, pa-risc,\n ppc, sparc, sparc64"}},"title":"UAParser.ICPU"},"UAParser.IResult":{"type":"object","properties":{"ua":{"type":"string"},"browser":{"$ref":"#/components/schemas/UAParser.IBrowser"},"device":{"$ref":"#/components/schemas/UAParser.IDevice"},"engine":{"$ref":"#/components/schemas/UAParser.IEngine"},"os":{"$ref":"#/components/schemas/UAParser.IOS"},"cpu":{"$ref":"#/components/schemas/UAParser.ICPU"}},"required":["ua","browser","device","engine","os","cpu"],"title":"UAParser.IResult"},"EnhancedTxInfoResponse":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"streetAddress":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"bin":{"type":"string"},"ip":{"type":"string"},"userAgent":{"type":"string"},"expMonth":{"type":"string"},"expYear":{"type":"string"},"eci":{"type":"string"},"avsResponseCode":{"$ref":"#/components/schemas/AVSResponseCode"},"cvvResponseCode":{"$ref":"#/components/schemas/CVVResponseCode"},"binLocation":{"$ref":"#/components/schemas/BinInfo"},"ipLocation":{"$ref":"#/components/schemas/EnhancedTxInfoResponseIpLocation"},"declineExplanation":{"$ref":"#/components/schemas/DeclineExplanationCache"},"declineExplanationFailure":{"$ref":"#/components/schemas/EnhancedTxInfoResponseDeclineExplanationFailure"},"orchestrationInfo":{"$ref":"#/components/schemas/OrchestrationInfo"},"deviceInfo":{"$ref":"#/components/schemas/UAParser.IResult"},"secureDS":{"oneOf":[{"$ref":"#/components/schemas/ISecureDS"},{"type":"null"}]}},"required":["deviceInfo","secureDS"],"title":"EnhancedTxInfoResponse"},"Merchant_GetEnhancedTxInformation_Response_200":{"type":"object","properties":{"info":{"oneOf":[{"$ref":"#/components/schemas/EnhancedTxInfoResponse"},{"type":"null"}]}},"required":["info"],"title":"Merchant_GetEnhancedTxInformation_Response_200"},"ExportDownloadResponse":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["url","expiresAt"],"title":"ExportDownloadResponse"},"JobStatusResponseOneOf0Status":{"type":"string","enum":["pending"],"title":"JobStatusResponseOneOf0Status"},"JobStatusResponse0":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/JobStatusResponseOneOf0Status"}},"required":["status"],"title":"JobStatusResponse0"},"JobStatusResponseOneOf1Status":{"type":"string","enum":["completed"],"title":"JobStatusResponseOneOf1Status"},"JobStatusResponse1":{"type":"object","properties":{"value":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/JobStatusResponseOneOf1Status"}},"required":["value","status"],"title":"JobStatusResponse1"},"JobStatusResponseOneOf2Status":{"type":"string","enum":["failed"],"title":"JobStatusResponseOneOf2Status"},"JobStatusResponse2":{"type":"object","properties":{"error":{"type":"string"},"status":{"$ref":"#/components/schemas/JobStatusResponseOneOf2Status"}},"required":["error","status"],"title":"JobStatusResponse2"},"JobStatusResponse":{"oneOf":[{"$ref":"#/components/schemas/JobStatusResponse0"},{"$ref":"#/components/schemas/JobStatusResponse1"},{"$ref":"#/components/schemas/JobStatusResponse2"}],"title":"JobStatusResponse"},"PendingVerification":{"type":"object","properties":{"verification":{"$ref":"#/components/schemas/Verification"},"merchantLink":{"type":"string"},"uboLinks":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalVerification"}}},"required":["verification"],"title":"PendingVerification"},"Merchant_GetMerchantV2_Response_200":{"type":"object","properties":{"applePayMerchantIdentifier":{"type":"string"},"verificationLinks":{"$ref":"#/components/schemas/PendingVerification"},"merchant":{"$ref":"#/components/schemas/IMerchant_string_"}},"required":["merchant"],"title":"Merchant_GetMerchantV2_Response_200"},"WebhookStatus":{"type":"string","enum":["success","failure"],"title":"WebhookStatus"},"WebhookCategory":{"type":"string","enum":["Purchase","Subscription","KYC","Withdraw","Marketplace"],"title":"WebhookCategory"},"IPopulatedSubscriptionStringCustomer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ICustomer_string_"}],"title":"IPopulatedSubscriptionStringCustomer"},"IPopulatedSubscriptionStringMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IPopulatedSubscriptionStringMerchant"},"IPopulatedSubscription_string_":{"type":"object","properties":{"_id":{"type":"string"},"customer":{"$ref":"#/components/schemas/IPopulatedSubscriptionStringCustomer"},"merchant":{"$ref":"#/components/schemas/IPopulatedSubscriptionStringMerchant"},"plan":{"$ref":"#/components/schemas/ISubscriptionPlan_string_"},"cardProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"achProcessor":{"$ref":"#/components/schemas/AchProcessor"},"reference":{"type":"string"},"nextPaymentAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"marketplaceInfo":{"$ref":"#/components/schemas/Pick_MarketplaceInfo.fixedFee-or-feePercentage_"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"$ref":"#/components/schemas/SubscriptionVersion"}},"required":["_id","customer","merchant","plan","reference","status","createdAt","updatedAt","version"],"title":"IPopulatedSubscription_string_"},"PaymentWebhookData":{"type":"object","properties":{"id":{"type":"string"},"wallet":{"type":"string"},"webhookInfo":{"oneOf":[{"$ref":"#/components/schemas/AnyObject"},{"type":"null"}]},"subtotal":{"$ref":"#/components/schemas/Cents"},"fees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"fxFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"merchantId":{"type":"string"},"paymentMethod":{"type":"string"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"cardToken":{"type":"string"},"last4":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonCode":{"type":"string"},"reasonMessage":{"type":"string"}},"required":["id","wallet","subtotal","fees","gasFees","chargebackProtectionFees","fxFees","total","merchantId"],"title":"PaymentWebhookData"},"PaymentWebhookData3":{"type":"object","properties":{"merchantId":{"type":"string"},"fxFees":{"$ref":"#/components/schemas/Cents"},"last4":{"type":"string"},"cardToken":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"id":{"type":"string"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"subtotal":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"reasonCode":{"type":"string"},"fees":{"$ref":"#/components/schemas/Cents"},"paymentMethod":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonMessage":{"type":"string"},"customerId":{"type":"string"}},"required":["merchantId","fxFees","webhookInfo","id","subtotal","chargebackProtectionFees","gasFees","networkFees","payInFees","total","merchantPaidChargebackProtectionFees","merchantPaidGasFees","merchantPaidFxFees","merchantPaidNetworkFees","invoicedCreditCardFees","invoicedChargebackProtectionFees","invoicedGasFees","invoicedFxFees","invoicedNetworkFees","rebate","invoicedRebate","merchantPaidFees","fees","customerId"],"description":"From T, pick a set of properties whose keys are in the union K","title":"PaymentWebhookData3"},"PaymentDeclinedWebhookData":{"type":"object","properties":{"id":{"type":"string"},"wallet":{"type":"string"},"webhookInfo":{"oneOf":[{"$ref":"#/components/schemas/AnyObject"},{"type":"null"}]},"subtotal":{"$ref":"#/components/schemas/Cents"},"fees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"fxFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"merchantId":{"type":"string"},"paymentMethod":{"type":"string"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"cardToken":{"type":"string"},"last4":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonCode":{"type":"string"},"reasonMessage":{"type":"string"},"declineCode":{"type":"string"},"declineDescription":{"type":"string"},"avsResponseCode":{"type":"string"},"cvvResponseCode":{"type":"string"},"threeDsAuthenticationStatus":{"$ref":"#/components/schemas/AuthenticationStatus"}},"required":["id","wallet","subtotal","fees","gasFees","chargebackProtectionFees","fxFees","total","merchantId","declineCode","declineDescription"],"title":"PaymentDeclinedWebhookData"},"PaymentDeclinedWebhookData3":{"type":"object","properties":{"merchantId":{"type":"string"},"fxFees":{"$ref":"#/components/schemas/Cents"},"last4":{"type":"string"},"cardToken":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"id":{"type":"string"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"subtotal":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"reasonCode":{"type":"string"},"fees":{"$ref":"#/components/schemas/Cents"},"paymentMethod":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonMessage":{"type":"string"},"declineCode":{"type":"string"},"declineDescription":{"type":"string"},"avsResponseCode":{"type":"string"},"cvvResponseCode":{"type":"string"},"threeDsAuthenticationStatus":{"$ref":"#/components/schemas/AuthenticationStatus"},"customerId":{"type":"string"}},"required":["merchantId","fxFees","webhookInfo","id","subtotal","chargebackProtectionFees","gasFees","networkFees","payInFees","total","merchantPaidChargebackProtectionFees","merchantPaidGasFees","merchantPaidFxFees","merchantPaidNetworkFees","invoicedCreditCardFees","invoicedChargebackProtectionFees","invoicedGasFees","invoicedFxFees","invoicedNetworkFees","rebate","invoicedRebate","merchantPaidFees","fees","declineCode","declineDescription","avsResponseCode","cvvResponseCode","threeDsAuthenticationStatus","customerId"],"description":"From T, pick a set of properties whose keys are in the union K","title":"PaymentDeclinedWebhookData3"},"SettledWebhookData":{"type":"object","properties":{"id":{"type":"string"},"wallet":{"type":"string"},"webhookInfo":{"oneOf":[{"$ref":"#/components/schemas/AnyObject"},{"type":"null"}]},"subtotal":{"$ref":"#/components/schemas/Cents"},"fees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"fxFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"merchantId":{"type":"string"},"paymentMethod":{"type":"string"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"cardToken":{"type":"string"},"last4":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonCode":{"type":"string"},"reasonMessage":{"type":"string"},"signature":{"type":"string"},"avsResponseCode":{"type":"string"},"cvvResponseCode":{"type":"string"},"threeDsAuthenticationStatus":{"$ref":"#/components/schemas/AuthenticationStatus"},"velocityHold":{"type":"boolean"},"reserve":{"$ref":"#/components/schemas/Cents"}},"required":["id","wallet","subtotal","fees","gasFees","chargebackProtectionFees","fxFees","total","merchantId","signature"],"title":"SettledWebhookData"},"SettledWebhookData3":{"type":"object","properties":{"merchantId":{"type":"string"},"fxFees":{"$ref":"#/components/schemas/Cents"},"last4":{"type":"string"},"cardToken":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"id":{"type":"string"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"subtotal":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"reserve":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"signature":{"type":"string"},"reasonCode":{"type":"string"},"fees":{"$ref":"#/components/schemas/Cents"},"paymentMethod":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonMessage":{"type":"string"},"avsResponseCode":{"type":"string"},"cvvResponseCode":{"type":"string"},"threeDsAuthenticationStatus":{"$ref":"#/components/schemas/AuthenticationStatus"},"velocityHold":{"type":"boolean"},"rawCustomerId":{"type":"string"},"customerId":{"type":"string"}},"required":["merchantId","fxFees","webhookInfo","id","subtotal","chargebackProtectionFees","gasFees","networkFees","payInFees","total","merchantPaidChargebackProtectionFees","merchantPaidGasFees","merchantPaidFxFees","merchantPaidNetworkFees","invoicedCreditCardFees","invoicedChargebackProtectionFees","invoicedGasFees","invoicedFxFees","invoicedNetworkFees","rebate","invoicedRebate","merchantPaidFees","signature","fees","avsResponseCode","cvvResponseCode","threeDsAuthenticationStatus","rawCustomerId","customerId"],"description":"From T, pick a set of properties whose keys are in the union K","title":"SettledWebhookData3"},"SubscriptionWebhookData":{"type":"object","properties":{"planCode":{"type":"string"},"planName":{"type":"string"},"subscriptionId":{"type":"string"},"wallet":{"type":"string"},"amount":{"$ref":"#/components/schemas/Cents"},"interval":{"type":"string"},"fundingMethod":{"type":"string"},"webhookInfo":{"oneOf":[{"$ref":"#/components/schemas/AnyObject"},{"type":"null"}]},"reason":{"type":"string"},"paymentMethod":{"type":"string"}},"required":["planCode","planName","subscriptionId","wallet","amount","interval","fundingMethod"],"title":"SubscriptionWebhookData"},"SubscriptionWebhookData3":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Cents"},"interval":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"paymentMethod":{"type":"string"},"planCode":{"type":"string"},"planName":{"type":"string"},"subscriptionId":{"type":"string"},"fundingMethod":{"type":"string"},"reason":{"type":"string"},"customerId":{"type":"string"}},"required":["amount","interval","webhookInfo","planCode","planName","subscriptionId","fundingMethod","customerId"],"description":"From T, pick a set of properties whose keys are in the union K","title":"SubscriptionWebhookData3"},"PaymentChargebackWebhookData":{"type":"object","properties":{"id":{"type":"string"},"wallet":{"type":"string"},"webhookInfo":{"oneOf":[{"$ref":"#/components/schemas/AnyObject"},{"type":"null"}]},"subtotal":{"$ref":"#/components/schemas/Cents"},"fees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"fxFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"merchantId":{"type":"string"},"paymentMethod":{"type":"string"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"cardToken":{"type":"string"},"last4":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonCode":{"type":"string"},"reasonMessage":{"type":"string"},"chargebackId":{"type":"string"},"reasonDescription":{"type":"string"},"respondByDate":{"type":"string","format":"date-time"}},"required":["id","wallet","subtotal","fees","gasFees","chargebackProtectionFees","fxFees","total","merchantId","reasonCode","chargebackId","reasonDescription","respondByDate"],"title":"PaymentChargebackWebhookData"},"PaymentChargebackWebhookData3":{"type":"object","properties":{"merchantId":{"type":"string"},"fxFees":{"$ref":"#/components/schemas/Cents"},"last4":{"type":"string"},"cardToken":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"id":{"type":"string"},"subscription":{"$ref":"#/components/schemas/IPopulatedSubscription_string_"},"subtotal":{"$ref":"#/components/schemas/Cents"},"chargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"gasFees":{"$ref":"#/components/schemas/Cents"},"networkFees":{"$ref":"#/components/schemas/Cents"},"payInFees":{"$ref":"#/components/schemas/Cents"},"total":{"$ref":"#/components/schemas/Cents"},"merchantPaidChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidGasFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidFxFees":{"$ref":"#/components/schemas/Cents"},"merchantPaidNetworkFees":{"$ref":"#/components/schemas/Cents"},"invoicedCreditCardFees":{"$ref":"#/components/schemas/Cents"},"invoicedChargebackProtectionFees":{"$ref":"#/components/schemas/Cents"},"invoicedGasFees":{"$ref":"#/components/schemas/Cents"},"invoicedFxFees":{"$ref":"#/components/schemas/Cents"},"invoicedNetworkFees":{"$ref":"#/components/schemas/Cents"},"rebate":{"$ref":"#/components/schemas/Cents"},"invoicedRebate":{"$ref":"#/components/schemas/Cents"},"merchantPaidFees":{"$ref":"#/components/schemas/Cents"},"chargebackId":{"type":"string"},"reasonCode":{"type":"string"},"reasonDescription":{"type":"string"},"respondByDate":{"type":"string","format":"date-time"},"fees":{"$ref":"#/components/schemas/Cents"},"paymentMethod":{"type":"string"},"bin":{"type":"string"},"paymentMethodToken":{"type":"string"},"payerId":{"type":"string","description":"PayPal/Venmo payer id captured from the approval webhook, when present."},"payerName":{"type":"string","description":"PayPal/Venmo payer full name captured from the approval webhook, when present."},"payerFirstName":{"type":"string","description":"PayPal/Venmo payer first name captured from the approval webhook, when present."},"payerLastName":{"type":"string","description":"PayPal/Venmo payer last name captured from the approval webhook, when present."},"reasonMessage":{"type":"string"},"customerId":{"type":"string"}},"required":["merchantId","fxFees","webhookInfo","id","subtotal","chargebackProtectionFees","gasFees","networkFees","payInFees","total","merchantPaidChargebackProtectionFees","merchantPaidGasFees","merchantPaidFxFees","merchantPaidNetworkFees","invoicedCreditCardFees","invoicedChargebackProtectionFees","invoicedGasFees","invoicedFxFees","invoicedNetworkFees","rebate","invoicedRebate","merchantPaidFees","chargebackId","reasonCode","reasonDescription","respondByDate","fees","customerId"],"description":"From T, pick a set of properties whose keys are in the union K","title":"PaymentChargebackWebhookData3"},"KycWebhookData":{"type":"object","properties":{"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"email":{"type":"string"}},"required":["wallet","blockchain","email"],"title":"KycWebhookData"},"SubMerchantWebhookData":{"type":"object","properties":{"merchantId":{"type":"string"},"email":{"type":"string"},"reason":{"type":"string"}},"required":["merchantId","email"],"title":"SubMerchantWebhookData"},"WithdrawWebhookData":{"type":"object","properties":{"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"signature":{"type":"string"},"userFees":{"$ref":"#/components/schemas/CurrencyCents"},"userGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"userCustomFees":{"$ref":"#/components/schemas/CurrencyCents"},"userSwapFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantGasFees":{"$ref":"#/components/schemas/CurrencyCents"},"merchantSwapFees":{"$ref":"#/components/schemas/CurrencyCents"},"total":{"$ref":"#/components/schemas/CurrencyCents"},"currency":{"$ref":"#/components/schemas/Currency"},"merchantId":{"type":"string"},"userId":{"type":"string","description":"If you use the `x-coinflow-user-id` header, this will be set to the value of that header.\nOtherwise, it will use the wallet address if available"},"idempotencyKey":{"type":"string"}},"required":["wallet","blockchain","signature","userFees","userGasFees","userCustomFees","merchantFees","merchantGasFees","total","currency","merchantId"],"title":"WithdrawWebhookData"},"InteracPinWebhookData":{"type":"object","properties":{"withdrawerId":{"type":"string","description":"The id of the withdrawer (user or business) the payout belongs to."},"transferId":{"type":"string","description":"The provider transfer id for the Interac payout."},"pin":{"type":"string","description":"The Interac code (PIN) the recipient uses to claim the payout."}},"required":["withdrawerId","transferId","pin"],"title":"InteracPinWebhookData"},"RefundWebhookData":{"type":"object","properties":{"refundId":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"totals":{"$ref":"#/components/schemas/RefundTotals"},"paymentId":{"type":"string"},"status":{"$ref":"#/components/schemas/RefundStatus"},"webhookInfo":{"oneOf":[{"$ref":"#/components/schemas/AnyObject"},{"type":"null"}]},"cardToken":{"type":"string"},"last4":{"type":"string"},"bin":{"type":"string"}},"required":["refundId","wallet","blockchain","totals","paymentId","status"],"title":"RefundWebhookData"},"ReserveWebhookData":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/CurrencyCents"},"paymentId":{"type":"string"},"released":{"type":"string","format":"date-time"}},"required":["amount","paymentId","released"],"title":"ReserveWebhookData"},"IbanRfiWebhookData":{"type":"object","properties":{"rfiId":{"type":"string"},"merchantId":{"type":"string"},"mergeTransactionId":{"type":"string"},"counterpartyName":{"type":"string"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"paymentType":{"type":"string"},"paymentDate":{"type":"string"},"dueDate":{"type":"string"},"paymentId":{"type":"string"},"customerId":{"type":"string"},"withdrawId":{"type":"string"},"withdrawerId":{"type":"string"}},"required":["rfiId","merchantId","mergeTransactionId","counterpartyName","amount","paymentType","paymentDate"],"title":"IbanRfiWebhookData"},"CryptoDepositFundsReceivedWebhookData":{"type":"object","properties":{"sessionId":{"type":"string"},"depositAddress":{"type":"string"},"blockchainChainId":{"type":"string"},"blockchainName":{"type":"string"},"tokenSymbol":{"type":"string"},"user":{"type":"string"},"amount":{"$ref":"#/components/schemas/Cents"},"merchantId":{"type":"string"},"transactionHash":{"type":"string"},"receivedAt":{"type":"string","format":"date-time"}},"required":["sessionId","depositAddress","blockchainChainId","blockchainName","tokenSymbol","user","amount","merchantId","transactionHash","receivedAt"],"title":"CryptoDepositFundsReceivedWebhookData"},"CustomerOverrideLimitWebhookDataThresholdPercent":{"type":"string","enum":["50","80","100"],"title":"CustomerOverrideLimitWebhookDataThresholdPercent"},"CustomerOverrideLimitWebhookData":{"type":"object","properties":{"customerId":{"type":"string"},"rawCustomerId":{"type":"string"},"merchantId":{"type":"string"},"thresholdPercent":{"$ref":"#/components/schemas/CustomerOverrideLimitWebhookDataThresholdPercent"},"currentVolumeCents":{"type":"number","format":"double"},"overrideLimitCents":{"type":"number","format":"double"}},"required":["customerId","rawCustomerId","merchantId","thresholdPercent","currentVolumeCents","overrideLimitCents"],"title":"CustomerOverrideLimitWebhookData"},"CryptoPayinFundsReceivedWebhookData":{"type":"object","properties":{"paymentId":{"type":"string"},"sessionId":{"type":"string"},"depositAddress":{"type":"string"},"blockchainChainId":{"type":"string"},"blockchainName":{"type":"string"},"tokenSymbol":{"type":"string"},"customerId":{"type":"string"},"customerEmail":{"type":"string"},"amount":{"$ref":"#/components/schemas/Cents"},"merchantId":{"type":"string"},"transactionHash":{"type":"string"},"receivedAt":{"type":"string","format":"date-time"}},"required":["paymentId","sessionId","depositAddress","blockchainChainId","blockchainName","tokenSymbol","customerId","customerEmail","amount","merchantId","transactionHash","receivedAt"],"title":"CryptoPayinFundsReceivedWebhookData"},"DisbursedFundsWebhookData":{"type":"object","properties":{"id":{"type":"string"},"merchantId":{"type":"string"},"signature":{"type":"string","description":"The on-chain transaction signature for the disbursement. Always set on a\nsuccessful USDC/Credits disbursement."},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"disbursedAt":{"type":"string","format":"date-time"}},"required":["id","merchantId","signature","amount","disbursedAt"],"title":"DisbursedFundsWebhookData"},"UnknownWirePaymentStatus":{"type":"string","enum":["RECEIVED","RETURNING","RETURNED","RETURN_FAILED","RECONCILED"],"title":"UnknownWirePaymentStatus"},"UnknownWirePaymentWebhookData":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/CurrencyCents"},"externalReferenceId":{"type":"string"},"last4":{"type":"string"},"processor":{"$ref":"#/components/schemas/WireProcessor"},"memo":{"type":"string"},"status":{"$ref":"#/components/schemas/UnknownWirePaymentStatus"},"createdAt":{"type":"string","format":"date-time"}},"required":["amount","externalReferenceId","last4","processor","status","createdAt"],"title":"UnknownWirePaymentWebhookData"},"WebhookData":{"oneOf":[{"$ref":"#/components/schemas/PaymentWebhookData"},{"$ref":"#/components/schemas/PaymentWebhookData3"},{"$ref":"#/components/schemas/PaymentDeclinedWebhookData"},{"$ref":"#/components/schemas/PaymentDeclinedWebhookData3"},{"$ref":"#/components/schemas/SettledWebhookData"},{"$ref":"#/components/schemas/SettledWebhookData3"},{"$ref":"#/components/schemas/SubscriptionWebhookData"},{"$ref":"#/components/schemas/SubscriptionWebhookData3"},{"$ref":"#/components/schemas/PaymentChargebackWebhookData"},{"$ref":"#/components/schemas/PaymentChargebackWebhookData3"},{"$ref":"#/components/schemas/KycWebhookData"},{"$ref":"#/components/schemas/SubMerchantWebhookData"},{"$ref":"#/components/schemas/WithdrawWebhookData"},{"$ref":"#/components/schemas/InteracPinWebhookData"},{"$ref":"#/components/schemas/RefundWebhookData"},{"$ref":"#/components/schemas/ReserveWebhookData"},{"$ref":"#/components/schemas/IbanRfiWebhookData"},{"$ref":"#/components/schemas/CryptoDepositFundsReceivedWebhookData"},{"$ref":"#/components/schemas/CustomerOverrideLimitWebhookData"},{"$ref":"#/components/schemas/CryptoPayinFundsReceivedWebhookData"},{"$ref":"#/components/schemas/DisbursedFundsWebhookData"},{"$ref":"#/components/schemas/UnknownWirePaymentWebhookData"}],"title":"WebhookData"},"WebhookPacketData":{"oneOf":[{"$ref":"#/components/schemas/WebhookData"},{"type":"object","additionalProperties":{"description":"Any type"}}],"title":"WebhookPacketData"},"WebhookPacket":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/WebhookEventType"},"category":{"$ref":"#/components/schemas/WebhookCategory"},"created":{"type":"string"},"data":{"$ref":"#/components/schemas/WebhookPacketData"}},"required":["eventType","category","created","data"],"title":"WebhookPacket"},"WebhookDisplayData":{"oneOf":[{"$ref":"#/components/schemas/WebhookData"},{"$ref":"#/components/schemas/WebhookPacket"}],"title":"WebhookDisplayData"},"WebhookResponse":{"type":"object","properties":{},"title":"WebhookResponse"},"WebhookDisplay":{"type":"object","properties":{"id":{"type":"string"},"merchantId":{"type":"string"},"eventType":{"$ref":"#/components/schemas/WebhookEventType"},"category":{"$ref":"#/components/schemas/WebhookCategory"},"providerId":{"type":"string"},"version":{"$ref":"#/components/schemas/WebhookVersion"},"data":{"$ref":"#/components/schemas/WebhookDisplayData"},"sentAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"responseCode":{"type":"number","format":"double"},"responseData":{"$ref":"#/components/schemas/WebhookResponse"}},"required":["id","merchantId","eventType","category","version","data","sentAt","url","responseCode"],"title":"WebhookDisplay"},"MerchantPaymentsAchReturnsGetParametersSortBy":{"type":"string","enum":["createdAt","amount"],"title":"MerchantPaymentsAchReturnsGetParametersSortBy"},"SupportedChainToken":{"type":"object","properties":{"name":{"type":"string"},"symbol":{"type":"string"},"image":{"type":"string"}},"required":["name","symbol","image"],"title":"SupportedChainToken"},"SupportedChain":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/SupportedChainToken"}}},"required":["name","image","tokens"],"title":"SupportedChain"},"GetSupportedChainsResponse":{"type":"object","properties":{"chains":{"type":"array","items":{"$ref":"#/components/schemas/SupportedChain"}}},"required":["chains"],"title":"GetSupportedChainsResponse"},"UrlWhitelistStatus":{"type":"string","enum":["PENDING","APPROVED","REJECTED"],"title":"UrlWhitelistStatus"},"SanitizedUrlWhitelistRequest":{"type":"object","properties":{"url":{"type":"string"},"status":{"$ref":"#/components/schemas/UrlWhitelistStatus"},"reason":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"processedAt":{"type":"string","format":"date-time"},"rejectionReason":{"type":"string"}},"required":["url","status","createdAt"],"title":"SanitizedUrlWhitelistRequest"},"Merchant_GetUrlWhitelistRequests_Response_200":{"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/SanitizedUrlWhitelistRequest"}}},"required":["requests"],"title":"Merchant_GetUrlWhitelistRequests_Response_200"},"Merchant_GetWithdrawal_Response_200":{"type":"object","properties":{"withdrawal":{"$ref":"#/components/schemas/IWithdraw"}},"required":["withdrawal"],"title":"Merchant_GetWithdrawal_Response_200"},"MerchantWithdrawsGetParametersSortBy":{"type":"string","enum":["createdAt","amount"],"title":"MerchantWithdrawsGetParametersSortBy"},"WithdrawWithDescriptiveStatusMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"WithdrawWithDescriptiveStatusMerchant"},"WithdrawWithDescriptiveStatusUserLocation":{"type":"object","properties":{"resolvedState":{"type":"string"},"resolvedCountry":{"type":"string"},"lng":{"type":"number","format":"double"},"lat":{"type":"number","format":"double"}},"required":["lng","lat"],"description":"Browser-captured geolocation at the time of the withdraw request, when\nthe caller supplied one. Stored independently of payout method so the\nmerchant dashboard can render a map for any withdraw. `resolved*` fields\nare populated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee.","title":"WithdrawWithDescriptiveStatusUserLocation"},"WithdrawWithDescriptiveStatusWithdrawer":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IUser_string_"},{"$ref":"#/components/schemas/IBusiness_string_"}],"title":"WithdrawWithDescriptiveStatusWithdrawer"},"WithdrawWithDescriptiveStatusUserPaidFees":{"type":"object","properties":{"processingFees":{"$ref":"#/components/schemas/CurrencyCents"},"customFees":{"$ref":"#/components/schemas/CurrencyCents"},"swapFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"fees":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["swapFees","gasFees","fees"],"title":"WithdrawWithDescriptiveStatusUserPaidFees"},"WithdrawWithDescriptiveStatusMerchantPaidFees":{"type":"object","properties":{"merchantFundedAmount":{"$ref":"#/components/schemas/CurrencyCents"},"settledInline":{"type":"boolean"},"swapFees":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/CurrencyCents"},"fees":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["swapFees","gasFees","fees"],"title":"WithdrawWithDescriptiveStatusMerchantPaidFees"},"WithdrawWithDescriptiveStatusCryptoPayoutInfo":{"type":"object","properties":{"deliveryTransactionUrl":{"type":"string"},"deliveryTransactionHash":{"type":"string"},"destinationAddress":{"type":"string"},"tokenLogoUrl":{"type":"string"},"chainLogoUrl":{"type":"string"},"token":{"type":"string"},"chain":{"type":"string"}},"required":["destinationAddress","token","chain"],"description":"Delivery details for crypto (speed=crypto) payouts. Chain, token and\ndestination are stamped when the withdrawal is created; the delivery\ntransaction hash is stored by the provider's completion webhook.","title":"WithdrawWithDescriptiveStatusCryptoPayoutInfo"},"WithdrawReviewStatus":{"type":"string","enum":["in_review"],"title":"WithdrawReviewStatus"},"WithdrawStatusWithReview":{"oneOf":[{"$ref":"#/components/schemas/WithdrawStatus"},{"$ref":"#/components/schemas/WithdrawReviewStatus"}],"title":"WithdrawStatusWithReview"},"WithdrawWithDescriptiveStatus":{"type":"object","properties":{"transaction":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"idempotencyKey":{"type":"string"},"merchant":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatusMerchant"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallet":{"type":"string"},"userLocation":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatusUserLocation","description":"Browser-captured geolocation at the time of the withdraw request, when\nthe caller supplied one. Stored independently of payout method so the\nmerchant dashboard can render a map for any withdraw. `resolved*` fields\nare populated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee."},"withdrawer":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatusWithdrawer"},"transferId":{"type":"string"},"accountId":{"type":"string"},"usdToForeignExchangeRate":{"type":"number","format":"double","description":"This is the conversion rate from USD to the foreign currency.\nFor example 0.90 = 0.90 USD/GBP\n\nSo if you want to convert GBP to USD you would multiply 15 GBP * 0.90 USD/GBP = 13.5 USD\nIf you want to convert USD to GBP you would multiply 13.5 USD * 1/0.90 GBP/USD = 15 GBP"},"userPaidFees":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatusUserPaidFees"},"merchantPaidFees":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatusMerchantPaidFees"},"invoiceId":{"type":"string","description":"Set on completion when merchantPaidFees were not settled inline: the\nAccruing invoice the fees were attached to. Mirrors the\nrefund/chargeback/payment invoicing pattern — presence of invoiceId\nmarks the fees as billed."},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"returnStatus":{"$ref":"#/components/schemas/WithdrawFailedReturnStatus"},"unclaimedAt":{"type":"string","format":"date-time","description":"When the provider reported the payout as unclaimed: sent to an email or phone with no account behind it, so the recipient has to claim it before the provider cancels it (30 days for PayPal)."},"cryptoPayoutInfo":{"$ref":"#/components/schemas/WithdrawWithDescriptiveStatusCryptoPayoutInfo","description":"Delivery details for crypto (speed=crypto) payouts. Chain, token and\ndestination are stamped when the withdrawal is created; the delivery\ntransaction hash is stored by the provider's completion webhook."},"expectedDeliveryDate":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"provider":{"type":"string"},"returnTransaction":{"type":"string"},"returnedAt":{"type":"string","format":"date-time"},"returnAddress":{"type":"string","description":"Optional end-user address to send a failed-withdraw refund to instead of\nthe originating wallet. Copied from the CryptoWithdrawSession at creation."},"returnCurrency":{"type":"string"},"returnGlideSessionId":{"type":"string"},"userId":{"type":"string"},"detailMessage":{"type":"string"},"errorData":{"type":"string"},"pin":{"type":"string","description":"Only used for Interac payments if the user must provide their\nbank a PIN to claim the transfer."},"isFirstParty":{"type":"boolean","description":"True when this withdraw was a first-party payout (the merchant\nwithdrawing from their own settlement wallet)."},"payoutInitiated":{"type":"boolean"},"manuallyFailedBy":{"$ref":"#/components/schemas/IWithdrawManualFailAudit"},"manuallySucceededBy":{"$ref":"#/components/schemas/IWithdrawManualSuccessAudit"},"orchestrationTraceId":{"type":"string"},"achTraceId":{"type":"string","description":"The provider's ACH trace ID for this withdraw, when available. Used by\nsupport to give customers a reference the receiving bank can look up.\nCurrently populated for Braid ACH payouts (transaction.ach.traceNumber),\nAptPay ACH payouts (the settled webhook's os-trace), and AptPay\npush-to-card payouts (the transaction's RRN / Retrieval Reference Number)."},"entityTag":{"$ref":"#/components/schemas/EntityTag"},"status":{"$ref":"#/components/schemas/WithdrawStatusWithReview"}},"required":["transaction","createdAt","amount","speed","merchant","blockchain","wallet","withdrawer","transferId","accountId","usdToForeignExchangeRate","userPaidFees","merchantPaidFees","invoiceId","outstanding","expectedDeliveryDate","updatedAt","provider","achTraceId","status"],"description":"From T, pick a set of properties whose keys are in the union K","title":"WithdrawWithDescriptiveStatus"},"IWithdrawerMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IWithdrawerMerchant"},"IWithdrawer":{"type":"object","properties":{"_id":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallets":{"type":"array","items":{"$ref":"#/components/schemas/IWallet"},"deprecated":true},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"currency":{"$ref":"#/components/schemas/Currency"},"originalCurrency":{"$ref":"#/components/schemas/WithdrawCurrency"},"merchant":{"$ref":"#/components/schemas/IWithdrawerMerchant"},"verification":{"$ref":"#/components/schemas/Verification"},"riskScoreOverride":{"type":"boolean"},"country":{"type":"string"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockCardReuseExempt":{"type":"boolean","description":"When true, this withdrawer is exempt from the merchant\n`banDuplicateAccounts` re-use check, so it may add an account that another\nwithdrawer already uses without being blocked (423 `PAYMENT_METHOD_IN_USE`)."},"createdAt":{"type":"string","format":"date-time"}},"required":["_id","wallet","blockchain","email","availability","currency","merchant","verification","riskScoreOverride","country"],"title":"IWithdrawer"},"PassiveDepositAddressListItemStatus":{"type":"string","enum":["active","paused"],"title":"PassiveDepositAddressListItemStatus"},"PassiveDepositAddressListItem":{"type":"object","properties":{"depositAddress":{"type":"string"},"chain":{"type":"string"},"token":{"type":"string"},"account":{"type":"string"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"status":{"$ref":"#/components/schemas/PassiveDepositAddressListItemStatus"},"createdAt":{"type":"string","format":"date-time"}},"required":["depositAddress","chain","token","account","speed","status","createdAt"],"title":"PassiveDepositAddressListItem"},"PassiveDepositAddressListResponse":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/PassiveDepositAddressListItem"}}},"required":["addresses"],"title":"PassiveDepositAddressListResponse"},"CreditOperation":{"type":"object","properties":{"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"amount":{"$ref":"#/components/schemas/Cents"},"idempotencyKey":{"type":"string"}},"required":["wallet","blockchain","amount"],"title":"CreditOperation"},"MerchantCreditsMintPostResponsesContentApplicationJsonSchemaJobId":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"MerchantCreditsMintPostResponsesContentApplicationJsonSchemaJobId"},"Merchant_MintCredits_Response_200":{"type":"object","properties":{"jobId":{"$ref":"#/components/schemas/MerchantCreditsMintPostResponsesContentApplicationJsonSchemaJobId"}},"required":["jobId"],"title":"Merchant_MintCredits_Response_200"},"DelegatedCryptoDestination":{"type":"object","properties":{"address":{"type":"string","description":"The on-chain address the funds will be delivered to. Coinflow does NOT\nvalidate this address — if it is wrong, malformed for the chain, or\ncontrolled by an attacker, the funds are gone."},"chain":{"type":"string","description":"The destination chain id from the crypto payout tokens endpoint\n(e.g. \"eip155:8453\")."},"token":{"type":"string","description":"The token id to deliver from the crypto payout tokens endpoint — the\nlowercase symbol (e.g. \"usdc\"), matched case-insensitively."}},"required":["address","chain","token"],"title":"DelegatedCryptoDestination"},"PayoutDelegatedArgsAccount":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/DelegatedCryptoDestination"}],"description":"The payout destination. Every speed except crypto takes the payout\naccount token; the crypto speed takes the on-chain destination.","title":"PayoutDelegatedArgsAccount"},"PayoutDelegatedArgsAmount":{"type":"object","properties":{"cents":{"type":"integer","minimum":0},"currency":{"$ref":"#/components/schemas/Currency"}},"required":["cents"],"title":"PayoutDelegatedArgsAmount"},"PayoutDelegatedArgs":{"type":"object","properties":{"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"userId":{"type":"string","description":"The Merchant generated userId for the user."},"waitForConfirmation":{"type":"boolean","description":"If true (default), the API will wait for transaction confirmation before returning.\nIf false, the transaction will be queued for processing and the API will return immediately with just the signature."},"idempotencyKey":{"type":"string","description":"Client generates an idempotency key, which is a unique key that the server uses to recognize subsequent retries of\nthe same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string\nwith enough entropy to avoid collisions."},"account":{"$ref":"#/components/schemas/PayoutDelegatedArgsAccount","description":"The payout destination. Every speed except crypto takes the payout\naccount token; the crypto speed takes the on-chain destination."},"amount":{"$ref":"#/components/schemas/PayoutDelegatedArgsAmount"}},"required":["speed","userId","idempotencyKey","account","amount"],"description":"From T, pick a set of properties whose keys are in the union K","title":"PayoutDelegatedArgs"},"DelegatedPayoutResponse":{"type":"object","properties":{"signature":{"type":"string"},"effectiveSpeed":{"$ref":"#/components/schemas/WithdrawSpeed"}},"required":["effectiveSpeed"],"title":"DelegatedPayoutResponse"},"PayoutFromDelegatedSettlementWalletRequestUnavailableForLegalReasonsError":{"type":"object","properties":{"verificationLink":{"type":"string"},"message":{"type":"string"}},"required":["verificationLink","message"],"title":"PayoutFromDelegatedSettlementWalletRequestUnavailableForLegalReasonsError"},"UserWithdrawTransactionParams":{"type":"object","properties":{"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"userId":{"type":"string","description":"The Merchant generated userId for the user."},"amount":{"$ref":"#/components/schemas/Cents"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"account":{"type":"string","description":"The debit card, bank or Iban pci-compliant token"}},"required":["wallet","blockchain","userId","amount","speed","account"],"title":"UserWithdrawTransactionParams"},"GetWithdrawTransactionResponse":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"string"},"description":"The transactions to be signed by the user and sent to the blockchain.\n\nSolana - Transactions are base58 encoded. You can reconstruct them by calling `Transaction.from(base58.decode(transaction))`\nEvm - Transactions are JSON stringified. You can reconstruct them by calling `JSON.parse(transaction)`"}},"required":["transactions"],"title":"GetWithdrawTransactionResponse"},"Merchant_RefundPayment_Response_200":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"Merchant_RefundPayment_Response_200"},"MerchantWebhooksWebhookLogIdPostResponsesContentApplicationJsonSchemaJobId":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"MerchantWebhooksWebhookLogIdPostResponsesContentApplicationJsonSchemaJobId"},"Merchant_ResendWebhook_Response_200":{"type":"object","properties":{"jobId":{"$ref":"#/components/schemas/MerchantWebhooksWebhookLogIdPostResponsesContentApplicationJsonSchemaJobId"}},"required":["jobId"],"title":"Merchant_ResendWebhook_Response_200"},"Merchant_SettlePayment_Response_200":{"oneOf":[{"type":"number","format":"double"},{"type":"string"},{"description":"Any type"}],"title":"Merchant_SettlePayment_Response_200"},"Merchant Accounts_CreateSubsidiary_Response_200":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"],"title":"Merchant Accounts_CreateSubsidiary_Response_200"},"ManagedTransferRequest":{"type":"object","properties":{"sourceId":{"type":"string"},"destinationId":{"type":"string"},"amount":{"$ref":"#/components/schemas/Cents"},"note":{"type":"string"}},"required":["sourceId","destinationId","amount"],"title":"ManagedTransferRequest"},"ManagedAccountStatus":{"type":"string","enum":["pending","active","archived"],"title":"ManagedAccountStatus"},"ManagedAccount":{"type":"object","properties":{"name":{"type":"string"},"accountId":{"type":"string"},"address":{"type":"string"},"status":{"$ref":"#/components/schemas/ManagedAccountStatus"},"balance":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["name","accountId","status","balance"],"title":"ManagedAccount"},"SubscriptionPlanRequest":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"duration":{"type":"integer","minimum":1},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"description":{"type":"string"},"transaction":{"type":"string"},"settlementChain":{"$ref":"#/components/schemas/OperationalBlockchain"},"active":{"type":"boolean"},"merchantInitiated":{"type":"boolean","description":"Only specify this as true if you do not want subscription payments automatically processed. Then you will be responsible for manually calling the merchant initiated transaction endpoint."}},"required":["name","code","interval","amount"],"title":"SubscriptionPlanRequest"},"SubscriptionPlan":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"duration":{"type":"integer","minimum":1},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"description":{"type":"string"},"transaction":{"type":"string"},"settlementChain":{"$ref":"#/components/schemas/OperationalBlockchain"},"active":{"type":"boolean"},"merchantInitiated":{"type":"boolean","description":"Only specify this as true if you do not want subscription payments automatically processed. Then you will be responsible for manually calling the merchant initiated transaction endpoint."}},"required":["id","name","code","interval","amount","active"],"title":"SubscriptionPlan"},"SubscriptionPayment":{"type":"object","properties":{"paymentId":{"type":"string"},"status":{"type":"string"},"totals":{"$ref":"#/components/schemas/TotalsResponse"},"paidAt":{"type":"string","format":"date-time"}},"required":["paymentId","status","totals","paidAt"],"title":"SubscriptionPayment"},"Partial_SubscriptionPlanRequest_":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"duration":{"type":"integer","minimum":1},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"description":{"type":"string"},"transaction":{"type":"string"},"settlementChain":{"$ref":"#/components/schemas/OperationalBlockchain"},"active":{"type":"boolean"},"merchantInitiated":{"type":"boolean","description":"Only specify this as true if you do not want subscription payments automatically processed. Then you will be responsible for manually calling the merchant initiated transaction endpoint."}},"description":"Make all properties in T optional","title":"Partial_SubscriptionPlanRequest_"},"GetEvmCreditsAuthMsgBody":{"type":"object","properties":{"merchantId":{"type":"string","description":"The ID of the merchant requesting redemption."},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"usdcAmount":{"$ref":"#/components/schemas/Cents"}},"required":["merchantId","subtotal","transactionData"],"title":"GetEvmCreditsAuthMsgBody"},"GetCreditsAuthMessageResponse":{"type":"object","properties":{"message":{"type":"string","description":"EIP-712 typed-data JSON string for the user to sign via eth_signTypedData_v"},"validBefore":{"type":"string","description":"Timestamp indicating signature validity period"},"nonce":{"type":"string","description":"Unique identifier for the transaction"},"creditsRawAmount":{"type":"number","format":"double","description":"Total amount of credits that will be used including gas fees"}},"required":["message","validBefore","nonce","creditsRawAmount"],"description":"For retrieving the typed-data (EIP-712) that a user must sign to authorize credits usage.","title":"GetCreditsAuthMessageResponse"},"ApiError":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"},"stack":{"type":"string"}},"required":["name","message"],"title":"ApiError"},"SignedMessages":{"type":"object","properties":{"permitCredits":{"type":"string","description":"(Evm only) This is the signed permit messages that the user must sign granting the Merchant Contract access to their balances."},"customerUsdcAuthData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcAuthDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"}},"required":["permitCredits"],"title":"SignedMessages"},"RedeemCartItems":{"type":"array","items":{"$ref":"#/components/schemas/Pick_nftCartItem.Exclude_keyofnftCartItem.sellingPrice-or-itemClass__"},"title":"RedeemCartItems"},"EvmRedeemBody":{"type":"object","properties":{"merchantId":{"type":"string","description":"The ID of the merchant requesting redemption."},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"transactionData":{"$ref":"#/components/schemas/EvmTransactionData"},"usdcAmount":{"$ref":"#/components/schemas/Cents"},"signedMessages":{"$ref":"#/components/schemas/SignedMessages"},"chargebackProtectionData":{"$ref":"#/components/schemas/RedeemCartItems"},"validBefore":{"type":"string","description":"Values returned from getEvmCreditsAuthMsg endpoint"},"nonce":{"type":"string"},"creditsRawAmount":{"type":"number","format":"double"}},"required":["merchantId","subtotal","transactionData","signedMessages","validBefore","nonce","creditsRawAmount"],"description":"EVM-specific Redeem body","title":"EvmRedeemBody"},"Redeem_SendEvmCreditsGaslessTx_Response_200":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"],"title":"Redeem_SendEvmCreditsGaslessTx_Response_200"},"MerchantWalletRedeemBody":{"type":"object","properties":{"merchantId":{"type":"string"},"chargebackProtectionData":{"$ref":"#/components/schemas/RedeemCartItems"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"jwtToken":{"type":"string","description":"This is a token encoding the parameters for the request. Allows purchase parameters to be verified\nto prevent manipulation when the checkout page is presented to the user."},"redeemAmount":{"$ref":"#/components/schemas/Cents"},"subtotal":{"$ref":"#/components/schemas/Cents"}},"required":["merchantId","subtotal"],"description":"From T, pick a set of properties whose keys are in the union K","title":"MerchantWalletRedeemBody"},"RedeemResponse":{"type":"object","properties":{"transaction":{"type":"string","description":"Transaction for the users wallet to sign and send.\n\nSolana - base 58 encoded transaction, recover using: `Transaction.from(base58.decode(transaction))`\nNear - Base 64 encoded stringified transaction, recover using: `JSON.parse(Buffer.from(transaction, 'base64').toString());`\nEvm - Base 64 encoded stringified transaction, recover using: `JSON.parse(Buffer.from(transaction, 'base64').toString());`"}},"required":["transaction"],"title":"RedeemResponse"},"RedeemBodyRentLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"RedeemBodyRentLamports"},"RedeemBodyRent":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/RedeemBodyRentLamports"}},"required":["lamports"],"description":"(Solana Only) if your transaction requires a known amount of Rent to be paid, you can pass it here.","title":"RedeemBodyRent"},"RedeemBodyNativeSolToConvertLamports":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"RedeemBodyNativeSolToConvertLamports"},"RedeemBodyNativeSolToConvert":{"type":"object","properties":{"lamports":{"$ref":"#/components/schemas/RedeemBodyNativeSolToConvertLamports"}},"required":["lamports"],"description":"(Solana Only) Only use this if your subtotal.token is `So11111111111111111111111111111111111111112` and your\ncontract requires native SOL. This will convert the amount of wSOL to native SOL for use in the transaction.","title":"RedeemBodyNativeSolToConvert"},"RedeemBody":{"type":"object","properties":{"merchantId":{"type":"string"},"subtotal":{"$ref":"#/components/schemas/Subtotal"},"transaction":{"type":"string","description":"Transaction for which the purchase will be redeemed. This should be constructed by the merchant, and should\nbe setup the same way as if the user has USDC/Purchase Token in their wallet. The endpoint will modify this\ntransaction and then send it back to the user to sign and send.\n\nSolana - base 58 encoded transaction, create using: `base58.encode(transaction.serialize({ requireAllSignatures: false, verifySignatures: false }))`\nEvm - Base 64 encoded stringified transaction, create using: `Buffer.from(JSON.stringify(transaction)).toString('base64')`"},"signedMessages":{"$ref":"#/components/schemas/SignedMessages"},"chargebackProtectionData":{"$ref":"#/components/schemas/RedeemCartItems"},"rent":{"$ref":"#/components/schemas/RedeemBodyRent","description":"(Solana Only) if your transaction requires a known amount of Rent to be paid, you can pass it here."},"nativeSolToConvert":{"$ref":"#/components/schemas/RedeemBodyNativeSolToConvert","description":"(Solana Only) Only use this if your subtotal.token is `So11111111111111111111111111111111111111112` and your\ncontract requires native SOL. This will convert the amount of wSOL to native SOL for use in the transaction."},"skipBalanceCheck":{"type":"boolean"}},"required":["merchantId","subtotal","transaction"],"title":"RedeemBody"},"RefundInfo":{"type":"object","properties":{"id":{"type":"string"},"merchantId":{"type":"string"},"paymentId":{"type":"string"},"userId":{"type":"string"},"totals":{"$ref":"#/components/schemas/RefundTotals"},"signature":{"type":"string"},"status":{"$ref":"#/components/schemas/RefundStatus"},"reimbursementStatus":{"$ref":"#/components/schemas/ReimbursementStatus"},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"source":{"$ref":"#/components/schemas/RefundSource"},"method":{"$ref":"#/components/schemas/RefundMethod"},"failureReason":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","merchantId","paymentId","totals","status","reimbursementStatus","outstanding","source","method","createdAt"],"title":"RefundInfo"},"RefundsRefundIdRetryPostResponsesContentApplicationJsonSchemaJobId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"RefundsRefundIdRetryPostResponsesContentApplicationJsonSchemaJobId"},"Refund_RetryRefund_Response_200":{"type":"object","properties":{"jobId":{"$ref":"#/components/schemas/RefundsRefundIdRetryPostResponsesContentApplicationJsonSchemaJobId"}},"required":["jobId"],"title":"Refund_RetryRefund_Response_200"},"mongoose.Types.ObjectId":{"type":"string","title":"mongoose.Types.ObjectId"},"IMerchantMongooseTypesObjectIdWithdrawFees":{"type":"object","properties":{"firstParty":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"business":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"user":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawFeeConfig__"},"swapBps":{"type":"number","format":"double"}},"required":["firstParty","business","user","swapBps"],"title":"IMerchantMongooseTypesObjectIdWithdrawFees"},"IMerchantMongooseTypesObjectIdWalletsStellar":{"type":"object","properties":{"usdcPayer":{"type":"string"}},"required":["usdcPayer"],"title":"IMerchantMongooseTypesObjectIdWalletsStellar"},"IMerchantMongooseTypesObjectIdWalletsEvm":{"type":"object","properties":{"usdcPayer":{"type":"string"},"feePayer":{"type":"string"}},"required":["usdcPayer","feePayer"],"title":"IMerchantMongooseTypesObjectIdWalletsEvm"},"IMerchantMongooseTypesObjectIdWalletsSolana":{"type":"object","properties":{"usdcPayer":{"type":"string"},"feePayer":{"type":"string"}},"required":["usdcPayer","feePayer"],"title":"IMerchantMongooseTypesObjectIdWalletsSolana"},"IMerchantMongooseTypesObjectIdWallets":{"type":"object","properties":{"stellar":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdWalletsStellar"},"evm":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdWalletsEvm"},"solana":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdWalletsSolana"}},"required":["stellar","evm","solana"],"title":"IMerchantMongooseTypesObjectIdWallets"},"IMerchantMongooseTypesObjectIdApiKeysItems":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/MerchantScope"},"ips":{"type":"array","items":{"type":"string"}},"disabled":{"type":"boolean"},"privateUuid":{"type":"string"},"publicUuid":{"type":"string"}},"required":["ips","privateUuid","publicUuid"],"title":"IMerchantMongooseTypesObjectIdApiKeysItems"},"IMerchantMongooseTypesObjectIdSettlementAddressesRecipientAddressesItems":{"type":"object","properties":{"info":{"$ref":"#/components/schemas/Record_string.any_"},"createdAt":{"type":"string","format":"date-time"},"recipient":{"type":"string"}},"required":["createdAt","recipient"],"title":"IMerchantMongooseTypesObjectIdSettlementAddressesRecipientAddressesItems"},"IMerchantMongooseTypesObjectIdSettlementAddresses":{"type":"object","properties":{"solana":{"type":"string"},"eth":{"type":"string"},"polygon":{"type":"string"},"base":{"type":"string"},"user":{"type":"string"},"arbitrum":{"type":"string"},"stellar":{"type":"string"},"monad":{"type":"string"},"tempo":{"type":"string"},"directVendor":{"$ref":"#/components/schemas/DirectVendorSettlement"},"mpcWalletProvider":{"$ref":"#/components/schemas/MpcWalletProvider"},"recipientAddresses":{"type":"array","items":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdSettlementAddressesRecipientAddressesItems"}},"verification":{"$ref":"#/components/schemas/Verification"}},"title":"IMerchantMongooseTypesObjectIdSettlementAddresses"},"IMerchantMongooseTypesObjectIdBlockConfig":{"type":"object","properties":{"disableMultiCardAttemptCheck":{"type":"boolean","description":"When true, skips the multi-card attempt check (2+ distinct cards failing in 1 hour)."},"maxDistinctTokensPer30Days":{"type":"number","format":"double","description":"Maximum number of distinct card tokens a single customer may use across\nnon-failed/voided card payments for this merchant in a rolling 30-day\nwindow. Apple Pay / Google Pay payments are excluded. Unset or 0 disables\nthe check. Customers with `failedAttemptSetting: Exempt` bypass it."},"disableDestinationAuthKey":{"type":"boolean","description":"When true, prevents usage of destinationAuthKey for custom settlement addresses."},"enableNmiSettlement":{"type":"boolean","description":"When true, enables the settlement pipeline for NMI transactions (converts card payments to USDC)."},"disableInvoiceWalletPayment":{"type":"boolean","description":"When true, disables wallet balance payments for invoices. Merchants must use checkout."},"blockingRules":{"type":"array","items":{"$ref":"#/components/schemas/IBlockingRule"},"description":"Independent geo-blocking rules for withdrawals vs card checkout, with\nexplicit per-rule enforcement methods (KYC address / IP / billing address).\nRead via `getBlockingRules` so callers transparently see the legacy\n`bannedWithdrawalStates` for un-migrated merchants."},"bannedWithdrawalStates":{"type":"array","items":{"$ref":"#/components/schemas/USState"},"deprecated":true},"whitelistedBinLocations":{"type":"array","items":{"$ref":"#/components/schemas/Country"},"deprecated":true},"failedPaymentAttemptLimit":{"type":"number","format":"double"}},"title":"IMerchantMongooseTypesObjectIdBlockConfig"},"IMerchantMongooseTypesObjectIdWithdrawFeePayment":{"type":"object","properties":{"paysGasFees":{"$ref":"#/components/schemas/Partial_Record_Blockchain.boolean__"},"bundleDelegatedPayoutFees":{"type":"boolean"},"paysSwapFees":{"type":"boolean"},"paysWithdrawFees":{"type":"boolean"}},"title":"IMerchantMongooseTypesObjectIdWithdrawFeePayment"},"IMerchantMongooseTypesObjectIdFirstPartyPayoutOverrides":{"type":"object","properties":{"interacPayoutProvider":{"$ref":"#/components/schemas/InteracPayoutProvider"},"wirePayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/WirePayoutProvider"}},"paypalPayoutProvider":{"$ref":"#/components/schemas/PayPalPayoutProvider"},"venmoPayoutProvider":{"$ref":"#/components/schemas/VenmoPayoutProvider"},"appleP2cPayoutProvider":{"$ref":"#/components/schemas/ApplePayPayoutProvider"},"globalP2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"p2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"eftPayoutProvider":{"$ref":"#/components/schemas/EftPayoutProvider"},"pixPayoutProvider":{"$ref":"#/components/schemas/PixPayoutProvider"},"rtpPayoutProvider":{"$ref":"#/components/schemas/RtpPayoutProvider"},"ibanPayoutProvider":{"$ref":"#/components/schemas/IbanPayoutProvider"},"bankPayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/PayoutProviderOption"}}},"title":"IMerchantMongooseTypesObjectIdFirstPartyPayoutOverrides","deprecated":true},"IMerchantMongooseTypesObjectIdCheckbookSettings":{"type":"object","properties":{"merchantName":{"type":"string"},"secret":{"type":"string"},"key":{"type":"string"},"walletId":{"type":"string"},"id":{"type":"string"}},"required":["merchantName","secret","key","walletId","id"],"title":"IMerchantMongooseTypesObjectIdCheckbookSettings"},"IMerchantMongooseTypesObjectIdRiskControls":{"type":"object","properties":{"topup":{"$ref":"#/components/schemas/TopupRiskControls"}},"title":"IMerchantMongooseTypesObjectIdRiskControls"},"IMerchantMongooseTypesObjectIdProcessing":{"type":"object","properties":{"msaSigned":{"type":"boolean"},"statementsOnFile":{"type":"boolean"}},"required":["msaSigned","statementsOnFile"],"title":"IMerchantMongooseTypesObjectIdProcessing"},"IMerchant_mongoose.Types.ObjectId_":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"merchantId":{"type":"string"},"verification":{"$ref":"#/components/schemas/Verification"},"brand":{"$ref":"#/components/schemas/MerchantBrandSettings"},"colors":{"$ref":"#/components/schemas/MerchantTheme"},"url":{"type":"string"},"supportEmail":{"type":"string"},"withdrawFees":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdWithdrawFees"},"customWithdrawFees":{"$ref":"#/components/schemas/CustomWithdrawFeesConfig"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"wallets":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdWallets"},"apiKey":{"type":"string"},"webhookValidationKey":{"type":"string"},"nmiWebhookValidationKey":{"type":"string"},"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdApiKeysItems"}},"kycType":{"$ref":"#/components/schemas/KycType"},"settlementToken":{"$ref":"#/components/schemas/StableCoin"},"settlementAddresses":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdSettlementAddresses"},"users":{"type":"array","items":{"$ref":"#/components/schemas/IMerchantUser"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}},"goLiveChecklist":{"$ref":"#/components/schemas/MerchantGoLiveChecklist"},"webhookSettings":{"$ref":"#/components/schemas/WebhookSettings"},"cardSettings":{"$ref":"#/components/schemas/CardSettings"},"achSettings":{"$ref":"#/components/schemas/ACHSettings"},"citconSettings":{"$ref":"#/components/schemas/CitconSettings"},"aptPayCanadaSettings":{"$ref":"#/components/schemas/AptPayCanadaSettings"},"wireSettings":{"$ref":"#/components/schemas/IWireProviderSettings"},"pixSettings":{"$ref":"#/components/schemas/PixSettings"},"ibanSettings":{"$ref":"#/components/schemas/IbanSettings"},"cryptoPayinSettings":{"$ref":"#/components/schemas/CryptoPayInSettings"},"cryptoPayoutSettings":{"$ref":"#/components/schemas/Record_CryptoPayoutTiers.CryptoPayoutTierSettings_"},"passiveWithdrawSettings":{"$ref":"#/components/schemas/PassiveWithdrawSettings"},"cashAppSettings":{"$ref":"#/components/schemas/CashAppSettings"},"rainCompanyCards":{"$ref":"#/components/schemas/RainCompanyCardsSettings"},"paypalSettings":{"$ref":"#/components/schemas/PayPalSettings"},"venmoSettings":{"$ref":"#/components/schemas/VenmoSettings"},"apaSettings":{"$ref":"#/components/schemas/ApaSettings"},"verisoulSettings":{"$ref":"#/components/schemas/VerisoulSettings"},"chargebackFightSettings":{"$ref":"#/components/schemas/ChargebackFightSettings"},"blockConfig":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdBlockConfig"},"hideBranding":{"type":"boolean"},"onlyShowTotal":{"type":"boolean"},"skipSendWithdrawEmail":{"type":"boolean"},"sendInvoiceNotifications":{"type":"boolean"},"invoiceFrequency":{"$ref":"#/components/schemas/InvoiceFrequency"},"advancedAnalytics":{"type":"boolean"},"riskInsights":{"type":"boolean","description":"Gates the Risk Insights dashboard. Admins see it regardless."},"billingEmails":{"type":"array","items":{"type":"string"}},"withdrawFeePayment":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdWithdrawFeePayment"},"pushToCardEnabled":{"type":"boolean","deprecated":true},"requireAniCheck":{"type":"boolean"},"bankPayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/PayoutProviderOption"}},"ibanPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/IbanPayoutProvider"}},"swiftPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/SwiftPayoutProvider"}},"ibanPayoutProvider":{"$ref":"#/components/schemas/IbanPayoutProvider"},"rtpPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/RtpPayoutProvider"}},"rtpPayoutProvider":{"$ref":"#/components/schemas/RtpPayoutProvider"},"pixPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/PixPayoutProvider"}},"pixPayoutProvider":{"$ref":"#/components/schemas/PixPayoutProvider"},"eftPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/EftPayoutProvider"}},"eftPayoutProvider":{"$ref":"#/components/schemas/EftPayoutProvider"},"p2cPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/CardPayoutProvider"}},"p2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"globalP2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"appleP2cPayoutProvider":{"$ref":"#/components/schemas/ApplePayPayoutProvider"},"venmoPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/VenmoPayoutProvider"}},"venmoPayoutProvider":{"$ref":"#/components/schemas/VenmoPayoutProvider"},"paypalPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/PayPalPayoutProvider"}},"paypalPayoutProvider":{"$ref":"#/components/schemas/PayPalPayoutProvider"},"wirePayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/WirePayoutProvider"}},"cryptoPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/CryptoPayoutProvider"}},"interacPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/InteracPayoutProvider"}},"interacPayoutProvider":{"$ref":"#/components/schemas/InteracPayoutProvider"},"interacPaymentProvider":{"$ref":"#/components/schemas/InteracProcessor"},"interacSettings":{"$ref":"#/components/schemas/InteracSettings"},"withdrawSorting":{"$ref":"#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawSort__"},"withdrawRules":{"type":"array","items":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"}},"firstPartyPayoutOverrides":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdFirstPartyPayoutOverrides","deprecated":true},"maxTransactionAmount":{"$ref":"#/components/schemas/Cents"},"minTransactionAmount":{"$ref":"#/components/schemas/Cents"},"refundBalanceLimit":{"$ref":"#/components/schemas/Cents"},"parent":{"type":"string"},"onboardingVersion":{"$ref":"#/components/schemas/OnboardingVersion"},"childDefaultOnboardingVersion":{"$ref":"#/components/schemas/OnboardingVersion"},"creditSeed":{"type":"string"},"withdrawSettlementLocation":{"$ref":"#/components/schemas/SettlementLocations"},"enforceJwt":{"type":"boolean"},"enforceCheckoutJwt":{"type":"boolean"},"externalVerificationLinks":{"type":"boolean"},"whitelistedAncestorUrls":{"type":"array","items":{"type":"string"}},"banDuplicateAccounts":{"type":"boolean"},"fxFees":{"$ref":"#/components/schemas/Partial_Record_Currency.number__"},"blocked":{"$ref":"#/components/schemas/BlockedStatus"},"dealOwnerAdminId":{"type":"string"},"referralPartner":{"type":"string"},"signedMsaUrl":{"type":"string"},"crmSyncedAt":{"type":"string","format":"date-time"},"vendorSettings":{"$ref":"#/components/schemas/VendorSettings"},"generatedDescription":{"type":"string"},"bankSettlementOptions":{"$ref":"#/components/schemas/MerchantBankSettlementOptions"},"allowAttestedKyc":{"type":"boolean"},"attestedKycSsnNotRequired":{"type":"boolean"},"allowAccountSharing":{"type":"boolean"},"personaKycShareTokenTemplate":{"type":"string"},"delayedSettlementDays":{"type":"number","format":"double","description":"Number of business days to delay stablecoin settlement after payment capture.\nOnly applies to USDC settlements. 0 means no delay (immediate settlement).\nMaximum value is 5 days."},"sendPresettleWebhooks":{"type":"boolean"},"velocitySettings":{"$ref":"#/components/schemas/VelocityControlSettings"},"velocitySettingsByRail":{"$ref":"#/components/schemas/Partial_Record_PaymentType.VelocityControlSettings__"},"interchangeFees":{"$ref":"#/components/schemas/InterchangeFees"},"enforceLivenessKyc":{"type":"boolean"},"kycMinAge":{"type":"number","format":"double"},"canCreateBankAccounts":{"type":"boolean"},"checkbookSettings":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdCheckbookSettings"},"reserveSettings":{"$ref":"#/components/schemas/ReserveSettings"},"embeddedAccountSettings":{"$ref":"#/components/schemas/EmbeddedAccountSettings"},"globalRateLimit":{"type":"number","format":"double"},"banProxiesForCheckoutEndpoints":{"type":"boolean"},"riskControls":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdRiskControls"},"acceptedToS":{"type":"boolean"},"ssoSettings":{"$ref":"#/components/schemas/MerchantSsoSettings"},"chargebackFeeCents":{"type":"number","format":"double"},"chargebackEmails":{"type":"array","items":{"type":"string"}},"fraudEmails":{"type":"array","items":{"type":"string"}},"linkedBankAccount":{"$ref":"#/components/schemas/LinkedBankAccount"},"customerDefaultOverrideLimit":{"$ref":"#/components/schemas/Cents"},"customerOverrideLimitCeiling":{"$ref":"#/components/schemas/Cents"},"customerDefaultExposureLimit":{"$ref":"#/components/schemas/Cents"},"dailyExposureLimit":{"$ref":"#/components/schemas/Cents"},"monthlyExposureLimit":{"$ref":"#/components/schemas/Cents"},"sendExposureCapSlackAlerts":{"type":"boolean"},"mcc":{"type":"string"},"processing":{"$ref":"#/components/schemas/IMerchantMongooseTypesObjectIdProcessing"}},"required":["_id","merchantId","verification","withdrawFees","wallets","apiKey","apiKeys","kycType","settlementToken","users","ubos","goLiveChecklist","cardSettings","achSettings","wireSettings","pixSettings","ibanSettings","cryptoPayinSettings","cashAppSettings","paypalSettings","venmoSettings","apaSettings","hideBranding","onlyShowTotal","skipSendWithdrawEmail","sendInvoiceNotifications","advancedAnalytics","riskInsights","pushToCardEnabled","requireAniCheck","interacSettings","refundBalanceLimit","creditSeed","withdrawSettlementLocation","enforceJwt","delayedSettlementDays","interchangeFees"],"title":"IMerchant_mongoose.Types.ObjectId_"},"ICustomerMongooseTypesObjectIdMerchant":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/IMerchant_mongoose.Types.ObjectId_"}],"title":"ICustomerMongooseTypesObjectIdMerchant"},"ICustomerMongooseTypesObjectIdBlockConfigOverride":{"type":"object","properties":{"maxDistinctTokensPer30Days":{"type":"number","format":"double"}},"description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit.","title":"ICustomerMongooseTypesObjectIdBlockConfigOverride"},"ICustomer_mongoose.Types.ObjectId_":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"customerId":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"createdAt":{"type":"string","format":"date-time"},"verification":{"$ref":"#/components/schemas/Verification"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"chargebackProtectionEnabled":{"type":"boolean"},"merchant":{"$ref":"#/components/schemas/ICustomerMongooseTypesObjectIdMerchant"},"failedAttemptSetting":{"$ref":"#/components/schemas/FailedAttemptSetting"},"verificationSetting":{"$ref":"#/components/schemas/CustomerVerificationSetting"},"exempt3DS":{"type":"boolean"},"chargebackProtectionOverrideLog":{"$ref":"#/components/schemas/CustomerOverrideAuditLog"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockConfigOverride":{"$ref":"#/components/schemas/ICustomerMongooseTypesObjectIdBlockConfigOverride","description":"Per-customer overrides of merchant `blockConfig`. Only honored when they raise the effective limit."},"customerOverrideLimit":{"$ref":"#/components/schemas/Cents"},"overrideExposureLimit":{"$ref":"#/components/schemas/Cents"},"fraudOverrideWhitelist":{"type":"boolean"},"excludeBlockCardReuseAcrossCustomers":{"type":"boolean"}},"required":["_id","customerId","email","availability","createdAt","chargebackProtectionEnabled","merchant","failedAttemptSetting","verificationSetting"],"title":"ICustomer_mongoose.Types.ObjectId_"},"IPaymentMongooseTypesObjectIdCustomer":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/ICustomer_mongoose.Types.ObjectId_"}],"title":"IPaymentMongooseTypesObjectIdCustomer"},"IPaymentMongooseTypesObjectIdMerchant":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/IMerchant_mongoose.Types.ObjectId_"}],"title":"IPaymentMongooseTypesObjectIdMerchant"},"IPaymentMongooseTypesObjectIdCardInfo":{"type":"object","properties":{"storedTransactionType":{"$ref":"#/components/schemas/StoredCardTransactionType"},"authorizationPaymentReference":{"type":"string"},"originalPaymentId":{"type":"string","description":"This is really the permissioning payment Id - what paymentId was used that had a CVV entered to authorize it"},"statementDescriptor":{"type":"string"},"interchangeKey":{"type":"string"},"fraudReport":{"$ref":"#/components/schemas/FraudReport"},"enhancedTxInfo":{"$ref":"#/components/schemas/EnhancedTxInfo"},"transaction":{"type":"string"},"secureTransactionId":{"type":"string"},"processed3DS":{"$ref":"#/components/schemas/Verification3DS"},"cardType":{"$ref":"#/components/schemas/CardType"},"last4":{"type":"string"},"token":{"type":"string"},"mobileWallet":{"$ref":"#/components/schemas/MobileWallet"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"authCode":{"type":"string"},"status":{"$ref":"#/components/schemas/CardPaymentStatus"},"authOnly":{"type":"boolean"}},"required":["processor","authCode","status"],"title":"IPaymentMongooseTypesObjectIdCardInfo"},"IPaymentMongooseTypesObjectIdBankTransferInfo":{"type":"object","properties":{"reasonDescription":{"type":"string"},"reasonCode":{"type":"string"},"achAuthorizationId":{"type":"string","description":"The founding `AchAuthorization.paymentId` this debit belongs to, if this is a subsequent charge."},"reason":{"type":"string"},"token":{"type":"string"},"batchedAt":{"type":"string","format":"date-time"},"refundTransferId":{"type":"string"},"refundReview":{"type":"boolean"},"transaction":{"type":"string"},"processor":{"$ref":"#/components/schemas/AchProcessor"},"status":{"$ref":"#/components/schemas/AchPaymentStatus"}},"required":["refundReview","processor","status"],"title":"IPaymentMongooseTypesObjectIdBankTransferInfo"},"IPaymentMongooseTypesObjectIdPixInfo":{"type":"object","properties":{"reason":{"type":"string"},"processed":{"type":"string","format":"date-time"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"expiration":{"type":"string","format":"date-time"},"processor":{"$ref":"#/components/schemas/PixProcessor"},"status":{"$ref":"#/components/schemas/PixPaymentStatus"}},"required":["expiration","processor","status"],"title":"IPaymentMongooseTypesObjectIdPixInfo"},"IPaymentMongooseTypesObjectIdIbanInfo":{"type":"object","properties":{"reference":{"type":"string"},"failedAttempts":{"type":"array","items":{"$ref":"#/components/schemas/FailedIbanAttempt"}},"accountHolder":{"type":"string"},"reason":{"type":"string"},"transactionId":{"type":"string"},"processed":{"type":"string","format":"date-time"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"transaction":{"type":"string"},"expiration":{"type":"string","format":"date-time"},"token":{"type":"string"},"processor":{"$ref":"#/components/schemas/IbanProcessor"},"status":{"$ref":"#/components/schemas/IbanPaymentStatus"}},"required":["expiration","token","processor","status"],"title":"IPaymentMongooseTypesObjectIdIbanInfo"},"IPaymentMongooseTypesObjectIdCryptoInfo":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/CryptoTiers"},"paymentCurrency":{"type":"string"},"overpaymentAmount":{"type":"string"},"actualPaymentAmountUSD":{"type":"string"},"depositAddress":{"type":"string"},"refundAddress":{"type":"string"},"refundTransactionHash":{"type":"string"},"sessionId":{"type":"string"},"reason":{"type":"string"},"tokenLogoUrl":{"type":"string"},"blockchainLogoUrl":{"type":"string"},"tokenAmount":{"type":"string"},"token":{"type":"string"},"sponsoredTransactionHash":{"type":"string"},"originatingTransactionHash":{"type":"string"},"originatingWallet":{"type":"string"},"processed":{"type":"string","format":"date-time"},"transaction":{"type":"string"},"tokenSubtotal":{"$ref":"#/components/schemas/TokenSubtotal"},"status":{"$ref":"#/components/schemas/CryptoPaymentStatus"}},"required":["status"],"title":"IPaymentMongooseTypesObjectIdCryptoInfo"},"ISubscriptionMongooseTypesObjectIdCustomer":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/ICustomer_mongoose.Types.ObjectId_"}],"title":"ISubscriptionMongooseTypesObjectIdCustomer"},"ISubscriptionMongooseTypesObjectIdMerchant":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/IMerchant_mongoose.Types.ObjectId_"}],"title":"ISubscriptionMongooseTypesObjectIdMerchant"},"ISubscriptionPlanMongooseTypesObjectIdMerchant":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/IMerchant_mongoose.Types.ObjectId_"}],"title":"ISubscriptionPlanMongooseTypesObjectIdMerchant"},"ISubscriptionPlan_mongoose.Types.ObjectId_":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"merchant":{"$ref":"#/components/schemas/ISubscriptionPlanMongooseTypesObjectIdMerchant"},"name":{"type":"string"},"code":{"type":"string"},"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"duration":{"type":"integer","minimum":1,"description":"This represents the span of an interval.\nEx. duration = 3, interval = Monthly means every 3 months the subscription renews\nDefault is 1"},"amount":{"$ref":"#/components/schemas/CurrencyCents"},"description":{"type":"string"},"transaction":{"type":"string"},"settlementChain":{"$ref":"#/components/schemas/OperationalBlockchain"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"active":{"type":"boolean"},"merchantInitiated":{"type":"boolean","description":"If true this means we will not run it through our Subscription Payments Pipeline, but instead make the merchant pass us the plan code for MITs to process it"}},"required":["_id","merchant","name","code","interval","amount","active"],"title":"ISubscriptionPlan_mongoose.Types.ObjectId_"},"ISubscriptionMongooseTypesObjectIdPlan":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/ISubscriptionPlan_mongoose.Types.ObjectId_"}],"title":"ISubscriptionMongooseTypesObjectIdPlan"},"ISubscription_mongoose.Types.ObjectId_":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"customer":{"$ref":"#/components/schemas/ISubscriptionMongooseTypesObjectIdCustomer"},"merchant":{"$ref":"#/components/schemas/ISubscriptionMongooseTypesObjectIdMerchant"},"plan":{"$ref":"#/components/schemas/ISubscriptionMongooseTypesObjectIdPlan"},"cardProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"achProcessor":{"$ref":"#/components/schemas/AchProcessor"},"reference":{"type":"string"},"nextPaymentAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"marketplaceInfo":{"$ref":"#/components/schemas/Pick_MarketplaceInfo.fixedFee-or-feePercentage_"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"$ref":"#/components/schemas/SubscriptionVersion"}},"required":["_id","customer","merchant","plan","reference","status","createdAt","updatedAt","version"],"title":"ISubscription_mongoose.Types.ObjectId_"},"IPaymentMongooseTypesObjectIdSubscription":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/ISubscription_mongoose.Types.ObjectId_"}],"title":"IPaymentMongooseTypesObjectIdSubscription"},"IPaymentMongooseTypesObjectIdDestination":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/MultipleDestination"}],"title":"IPaymentMongooseTypesObjectIdDestination"},"IPaymentMongooseTypesObjectIdDelayedSettlement":{"type":"object","properties":{"disbursedAt":{"type":"string","format":"date-time"},"isDisbursed":{"type":"boolean"},"days":{"type":"number","format":"double"},"scheduledDate":{"type":"string","format":"date-time"},"isScheduled":{"type":"boolean"}},"required":["isDisbursed","days","scheduledDate","isScheduled"],"title":"IPaymentMongooseTypesObjectIdDelayedSettlement"},"IPaymentMongooseTypesObjectIdRefundInfo":{"type":"object","properties":{"count":{"type":"number","format":"double"},"refundedAt":{"type":"string","format":"date-time"},"amount":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["count","refundedAt","amount"],"title":"IPaymentMongooseTypesObjectIdRefundInfo"},"IPaymentMongooseTypesObjectIdUserLocation":{"type":"object","properties":{"resolvedState":{"type":"string"},"resolvedCountry":{"type":"string"},"lng":{"type":"number","format":"double"},"lat":{"type":"number","format":"double"}},"required":["lng","lat"],"description":"Browser-captured geolocation at the time of the request, when the caller\nsupplied one. Stored independently of payment method so the merchant\ndashboard can render a map for any purchase type. `resolved*` fields are\npopulated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee.","title":"IPaymentMongooseTypesObjectIdUserLocation"},"IPaymentMongooseTypesObjectIdVendorTransfer":{"type":"object","properties":{"external":{"type":"string"},"internal":{"type":"string"}},"required":["internal"],"title":"IPaymentMongooseTypesObjectIdVendorTransfer"},"IPayment_mongoose.Types.ObjectId_":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"paymentId":{"type":"string"},"paymentIntentId":{"type":"string"},"totals":{"$ref":"#/components/schemas/TotalsResponse"},"customer":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdCustomer"},"merchant":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdMerchant"},"chargebackProtectionDecision":{"$ref":"#/components/schemas/ChargebackProtectionDecision"},"liabilityOwner":{"$ref":"#/components/schemas/LiabilityOwner"},"overrideChargebackProtectionDecision":{"type":"boolean"},"chargebackProtectionAccountType":{"$ref":"#/components/schemas/ChargebackProtectionAccountType"},"doNotReviewChargebackProtection":{"type":"boolean"},"cart":{"$ref":"#/components/schemas/CartClassOmitted"},"sessionInfo":{"$ref":"#/components/schemas/SessionInfo"},"error":{"type":"string"},"signature":{"type":"string"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"createdAt":{"type":"string","format":"date-time"},"velocityDate":{"type":"string","format":"date-time","description":"Date when velocity check was done and used to bucket payments into velocity days\nShould match when a velocity hold was created if one was"},"cardInfo":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdCardInfo"},"bankTransferInfo":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdBankTransferInfo"},"pixInfo":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdPixInfo"},"ibanInfo":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdIbanInfo"},"wireInfo":{"$ref":"#/components/schemas/IWirePaymentInfo"},"cashAppInfo":{"$ref":"#/components/schemas/ICashAppPaymentInfo"},"paypalInfo":{"$ref":"#/components/schemas/IPayPalPaymentInfo"},"venmoInfo":{"$ref":"#/components/schemas/IVenmoPaymentInfo"},"apaInfo":{"$ref":"#/components/schemas/IApaPaymentInfo"},"interacInfo":{"$ref":"#/components/schemas/IInteracPaymentInfo"},"cryptoInfo":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdCryptoInfo"},"exchangeInfo":{"$ref":"#/components/schemas/ExchangeInfo"},"subscription":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdSubscription"},"settlementType":{"$ref":"#/components/schemas/SettlementType"},"blockchain":{"$ref":"#/components/schemas/OperationalBlockchain"},"wallet":{"type":"string"},"redemptionCheck":{"type":"boolean"},"marketplaceInfo":{"$ref":"#/components/schemas/MarketplaceInfo"},"destination":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdDestination"},"destinationSettlementToken":{"type":"string"},"overrideAuditLog":{"$ref":"#/components/schemas/OverrideAuditLog"},"customerUsdcTransferData":{"$ref":"#/components/schemas/CustomerUsdcTransferData"},"customerUsdcTransferDataV2":{"$ref":"#/components/schemas/CustomerUsdcTransferDataV2"},"delayedSettlement":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdDelayedSettlement"},"referrer":{"type":"string"},"alertStatus":{"$ref":"#/components/schemas/KytAlertStatus"},"refundInfo":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdRefundInfo"},"userLocation":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdUserLocation","description":"Browser-captured geolocation at the time of the request, when the caller\nsupplied one. Stored independently of payment method so the merchant\ndashboard can render a map for any purchase type. `resolved*` fields are\npopulated when the GEOLOCATION enforcement step happened to reverse-\ngeocode the coordinates — they're a free piggyback on the lock cache,\nnot a guarantee."},"entityTag":{"$ref":"#/components/schemas/EntityTag"},"vendorTransfer":{"$ref":"#/components/schemas/IPaymentMongooseTypesObjectIdVendorTransfer"},"feesInvoicedPeriod":{"type":"string"},"invoiceId":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"vendorInfo":{"$ref":"#/components/schemas/Record_string.string_"}},"required":["_id","paymentId","totals","customer","merchant","chargebackProtectionDecision","createdAt"],"title":"IPayment_mongoose.Types.ObjectId_"},"RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaPayment":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/IPayment_mongoose.Types.ObjectId_"}],"title":"RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaPayment"},"RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaMerchant":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/IMerchant_mongoose.Types.ObjectId_"}],"title":"RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaMerchant"},"RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaCustomer":{"oneOf":[{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},{"$ref":"#/components/schemas/ICustomer_mongoose.Types.ObjectId_"}],"title":"RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaCustomer"},"Refund_GetRefundViaPaymentId_Response_200":{"type":"object","properties":{"returnSignature":{"type":"string"},"walletDebitTxHash":{"type":"string"},"walletDebitStatus":{"$ref":"#/components/schemas/WalletDebitStatus"},"cryptoRefundInfo":{"$ref":"#/components/schemas/CryptoRefundInfo"},"failureReason":{"type":"string"},"refundedBy":{"$ref":"#/components/schemas/MerchantEditor"},"reason":{"$ref":"#/components/schemas/RefundReason"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"invoiceId":{"$ref":"#/components/schemas/mongoose.Types.ObjectId"},"invoicedAt":{"type":"string","format":"date-time"},"provider":{"type":"string"},"method":{"$ref":"#/components/schemas/RefundMethod"},"source":{"$ref":"#/components/schemas/RefundSource"},"outstanding":{"$ref":"#/components/schemas/CurrencyCents"},"reimbursementId":{"type":"string"},"reimbursementStatus":{"$ref":"#/components/schemas/ReimbursementStatus"},"status":{"$ref":"#/components/schemas/RefundStatus"},"signature":{"type":"string"},"payment":{"$ref":"#/components/schemas/RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaPayment"},"merchant":{"$ref":"#/components/schemas/RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaMerchant"},"customer":{"$ref":"#/components/schemas/RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaCustomer"},"totals":{"$ref":"#/components/schemas/RefundTotals"},"_id":{"type":"string"}},"required":["refundedBy","reason","updatedAt","createdAt","invoiceId","provider","method","source","outstanding","reimbursementStatus","status","payment","merchant","customer","totals","_id"],"title":"Refund_GetRefundViaPaymentId_Response_200"},"Industry":{"type":"string","enum":["cryptocurrency","educationTraining","foodBeverage","healthcareWellness","nonProfit","professionalServices","remittance","retailEcommerce","Sports / Recreation","supplements","sweepstakes","technologyDigitalServices","tradingCardPlatform","travelHospitality","other"],"title":"Industry"},"CreateSubmerchantBody":{"type":"object","properties":{"dba":{"type":"string"},"industry":{"$ref":"#/components/schemas/Industry"},"businessEmail":{"type":"string"},"billingEmail":{"type":"string"},"billingEmailSameAsBusinessEmail":{"type":"boolean"},"businessPhoneNumber":{"type":"string"},"businessPhoneCountryCode":{"type":"string"},"websiteUrls":{"type":"array","items":{"type":"string"}},"developmentUrls":{"type":"array","items":{"type":"string"}},"privacyPolicyUrl":{"type":"string"},"termsOfServiceUrl":{"type":"string"},"returnPolicyUrl":{"type":"string"},"payinMethods":{"type":"string"},"payoutMethods":{"type":"string"},"endUserJurisdictions":{"type":"string"},"merchantId":{"type":"string"},"email":{"type":"string"}},"required":["merchantId","email"],"title":"CreateSubmerchantBody"},"CreateSubmerchantResponse":{"type":"object","properties":{"products":{"type":"string"},"endUserJurisdictions":{"type":"string"},"payoutMethods":{"type":"string"},"payinMethods":{"type":"string"},"returnPolicyUrl":{"type":"string"},"termsOfServiceUrl":{"type":"string"},"privacyPolicyUrl":{"type":"string"},"developmentUrl5":{"type":"string"},"developmentUrl4":{"type":"string"},"developmentUrl3":{"type":"string"},"developmentUrl2":{"type":"string"},"developmentUrl":{"type":"string"},"websiteUrl5":{"type":"string"},"websiteUrl4":{"type":"string"},"websiteUrl3":{"type":"string"},"websiteUrl2":{"type":"string"},"websiteUrl":{"type":"string"},"businessPhoneCountryCode":{"type":"string"},"businessPhoneNumber":{"type":"string"},"billingEmail":{"type":"string"},"businessEmail":{"type":"string"},"industry":{"$ref":"#/components/schemas/Industry"},"dba":{"type":"string"},"email":{"type":"string"},"merchantId":{"type":"string"}},"required":["email","merchantId"],"title":"CreateSubmerchantResponse"},"SanitizedMerchantSettlementAddresses":{"type":"object","properties":{"solana":{"type":"string"},"eth":{"type":"string"},"polygon":{"type":"string"},"base":{"type":"string"},"user":{"type":"string"},"arbitrum":{"type":"string"},"stellar":{"type":"string"},"monad":{"type":"string"},"tempo":{"type":"string"}},"title":"SanitizedMerchantSettlementAddresses"},"SanitizedMerchantFirstPartyPayoutOverrides":{"type":"object","properties":{"interacPayoutProvider":{"$ref":"#/components/schemas/InteracPayoutProvider"},"wirePayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/WirePayoutProvider"}},"paypalPayoutProvider":{"$ref":"#/components/schemas/PayPalPayoutProvider"},"venmoPayoutProvider":{"$ref":"#/components/schemas/VenmoPayoutProvider"},"appleP2cPayoutProvider":{"$ref":"#/components/schemas/ApplePayPayoutProvider"},"globalP2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"p2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"eftPayoutProvider":{"$ref":"#/components/schemas/EftPayoutProvider"},"pixPayoutProvider":{"$ref":"#/components/schemas/PixPayoutProvider"},"rtpPayoutProvider":{"$ref":"#/components/schemas/RtpPayoutProvider"},"ibanPayoutProvider":{"$ref":"#/components/schemas/IbanPayoutProvider"},"bankPayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/PayoutProviderOption"}}},"title":"SanitizedMerchantFirstPartyPayoutOverrides","deprecated":true},"SanitizedMerchantCardSettings":{"type":"object","properties":{"statementDescriptor":{"type":"string"},"saveCardDefault":{"type":"boolean"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"googlePayProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"applePayProcessor":{"$ref":"#/components/schemas/PaymentProcessor"},"supportsApplePay":{"type":"boolean"},"supportsGooglePay":{"type":"boolean"},"tokenizationProvider":{"$ref":"#/components/schemas/TokenizationProviderOption"},"avsCheck":{"type":"boolean"},"debitOnly":{"type":"boolean"},"requiresKyc":{"type":"boolean"},"aftEnabled":{"type":"boolean"}},"required":["avsCheck","requiresKyc","aftEnabled"],"description":"From T, pick a set of properties whose keys are in the union K","title":"SanitizedMerchantCardSettings"},"Pick_ACHSettings.instantSettle-or-requireKycBeforePurchase_":{"type":"object","properties":{"instantSettle":{"type":"boolean"},"requireKycBeforePurchase":{"type":"boolean"}},"required":["instantSettle"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_ACHSettings.instantSettle-or-requireKycBeforePurchase_"},"Pick_Verification.status_":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/VerificationStatus"}},"required":["status"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_Verification.status_"},"SanitizedMerchant":{"type":"object","properties":{"_id":{"type":"string"},"merchantId":{"type":"string"},"brand":{"$ref":"#/components/schemas/MerchantBrandSettings"},"colors":{"$ref":"#/components/schemas/MerchantTheme"},"url":{"type":"string"},"supportEmail":{"type":"string"},"kycType":{"$ref":"#/components/schemas/KycType"},"settlementAddresses":{"$ref":"#/components/schemas/SanitizedMerchantSettlementAddresses"},"hideBranding":{"type":"boolean"},"onlyShowTotal":{"type":"boolean"},"pushToCardEnabled":{"type":"boolean","deprecated":true},"requireAniCheck":{"type":"boolean"},"bankPayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/PayoutProviderOption"}},"ibanPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/IbanPayoutProvider"}},"swiftPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/SwiftPayoutProvider"}},"ibanPayoutProvider":{"$ref":"#/components/schemas/IbanPayoutProvider"},"rtpPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/RtpPayoutProvider"}},"rtpPayoutProvider":{"$ref":"#/components/schemas/RtpPayoutProvider"},"pixPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/PixPayoutProvider"}},"pixPayoutProvider":{"$ref":"#/components/schemas/PixPayoutProvider"},"eftPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/EftPayoutProvider"}},"eftPayoutProvider":{"$ref":"#/components/schemas/EftPayoutProvider"},"p2cPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/CardPayoutProvider"}},"p2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"globalP2cPayoutProvider":{"$ref":"#/components/schemas/CardPayoutProvider"},"appleP2cPayoutProvider":{"$ref":"#/components/schemas/ApplePayPayoutProvider"},"venmoPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/VenmoPayoutProvider"}},"venmoPayoutProvider":{"$ref":"#/components/schemas/VenmoPayoutProvider"},"paypalPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/PayPalPayoutProvider"}},"paypalPayoutProvider":{"$ref":"#/components/schemas/PayPalPayoutProvider"},"wirePayoutProvider":{"type":"array","items":{"$ref":"#/components/schemas/WirePayoutProvider"}},"cryptoPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/CryptoPayoutProvider"}},"interacPayoutProviders":{"type":"array","items":{"$ref":"#/components/schemas/InteracPayoutProvider"}},"interacPayoutProvider":{"$ref":"#/components/schemas/InteracPayoutProvider"},"interacPaymentProvider":{"$ref":"#/components/schemas/InteracProcessor"},"interacSettings":{"$ref":"#/components/schemas/InteracSettings"},"firstPartyPayoutOverrides":{"$ref":"#/components/schemas/SanitizedMerchantFirstPartyPayoutOverrides","deprecated":true},"creditSeed":{"type":"string"},"enforceJwt":{"type":"boolean"},"enforceCheckoutJwt":{"type":"boolean"},"externalVerificationLinks":{"type":"boolean"},"whitelistedAncestorUrls":{"type":"array","items":{"type":"string"}},"enforceLivenessKyc":{"type":"boolean"},"kycMinAge":{"type":"number","format":"double"},"feePayerPublicKey":{"type":"string"},"solanaFeePayerPublicKey":{"type":"string"},"solanaUsdcPayerPublicKey":{"type":"string"},"evmFeePayerAddress":{"type":"string"},"evmUsdcPayerAddress":{"type":"string"},"stellarUsdcPayerPublicKey":{"type":"string"},"_sanitized":{"type":"boolean"},"parent":{"type":"string"},"customPayInFees":{"$ref":"#/components/schemas/CustomPayInFeesConfig"},"cardSettings":{"$ref":"#/components/schemas/SanitizedMerchantCardSettings"},"achSettings":{"$ref":"#/components/schemas/Pick_ACHSettings.instantSettle-or-requireKycBeforePurchase_"},"verification":{"$ref":"#/components/schemas/Pick_Verification.status_"},"canAcceptAch":{"type":"boolean"},"canAcceptWire":{"type":"boolean"},"minTransactionAmount":{"$ref":"#/components/schemas/Cents"},"maxTransactionAmount":{"$ref":"#/components/schemas/Cents"},"withdrawalGeolocationRequired":{"type":"boolean","description":"Authoritative: derived from the merchant's blockingRules. The frontend\nuses this to decide whether to prompt for geolocation; the backend\nenforces independently via the same rules."},"checkoutGeolocationRequired":{"type":"boolean"},"paypalRequireLogin":{"type":"boolean","description":"Authoritative: whether new PayPal payout accounts must be linked via Log in\nwith PayPal (derived from paypalSettings.requireLogin). The frontend uses\nthis to force the login flow; the backend enforces independently."},"paypalMerchantId":{"type":"string"},"paypalClientId":{"type":"string"}},"required":["_id","merchantId","kycType","hideBranding","onlyShowTotal","pushToCardEnabled","requireAniCheck","interacSettings","creditSeed","enforceJwt","feePayerPublicKey","solanaFeePayerPublicKey","solanaUsdcPayerPublicKey","evmFeePayerAddress","evmUsdcPayerAddress","stellarUsdcPayerPublicKey","_sanitized","cardSettings","achSettings","verification","canAcceptAch","canAcceptWire","withdrawalGeolocationRequired","checkoutGeolocationRequired","paypalRequireLogin"],"title":"SanitizedMerchant"},"SubMerchant_GetOnboardingToken_Response_200":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"title":"SubMerchant_GetOnboardingToken_Response_200"},"IsvSubmerchantFields":{"type":"object","properties":{"dba":{"type":"string"},"industry":{"$ref":"#/components/schemas/Industry"},"businessEmail":{"type":"string"},"billingEmail":{"type":"string"},"billingEmailSameAsBusinessEmail":{"type":"boolean"},"businessPhoneNumber":{"type":"string"},"businessPhoneCountryCode":{"type":"string"},"websiteUrls":{"type":"array","items":{"type":"string"}},"developmentUrls":{"type":"array","items":{"type":"string"}},"privacyPolicyUrl":{"type":"string"},"termsOfServiceUrl":{"type":"string"},"returnPolicyUrl":{"type":"string"},"payinMethods":{"type":"string"},"payoutMethods":{"type":"string"},"endUserJurisdictions":{"type":"string"}},"title":"IsvSubmerchantFields"},"PatchSubmerchantResponse":{"type":"object","properties":{"products":{"type":"string"},"endUserJurisdictions":{"type":"string"},"payoutMethods":{"type":"string"},"payinMethods":{"type":"string"},"returnPolicyUrl":{"type":"string"},"termsOfServiceUrl":{"type":"string"},"privacyPolicyUrl":{"type":"string"},"developmentUrl5":{"type":"string"},"developmentUrl4":{"type":"string"},"developmentUrl3":{"type":"string"},"developmentUrl2":{"type":"string"},"developmentUrl":{"type":"string"},"websiteUrl5":{"type":"string"},"websiteUrl4":{"type":"string"},"websiteUrl3":{"type":"string"},"websiteUrl2":{"type":"string"},"websiteUrl":{"type":"string"},"businessPhoneCountryCode":{"type":"string"},"businessPhoneNumber":{"type":"string"},"billingEmail":{"type":"string"},"businessEmail":{"type":"string"},"industry":{"$ref":"#/components/schemas/Industry"},"dba":{"type":"string"},"merchantId":{"type":"string"}},"required":["merchantId"],"title":"PatchSubmerchantResponse"},"SubscriptionAchSetup":{"type":"object","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"planCode":{"type":"string","description":"The code of the plan to use for the subscription"},"token":{"type":"string","description":"Token for the bank account to be used for the subscription"}},"required":["planCode","token"],"title":"SubscriptionAchSetup"},"SubscriptionTokenSetupAddress":{"type":"object","properties":{"country":{"type":"string","minLength":2,"maxLength":2},"state":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string","minLength":1},"address1":{"type":"string"}},"required":["country","city","address1"],"description":"The address field is not needed here unless explicitly given instructions to do so.","title":"SubscriptionTokenSetupAddress"},"SubscriptionTokenSetup":{"type":"object","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"planCode":{"type":"string","description":"The code of the plan to use for the subscription"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"token":{"type":"string","description":"Token for the card to be used for the subscription"},"address":{"$ref":"#/components/schemas/SubscriptionTokenSetupAddress","description":"The address field is not needed here unless explicitly given instructions to do so."}},"required":["planCode","token"],"title":"SubscriptionTokenSetup"},"SubscriptionCardSetupCard":{"oneOf":[{"$ref":"#/components/schemas/CardData"},{"$ref":"#/components/schemas/CardDataWithoutAddress"}],"description":"Credit card information.\n<b>Always</b> pass address unless explicitly told that you may not","title":"SubscriptionCardSetupCard"},"SubscriptionCardSetup":{"type":"object","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"webhookInfo":{"$ref":"#/components/schemas/AnyObject"},"chargebackProtectionData":{"$ref":"#/components/schemas/CartClassOmitted"},"feePercentage":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is\ntaken from the subtotal amount."},"fixedFee":{"$ref":"#/components/schemas/Cents"},"planCode":{"type":"string","description":"The code of the plan to use for the subscription"},"authentication3DS":{"$ref":"#/components/schemas/Authentication3DS"},"threeDsChallengePreference":{"$ref":"#/components/schemas/ThreeDsChallengePreference"},"accountFundingTransaction":{"$ref":"#/components/schemas/AccountFundingTransaction"},"card":{"$ref":"#/components/schemas/SubscriptionCardSetupCard","description":"Credit card information.\n<b>Always</b> pass address unless explicitly told that you may not"}},"required":["planCode","card"],"title":"SubscriptionCardSetup"},"Utilities_GetContractAddresses_Response_200":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"],"title":"Utilities_GetContractAddresses_Response_200"},"SendTransactionBody":{"type":"object","properties":{"confirm":{"type":"boolean","description":"(Default: false)\n\nSolana transactions after submission need to be confirmed as having been\npicked up by the network. State such as balance changes will not reflect until the transaction has been confirmed.\nAdditionally, errors such as invalid signers, insufficient gas, and network congestion can lead to the transaction being dropped.\n\nThe most ideal solution to this is for you to implement your own client side confirmation logic with the Solana SDK,\nhowever we understand that is complex and not every merchant wants to do that.\n\nSetting this property to true will mean the call will not return with your signature, until the solana transaction\nhas been confirmed. If the transaction is unable to be confirmed by the time the blockhash expires, then you wil receive a 503 error."},"merchantId":{"type":"string","description":"Merchant ID associated with the transaction"},"signedTransaction":{"type":"string","description":"The message which has already been signed by the user and Coinflow."}},"required":["merchantId","signedTransaction"],"title":"SendTransactionBody"},"Utilities_SendCoinflowTransaction_Response_200":{"type":"object","properties":{"signature":{"type":"string"}},"required":["signature"],"title":"Utilities_SendCoinflowTransaction_Response_200"},"SendCoinflowTransactionRequestPreconditionFailedError":{"type":"object","properties":{"logs":{"type":"string"}},"required":["logs"],"title":"SendCoinflowTransactionRequestPreconditionFailedError"},"SendSolanaTransactionRequest":{"type":"object","properties":{"confirm":{"type":"boolean","description":"(Default: false)\n\nSolana transactions after submission need to be confirmed as having been\npicked up by the network. State such as balance changes will not reflect until the transaction has been confirmed.\nAdditionally, errors such as invalid signers, insufficient gas, and network congestion can lead to the transaction being dropped.\n\nThe most ideal solution to this is for you to implement your own client side confirmation logic with the Solana SDK,\nhowever we understand that is complex and not every merchant wants to do that.\n\nSetting this property to true will mean the call will not return with your signature, until the solana transaction\nhas been confirmed. If the transaction is unable to be confirmed by the time the blockhash expires, then you wil receive a 503 error."},"transaction":{"type":"string","description":"Base 58 encoded Solana Transaction. Supports Transctions and VersionedTransactions.\nTransaction must be signed by all signers."}},"required":["transaction"],"title":"SendSolanaTransactionRequest"},"SendSolanaTransactionResponse":{"type":"object","properties":{"signature":{"type":"string","description":"To confirm that this transaction was successful call `connection.confirmTransaction(signature)`\nwhich will query the chain to see if the transaction was confirmed."}},"required":["signature"],"title":"SendSolanaTransactionResponse"},"SendSolanaTransactionRequestPreconditionFailedError":{"type":"object","properties":{"logs":{"type":"string"}},"required":["logs"],"title":"SendSolanaTransactionRequestPreconditionFailedError"},"AddInteracArgs":{"type":"object","properties":{"phoneNumber":{"type":"string","pattern":"^\\d{10}$","description":"Phone number (US Only) unformatted 10 digits long, no leading 1 for US country code."},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"merchantId":{"type":"string"}},"title":"AddInteracArgs"},"AddBankAccountArgsType":{"type":"string","enum":["checking","savings"],"title":"AddBankAccountArgsType"},"IAccountAddress":{"type":"object","properties":{"address1":{"type":"string","minLength":1},"city":{"type":"string","minLength":1},"state":{"type":"string","minLength":2},"zip":{"type":"string"}},"required":["address1","city","state","zip"],"description":"If address is not available on the user's KYC,the endpoint will return a 412\nerror and the request must be retried with the user's address information.","title":"IAccountAddress"},"AddBankAccountArgs":{"type":"object","properties":{"alias":{"type":"string"},"routingNumber":{"type":"string"},"accountNumber":{"type":"string"},"wireRoutingNumber":{"type":"string"},"type":{"$ref":"#/components/schemas/AddBankAccountArgsType"},"address":{"$ref":"#/components/schemas/IAccountAddress"}},"required":["alias","routingNumber","accountNumber","type"],"title":"AddBankAccountArgs"},"IWithdrawerWithAccountsMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IWithdrawerWithAccountsMerchant"},"IWithdrawerCardAccount":{"type":"object","properties":{"last4":{"type":"string"},"isDeleted":{"type":"boolean"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/CardType"},"disbursementStatus":{"$ref":"#/components/schemas/DisbursementStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"nameOnCard":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"expMonth":{"type":"string"},"expYear":{"type":"string"}},"required":["last4","token","type","disbursementStatus","createdAt"],"title":"IWithdrawerCardAccount"},"Pick_IEftAccount.Exclude_keyofIEftAccount.vendorData__":{"type":"object","properties":{"accountHash":{"type":"string"},"isDeleted":{"type":"boolean"},"accountNumber":{"type":"string"},"alias":{"type":"string"},"token":{"type":"string"},"reference":{"type":"string"},"mask":{"type":"string"},"institutionId":{"type":"string"},"institution":{"type":"string"},"transit_number":{"type":"string"}},"required":["accountHash","alias","token","reference","mask"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_IEftAccount.Exclude_keyofIEftAccount.vendorData__"},"IWithdrawerMobileAccountType":{"type":"string","enum":["mobile"],"title":"IWithdrawerMobileAccountType"},"IWithdrawerMobileAccount":{"type":"object","properties":{"alias":{"type":"string"},"token":{"type":"string"},"type":{"$ref":"#/components/schemas/IWithdrawerMobileAccountType"},"disbursementStatus":{"$ref":"#/components/schemas/DisbursementStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"genus":{"$ref":"#/components/schemas/MobileGenus"},"deletedAt":{"type":"string","format":"date-time"},"expMonth":{"type":"string"},"expYear":{"type":"string"}},"required":["alias","token","type","genus"],"title":"IWithdrawerMobileAccount"},"IWithdrawerWithAccounts":{"type":"object","properties":{"_id":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallets":{"type":"array","items":{"$ref":"#/components/schemas/IWallet"}},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"currency":{"$ref":"#/components/schemas/Currency"},"originalCurrency":{"$ref":"#/components/schemas/WithdrawCurrency"},"merchant":{"$ref":"#/components/schemas/IWithdrawerWithAccountsMerchant"},"verification":{"$ref":"#/components/schemas/Verification"},"riskScoreOverride":{"type":"boolean"},"country":{"type":"string"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockCardReuseExempt":{"type":"boolean","description":"When true, this withdrawer is exempt from the merchant\n`banDuplicateAccounts` re-use check, so it may add an account that another\nwithdrawer already uses without being blocked (423 `PAYMENT_METHOD_IN_USE`)."},"createdAt":{"type":"string","format":"date-time"},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IBankAccount.Exclude_keyofIBankAccount.vendorData-or-accountOwnerNames-or-nameMatchStatus__"}},"cards":{"type":"array","items":{"$ref":"#/components/schemas/IWithdrawerCardAccount"}},"ibans":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__"}},"swifts":{"type":"array","items":{"$ref":"#/components/schemas/ISwiftAccount"}},"pixes":{"type":"array","items":{"$ref":"#/components/schemas/IPixAccount"}},"efts":{"type":"array","items":{"$ref":"#/components/schemas/Pick_IEftAccount.Exclude_keyofIEftAccount.vendorData__"}},"venmo":{"$ref":"#/components/schemas/Pick_IVenmo.Exclude_keyofIVenmo.vendorData__"},"paypal":{"$ref":"#/components/schemas/Pick_IPayPal.Exclude_keyofIPayPal.vendorData__"},"interac":{"$ref":"#/components/schemas/Pick_IInterac.Exclude_keyofIInterac.vendorData__"},"mobiles":{"type":"array","items":{"$ref":"#/components/schemas/IWithdrawerMobileAccount"}},"p2cAvailable":{"type":"boolean"},"applePayAvailable":{"type":"boolean"},"bankCurrencyOptions":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"freeWithdrawSpeeds":{"type":"array","items":{"$ref":"#/components/schemas/WithdrawSpeed"}}},"required":["_id","wallet","blockchain","wallets","email","availability","currency","merchant","verification","riskScoreOverride","country","bankAccounts","cards","ibans","swifts","pixes","efts","mobiles","p2cAvailable","applePayAvailable","bankCurrencyOptions","freeWithdrawSpeeds"],"title":"IWithdrawerWithAccounts"},"AddWithdrawMethodResponse":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"AddWithdrawMethodResponse"},"AddBankAccountV2ArgsType":{"type":"string","enum":["checking","savings"],"title":"AddBankAccountV2ArgsType"},"AddBankAccountV2Args":{"type":"object","properties":{"alias":{"type":"string"},"routingNumber":{"type":"string"},"accountNumber":{"type":"string"},"wireRoutingNumber":{"type":"string"},"type":{"$ref":"#/components/schemas/AddBankAccountV2ArgsType"},"address":{"$ref":"#/components/schemas/IAccountAddress"},"name":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["alias","routingNumber","accountNumber","type"],"title":"AddBankAccountV2Args"},"AddDebitCardArgsAdditionalVendorData":{"type":"object","properties":{},"description":"Optional non-PCI passthrough fields merged into the stored card vendorData.\nBase type is empty; tokenization providers extend it with their own fields.","title":"AddDebitCardArgsAdditionalVendorData"},"AddDebitCardArgs":{"type":"object","properties":{"expYear":{"type":"string","pattern":"^\\d+$","minLength":2,"maxLength":2,"description":"The Cards Expiration Year ex: 2026 => 26"},"expMonth":{"type":"string","pattern":"^\\d+$","minLength":2,"maxLength":2,"description":"The Cards Expiration Month ex: January => 01 December => 12"},"additionalVendorData":{"$ref":"#/components/schemas/AddDebitCardArgsAdditionalVendorData","description":"Optional non-PCI passthrough fields merged into the stored card vendorData.\nBase type is empty; tokenization providers extend it with their own fields."},"cardToken":{"type":"string","minLength":1,"description":"This is the card token received from the `CoinflowCardOnlyInput`"},"address":{"$ref":"#/components/schemas/IAccountAddress"},"merchantId":{"type":"string"}},"required":["expYear","expMonth","cardToken"],"title":"AddDebitCardArgs"},"AddEftAccountArgs":{"type":"object","properties":{"alias":{"type":"string"},"institutionNumber":{"type":"string","pattern":"^\\d{3}$","description":"Canadian 3-digit institution number"},"transitNumber":{"type":"string","pattern":"^\\d{5}$","description":"Canadian 5-digit transit number"},"accountNumber":{"type":"string","pattern":"^\\d{7,12}$","description":"Canadian bank account number (7-12 digits)"},"type":{"$ref":"#/components/schemas/BankAccountType"},"firstName":{"type":"string"},"lastName":{"type":"string"},"name":{"type":"string"}},"required":["institutionNumber","transitNumber","accountNumber","type"],"title":"AddEftAccountArgs"},"IbanAccountData":{"type":"object","properties":{"number":{"type":"string","description":"The IBAN number or in the case of the UK the 8-digit account number"},"sortCode":{"type":"string","description":"Only used for the UK, the 6-digit sort code"},"bic":{"type":"string","description":"Only used for the Sepa, the bank identifier code - required when requested"},"accountHolder":{"type":"string","description":"The account holder name registered with the bank - required when requested\n(e.g. when a Verification of Payee check needs the exact name)"},"alias":{"type":"string"}},"required":["number"],"title":"IbanAccountData"},"SwiftAccountDataIntermediaryBank":{"type":"object","properties":{"bankAddress":{"$ref":"#/components/schemas/Address"},"bankName":{"type":"string"},"swiftCode":{"type":"string"}},"required":["bankAddress","bankName","swiftCode"],"title":"SwiftAccountDataIntermediaryBank"},"SwiftAccountData":{"type":"object","properties":{"alias":{"type":"string"},"accountNumber":{"type":"string"},"swiftCode":{"type":"string"},"beneficiaryBankName":{"type":"string"},"beneficiaryBankAddress":{"$ref":"#/components/schemas/Address"},"intermediaryBank":{"$ref":"#/components/schemas/SwiftAccountDataIntermediaryBank"}},"required":["accountNumber","swiftCode","beneficiaryBankName","beneficiaryBankAddress"],"title":"SwiftAccountData"},"GetWithdrawTransactionRequestBodyAccount":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ApplePayPayment"},{"$ref":"#/components/schemas/DelegatedCryptoDestination"}],"description":"One of:\n1. The token of the bank account/card that the user is withdrawing to\n2. An Apple Pay Response Object\n3. For `speed: \"crypto\"`: the on-chain destination to deliver to","title":"GetWithdrawTransactionRequestBodyAccount"},"Pick_WithdrawToken.mint-or-decimals_":{"type":"object","properties":{"mint":{"type":"string","description":"The mint is the address of the token on the blockchain.\nOn Solana this is the mint account ID\nOn EVM chains this is the token contract address."},"decimals":{"type":"number","format":"double","description":"The number of decimals that the token has.\n\nFor example USDC is always 6 decimals, so 1 USDC is 1000000 units.\nSOL - 9 decimals\nWETH - 18 decimals."}},"required":["mint","decimals"],"description":"From T, pick a set of properties whose keys are in the union K","title":"Pick_WithdrawToken.mint-or-decimals_"},"EvmTransferAuthorizationData":{"type":"object","properties":{"data":{"type":"string","description":"The result of the signedTypedData call from the user's wallet."}},"required":["data"],"title":"EvmTransferAuthorizationData"},"BankAccountConfirmationDetails":{"type":"object","properties":{"accountNumber":{"type":"string"},"wireRoutingNumber":{"type":"string"}},"title":"BankAccountConfirmationDetails"},"AddressOptionalState":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["address1","city","zip","country"],"title":"AddressOptionalState"},"GetWithdrawTransactionRequestBody":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"merchantId":{"type":"string"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"account":{"$ref":"#/components/schemas/GetWithdrawTransactionRequestBodyAccount","description":"One of:\n1. The token of the bank account/card that the user is withdrawing to\n2. An Apple Pay Response Object\n3. For `speed: \"crypto\"`: the on-chain destination to deliver to"},"token":{"$ref":"#/components/schemas/Pick_WithdrawToken.mint-or-decimals_"},"evmTransferAuthorizationData":{"$ref":"#/components/schemas/EvmTransferAuthorizationData"},"bankAccountDetails":{"$ref":"#/components/schemas/BankAccountConfirmationDetails"},"address":{"$ref":"#/components/schemas/AddressOptionalState"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"minUsdc":{"$ref":"#/components/schemas/Cents"},"ownerOverride":{"type":"string","description":"For Solana currency token transactions, the public key of the wallet owner that will sign\nthe transaction. This will replace the public key associated with the user wallet."}},"required":["amount","merchantId","speed","account"],"title":"GetWithdrawTransactionRequestBody"},"GetTransactionRequestUnavailableForLegalReasonsError":{"type":"object","properties":{"verificationLink":{"type":"string"},"message":{"type":"string"}},"required":["verificationLink","message"],"title":"GetTransactionRequestUnavailableForLegalReasonsError"},"Withdraw_DeleteWithdrawerAccount_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteWithdrawerAccount_Response_200"},"Withdraw_DeleteWithdrawerCard_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteWithdrawerCard_Response_200"},"Withdraw_DeleteEftAccount_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteEftAccount_Response_200"},"Withdraw_DeleteIbanAccount_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteIbanAccount_Response_200"},"Withdraw_DeleteWithdrawerInterac_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteWithdrawerInterac_Response_200"},"Withdraw_DeleteWithdrawerMobile_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteWithdrawerMobile_Response_200"},"Withdraw_DeleteWithdrawerPaypal_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteWithdrawerPaypal_Response_200"},"Withdraw_DeletePixAccount_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeletePixAccount_Response_200"},"Withdraw_DeleteSwiftAccount_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteSwiftAccount_Response_200"},"Withdraw_DeleteWithdrawerVenmo_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"Withdraw_DeleteWithdrawerVenmo_Response_200"},"WithdrawToken":{"type":"object","properties":{"mint":{"type":"string","description":"The mint is the address of the token on the blockchain.\nOn Solana this is the mint account ID\nOn EVM chains this is the token contract address."},"decimals":{"type":"number","format":"double","description":"The number of decimals that the token has.\n\nFor example USDC is always 6 decimals, so 1 USDC is 1000000 units.\nSOL - 9 decimals\nWETH - 18 decimals."},"balance":{"type":"number","format":"double"},"icon":{"type":"string"},"name":{"type":"string"},"symbol":{"type":"string"},"isStablecoin":{"type":"boolean"},"stablecoinCurrency":{"$ref":"#/components/schemas/Currency"}},"required":["mint","decimals","balance","name","symbol","isStablecoin"],"title":"WithdrawToken"},"Withdraw_GetWithdrawBalances_Response_200":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/WithdrawToken"}}},"required":["balances"],"title":"Withdraw_GetWithdrawBalances_Response_200"},"GetWithdrawMessageBody":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"token":{"$ref":"#/components/schemas/Pick_WithdrawToken.mint-or-decimals_"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"}},"required":["amount"],"title":"GetWithdrawMessageBody"},"GetMessageResponse":{"type":"object","properties":{"message":{"type":["string","null"],"description":"The message that needs to be typed signed by the user's EVM wallet."}},"required":["message"],"title":"GetMessageResponse"},"WithdrawQuote":{"type":"object","properties":{"asap":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"same_day":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"standard":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"card":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"iban":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"pix":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"eft":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"venmo":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"paypal":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"wire":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"interac":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"swift":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"crypto":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"},"quote":{"$ref":"#/components/schemas/CurrencyCents"},"gasFees":{"$ref":"#/components/schemas/GasFeeEstimate"},"swapFees":{"$ref":"#/components/schemas/CurrencyCents"}},"required":["asap","same_day","standard","card","iban","pix","eft","venmo","paypal","wire","interac","swift","crypto","quote"],"description":"Represents a withdrawal quote with detailed information on fees and limits for different withdrawal speeds.","title":"WithdrawQuote"},"WithdrawExactOutQuote":{"type":"object","properties":{"inputAmount":{"type":"number","format":"double"},"exactAmountOut":{"$ref":"#/components/schemas/CurrencyCents"},"quote":{"$ref":"#/components/schemas/WithdrawQuoteFeesAndLimit"}},"required":["inputAmount","exactAmountOut","quote"],"description":"The result of a destination-amount (\"reverse\" / exact-out) withdraw quote.\n\nGiven a target fiat payout (`exactAmountOut`), this reports how much of the\ninput token the merchant needs to send so that — after swap, gas, and\nwithdraw fees — the withdrawer nets at least the requested payout.","title":"WithdrawExactOutQuote"},"Record_WithdrawSpeed.WithdrawExactOutQuote-or-undefined_":{"type":"object","properties":{"asap":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"same_day":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"standard":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"card":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"iban":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"pix":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"eft":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"venmo":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"paypal":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"wire":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"interac":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"swift":{"$ref":"#/components/schemas/WithdrawExactOutQuote"},"crypto":{"$ref":"#/components/schemas/WithdrawExactOutQuote"}},"required":["asap","same_day","standard","card","iban","pix","eft","venmo","paypal","wire","interac","swift","crypto"],"description":"Construct a type with a set of properties K of type T","title":"Record_WithdrawSpeed.WithdrawExactOutQuote-or-undefined_"},"GetWithdrawerResponse":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IWithdrawerWithAccounts"}},"required":["withdrawer"],"title":"GetWithdrawerResponse"},"WithdrawerVerificationRequiredResponse":{"type":"object","properties":{"verification":{"$ref":"#/components/schemas/Verification"},"verificationLink":{"type":"string","description":"Link which can be hosted in an iframe or redirect the user to complete verification."},"redirectLink":{"type":"string","description":"Link where the user will be redirected to upon successful verification."},"additionalVerificationLinks":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalVerification"},"description":"Additional links which can be hosted in an iframe or redirect the user to complete verification."},"rejectionReasons":{"type":"array","items":{"type":"string"},"description":"List of reasons as to why the verification was rejected."},"withdrawer":{"$ref":"#/components/schemas/IWithdrawer"}},"required":["verification","withdrawer"],"title":"WithdrawerVerificationRequiredResponse"},"Withdraw_GetWithdrawerHistory_Response_200":{"type":"object","properties":{"withdraws":{"type":"array","items":{"$ref":"#/components/schemas/IWithdraw"}}},"required":["withdraws"],"title":"Withdraw_GetWithdrawerHistory_Response_200"},"AddApplePayArgs":{"type":"object","properties":{"applePayPayment":{"$ref":"#/components/schemas/ApplePayPayment"},"merchantId":{"type":"string"}},"required":["applePayPayment"],"title":"AddApplePayArgs"},"AddPaypalArgs":{"type":"object","properties":{"phoneNumber":{"type":"string","pattern":"^\\d{10}$","description":"Phone number (US Only) unformatted 10 digits long, no leading 1 for US country code."},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"merchantId":{"type":"string"}},"title":"AddPaypalArgs"},"AddVenmoArgs":{"type":"object","properties":{"phoneNumber":{"type":"string","pattern":"^\\d{10}$","description":"Phone number (US Only) unformatted 10 digits long, no leading 1 for US country code."},"merchantId":{"type":"string"}},"required":["phoneNumber"],"title":"AddVenmoArgs"},"PaypalLoginStatus":{"type":"string","enum":["pending","linked","error","cancelled"],"description":"States of a single Log in with PayPal attempt. `cancelled` is a distinct\nterminal state for when the withdrawer declines consent on PayPal (no code to\nexchange) — the widget returns quietly to the methods screen rather than\nshowing a linking-failed error.","title":"PaypalLoginStatus"},"Withdraw_GetPaypalLoginStatus_Response_200":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PaypalLoginStatus"}},"required":["status"],"title":"Withdraw_GetPaypalLoginStatus_Response_200"},"KybDocVRequestBodyAdditionalWalletsItems":{"type":"object","properties":{"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallet":{"type":"string"}},"required":["blockchain","wallet"],"title":"KybDocVRequestBodyAdditionalWalletsItems"},"KybDocVRequestBody":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant the business is interacting with"},"additionalWallets":{"type":"array","items":{"$ref":"#/components/schemas/KybDocVRequestBodyAdditionalWalletsItems"},"description":"Additional wallets to add to the newly created users KYC record"},"redirectLink":{"type":"string","description":"(optional): The URL to which the user will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller\nto direct the user to verificationLink first."},"country":{"type":"string"},"email":{"type":"string"}},"required":["merchantId","country","email"],"title":"KybDocVRequestBody"},"KybPassiveRequestBodyAdditionalWalletsItems":{"type":"object","properties":{"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallet":{"type":"string"}},"required":["blockchain","wallet"],"title":"KybPassiveRequestBodyAdditionalWalletsItems"},"KybPassiveRequestBody":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant the business is interacting with"},"additionalWallets":{"type":"array","items":{"$ref":"#/components/schemas/KybPassiveRequestBodyAdditionalWalletsItems"},"description":"Additional wallets to add to the newly created users KYC record"},"redirectLink":{"type":"string","description":"(optional): The URL to which the user will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller\nto direct the user to verificationLink first."},"info":{"$ref":"#/components/schemas/KybInformation"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboInfo"}}},"required":["merchantId","info"],"title":"KybPassiveRequestBody"},"KybRequestBody":{"oneOf":[{"$ref":"#/components/schemas/KybDocVRequestBody"},{"$ref":"#/components/schemas/KybPassiveRequestBody"}],"title":"KybRequestBody"},"IBackwardBusinessMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IBackwardBusinessMerchant"},"IBackwardBusiness":{"type":"object","properties":{"_id":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallets":{"type":"array","items":{"$ref":"#/components/schemas/IWallet"}},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"currency":{"$ref":"#/components/schemas/Currency"},"originalCurrency":{"$ref":"#/components/schemas/WithdrawCurrency"},"merchant":{"$ref":"#/components/schemas/IBackwardBusinessMerchant"},"verification":{"$ref":"#/components/schemas/Verification"},"riskScoreOverride":{"type":"boolean"},"country":{"type":"string"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockCardReuseExempt":{"type":"boolean","description":"When true, this withdrawer is exempt from the merchant\n`banDuplicateAccounts` re-use check, so it may add an account that another\nwithdrawer already uses without being blocked (423 `PAYMENT_METHOD_IN_USE`)."},"createdAt":{"type":"string","format":"date-time"},"business":{"type":"boolean"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboEntry"}}},"required":["_id","wallet","blockchain","wallets","email","availability","currency","merchant","verification","riskScoreOverride","country","business","ubos"],"title":"IBackwardBusiness"},"Withdraw_CreateKyb_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IBackwardBusiness"}},"required":["withdrawer"],"title":"Withdraw_CreateKyb_Response_200"},"KycUsRequestBody":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant the withdrawer is interacting with"},"redirectLink":{"type":"string","description":"(optional): The URL to which the user will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller\nto direct the user to verificationLink first."},"info":{"$ref":"#/components/schemas/KycUserInformation"}},"required":["info"],"title":"KycUsRequestBody"},"KycDocVRequestBody":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant the withdrawer is interacting with"},"redirectLink":{"type":"string","description":"(optional): The URL to which the user will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller\nto direct the user to verificationLink first."},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"country":{"type":"string","pattern":"^[A-Z,a-z]{2}$","minLength":2,"maxLength":2,"description":"Country of the user (ISO 3166-1 alpha-2)"}},"required":["email","country"],"title":"KycDocVRequestBody"},"KycRequestBody":{"oneOf":[{"$ref":"#/components/schemas/KycUsRequestBody"},{"$ref":"#/components/schemas/KycDocVRequestBody"}],"title":"KycRequestBody"},"IBackwardUserMerchant":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/IMerchant_string_"}],"title":"IBackwardUserMerchant"},"IBackwardUser":{"type":"object","properties":{"_id":{"type":"string"},"wallet":{"type":"string"},"blockchain":{"$ref":"#/components/schemas/Blockchain"},"wallets":{"type":"array","items":{"$ref":"#/components/schemas/IWallet"}},"email":{"type":"string"},"availability":{"$ref":"#/components/schemas/IAvailability"},"currency":{"$ref":"#/components/schemas/Currency"},"originalCurrency":{"$ref":"#/components/schemas/WithdrawCurrency"},"merchant":{"$ref":"#/components/schemas/IBackwardUserMerchant"},"verification":{"$ref":"#/components/schemas/Verification"},"riskScoreOverride":{"type":"boolean"},"country":{"type":"string"},"geoBlockOverride":{"$ref":"#/components/schemas/IGeoBlockOverride"},"blockCardReuseExempt":{"type":"boolean","description":"When true, this withdrawer is exempt from the merchant\n`banDuplicateAccounts` re-use check, so it may add an account that another\nwithdrawer already uses without being blocked (423 `PAYMENT_METHOD_IN_USE`)."},"createdAt":{"type":"string","format":"date-time"},"user":{"type":"boolean"},"dwolla":{"$ref":"#/components/schemas/DwollaWithdrawerInfo"},"watchlistExempt":{"$ref":"#/components/schemas/WatchlistStatus"},"watchlistId":{"type":"string"}},"required":["_id","wallet","blockchain","wallets","email","availability","currency","merchant","verification","riskScoreOverride","country","user","watchlistExempt"],"title":"IBackwardUser"},"Withdraw_CreateKyc_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IBackwardUser"}},"required":["withdrawer"],"title":"Withdraw_CreateKyc_Response_200"},"AttestedKycRequest":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country codes"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"},"firstName":{"type":"string","minLength":1},"surName":{"type":"string","minLength":1},"physicalAddress":{"type":"string","minLength":1},"city":{"type":"string","minLength":1},"state":{"type":"string","minLength":2},"zip":{"type":"string"},"dob":{"type":"string","pattern":"^\\d{4}[-/]?(\\d{2}[-/]?){2}$","description":"Date of birth in YYYYMMDD format"},"ssn":{"type":"string","pattern":"^\\d{4}$","description":"4 Digit SSN"}},"required":["country","email","firstName","surName","physicalAddress","city","state","zip","dob"],"title":"AttestedKycRequest"},"Withdraw_CreateKycAttested_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IBackwardUser"}},"required":["withdrawer"],"title":"Withdraw_CreateKycAttested_Response_200"},"Withdraw_CreateKycDocument_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IBackwardUser"}},"required":["withdrawer"],"title":"Withdraw_CreateKycDocument_Response_200"},"KycSumbsubShareTokenRequestBodyVendor":{"type":"string","enum":["sumsub","sumsub_docv"],"title":"KycSumbsubShareTokenRequestBodyVendor"},"KycSumbsubShareTokenRequestBody":{"type":"object","properties":{"vendor":{"$ref":"#/components/schemas/KycSumbsubShareTokenRequestBodyVendor"},"shareToken":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z,a-z]{2}$","minLength":2,"maxLength":2,"description":"Country of the user (ISO 3166-1 alpha-2)"},"redirectLink":{"type":"string","description":"(optional): The URL to which the user will be redirected after\nsuccessfully completing verification via verificationLink. This applies\nwhen the API responds with a 451 status code, instructing the caller\nto direct the user to verificationLink first."},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"}},"required":["vendor","shareToken","country","email"],"title":"KycSumbsubShareTokenRequestBody"},"KycPersonaShareTokenRequestBodyVendor":{"type":"string","enum":["persona"],"title":"KycPersonaShareTokenRequestBodyVendor"},"KycPersonaShareTokenRequestBody":{"type":"object","properties":{"vendor":{"$ref":"#/components/schemas/KycPersonaShareTokenRequestBodyVendor"},"shareToken":{"type":"string"},"email":{"type":"string","pattern":"(([^<>()[\\]\\\\.,;:\\s@\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))"}},"required":["vendor","shareToken","email"],"title":"KycPersonaShareTokenRequestBody"},"KycShareTokenBody":{"oneOf":[{"$ref":"#/components/schemas/KycSumbsubShareTokenRequestBody"},{"$ref":"#/components/schemas/KycPersonaShareTokenRequestBody"}],"title":"KycShareTokenBody"},"Withdraw_CreateKycShareToken_Response_200":{"type":"object","properties":{"withdrawer":{"$ref":"#/components/schemas/IBackwardUser"}},"required":["withdrawer"],"title":"Withdraw_CreateKycShareToken_Response_200"},"SendEvmWithdrawTransactionBodyAccount":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/ApplePayPayment"},{"$ref":"#/components/schemas/DelegatedCryptoDestination"}],"description":"One of:\n1. The token of the bank account/card that the user is withdrawing to\n2. An Apple Pay Response Object\n3. For `speed: \"crypto\"`: the on-chain destination to deliver to","title":"SendEvmWithdrawTransactionBodyAccount"},"SendEvmWithdrawTransactionBody":{"type":"object","properties":{"merchantId":{"type":"string"},"token":{"$ref":"#/components/schemas/Pick_WithdrawToken.mint-or-decimals_"},"amount":{"type":"number","format":"double"},"speed":{"$ref":"#/components/schemas/WithdrawSpeed"},"account":{"$ref":"#/components/schemas/SendEvmWithdrawTransactionBodyAccount","description":"One of:\n1. The token of the bank account/card that the user is withdrawing to\n2. An Apple Pay Response Object\n3. For `speed: \"crypto\"`: the on-chain destination to deliver to"},"evmTransferAuthorizationData":{"$ref":"#/components/schemas/EvmTransferAuthorizationData"},"bankAccountDetails":{"$ref":"#/components/schemas/BankAccountConfirmationDetails"},"userLocation":{"$ref":"#/components/schemas/IUserLocation"},"address":{"$ref":"#/components/schemas/AddressOptionalState"}},"required":["merchantId","token","amount","speed","account","evmTransferAuthorizationData"],"description":"Make all properties in T required","title":"SendEvmWithdrawTransactionBody"},"Withdraw_SendEvmGaslessTransaction_Response_200":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"],"title":"Withdraw_SendEvmGaslessTransaction_Response_200"},"StartPaypalLoginArgs":{"type":"object","properties":{"returnUrl":{"type":"string","description":"Headless (API) flow: the merchant page to send the withdrawer back to once\nlinking completes. PayPal returns to Coinflow's own fixed handler, which\nthen redirects the browser here. Must be one of the merchant's whitelisted\nURLs. Omit for the core-flows widget (which uses Coinflow's own return page)."}},"description":"Body for `POST /withdraw/paypal/login` — begins Log in with PayPal.","title":"StartPaypalLoginArgs"},"Withdraw_StartPaypalLogin_Response_200":{"type":"object","properties":{"sessionId":{"type":"string"},"state":{"type":"string"},"url":{"type":"string"}},"required":["sessionId","state","url"],"title":"Withdraw_StartPaypalLogin_Response_200"},"ValidateKycBody":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"description":"First name of the user"},"lastName":{"type":"string","minLength":1,"description":"Last name of the user"},"dob":{"type":"string","pattern":"^\\d\\d\\d\\d-\\d\\d-\\d\\d$","description":"Date of birth of the user"},"country":{"type":"string","pattern":"^[A-Z,a-z]{2}$","minLength":2,"maxLength":2,"description":"Country of the user (ISO 3166-1 alpha-2)"},"matchThreshold":{"type":"integer","description":"Matching Threshold\nThe name comparison does not match exact strings, but instead is a fuzzy match so that nicknames or small misspellings don't lead to false positives.\nTherefore, you are able to pass a threshold, 100 being most strict and 0 being least strict. If not passed the system will default to 90."}},"required":["firstName","lastName"],"title":"ValidateKycBody"},"Withdraw_ValidateKyc_Response_200":{"type":"object","properties":{"invalidFields":{"type":"array","items":{"type":"string"}},"valid":{"type":"boolean"}},"required":["invalidFields","valid"],"title":"Withdraw_ValidateKyc_Response_200"},"InteracPinWebhookPacketEventType":{"type":"string","enum":["Interac PIN"],"description":"The webhook event type.","title":"InteracPinWebhookPacketEventType"},"InteracPinWebhookPacketCategory":{"type":"string","enum":["Withdraw"],"description":"The webhook category.","title":"InteracPinWebhookPacketCategory"},"InteracPinWebhookPacket":{"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/InteracPinWebhookPacketEventType","description":"The webhook event type."},"category":{"$ref":"#/components/schemas/InteracPinWebhookPacketCategory","description":"The webhook category."},"created":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of when the event was created."},"data":{"$ref":"#/components/schemas/InteracPinWebhookData"}},"required":["eventType","category","created","data"],"title":"InteracPinWebhookPacket"}},"securitySchemes":{"wallet":{"type":"apiKey","in":"header","name":"x-coinflow-auth-wallet","description":"The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key"},"blockchain":{"type":"apiKey","in":"header","name":"x-coinflow-auth-blockchain","description":"The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key"},"userId":{"type":"apiKey","in":"header","name":"x-coinflow-auth-user-id","description":"The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key"},"merchant":{"type":"apiKey","in":"header","name":"Authorization","description":"The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key"},"signedMessage":{"type":"apiKey","in":"header","name":"x-coinflow-auth-signed-message","description":"The message signed by the users wallet"},"merchantId":{"type":"apiKey","in":"header","name":"x-coinflow-auth-merchant-id","description":"The merchant ID the session should be generated for"},"sessionKey":{"type":"apiKey","in":"header","name":"x-coinflow-auth-session-key","description":"The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key"},"admin":{"type":"apiKey","in":"header","name":"Authorization"}}}}