The identity and technical contract details declared by the specification.
NewVenmoCheckoutArgsVenmo
The email or phone number tied to the Venmo account
AnyObject
object
1 property
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa1
array
PixCheckoutArgsRentLamports
SavedWireTokenCheckoutArgs
object
21 properties
3 required
NewPayPalCheckoutArgsPaypalOneOf1PhoneNumber
object
2 properties
2 required
AchCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
SellerInfo
object
6 properties
NewPayPalCheckoutArgsPaypal0
object
1 property
1 required
CryptoHeadlessCheckoutArgsRentLamports
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsSepa
CardDataWithoutAddressAdditionalVendorData
object
Optional non-PCI passthrough fields merged into the stored card vendorData. Base type is empty; tokenization providers extend it with their own fields.
NewVenmoCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
CryptoCartItemUnitPrice
object
The price per 1 unit
2 properties
2 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix1
array
PixCheckoutArgs
object
19 properties
3 required
VerificationStatus
string
MerchantTheme
object
18 properties
ThreeDsChallengePreference
string
FeeOption
object
3 properties
2 required
google.payments.api.AssuranceDetails
object
Assurance details about what validation has been performed on the returned payment credentials so that appropriate instrument risk checks can be applied. Note:…
2 properties
Verification
object
8 properties
3 required
google.payments.api.PaymentMethodData
object
Data for a payment method.
4 properties
2 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto1
array
External3DSInfo
object
External 3DS info, if provided must call the endpoint with API key or checkout JWT.
6 properties
6 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay
IUserLocation
object
End-user geographic coordinates captured at the moment of the withdrawal request. Consumed by BlockingRuleMethod.GEOLOCATION enforcement. Replay-of-different-c…
2 properties
2 required
TokenRedeem
object
3 properties
2 required
ApplePayPaymentTokenPaymentDataHeader
object
3 properties
3 required
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceSellingPrice
object
2 properties
2 required
CurrencyAmount
object
Common currency amount structure
2 properties
2 required
GetUsdcAuthorizationResponse
object
Response for USDC authorization message
2 properties
2 required
VerificationRequiredResponse
object
5 properties
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa1
array
Checkout_GetCheckoutLink_Response_200
object
1 property
1 required
MoneyTopUpCartItem
object
Represents a money top-up item in a shopping cart
8 properties
5 required
NewVenmoCheckoutArgsVenmo1
object
1 property
1 required
GetTotalsBodyRentLamports
DecentRedeem
object
If your contract exists on a chain supported by Decent, pass this object in order to call it.
7 properties
6 required
ApplePayPayment
object
Apple Pay Payment received from the Apple Pay SDK Details can be found here: https://developer.apple.com/documentation/applepayontheweb/applepaypayment
4 properties
2 required
Authentication3DS
3DS Card Authorization Data On initial payment submission - Device3DSInfo needed: 3DS device information - required if 3DS is enabled After card challenge comp…
Record_string.any_
object
Construct a type with a set of properties K of type T
SavedVenmoCheckoutArgs
object
28 properties
2 required
CustomerUsdcTransferData
object
Customer signed USDC transferWithAuthorization data for dual-source payments Used for combined USDC + Credit Card payments on EVM chains
9 properties
9 required
Pick_VerificationRequiredResponse.verification-or-verificationLink_
object
From T, pick a set of properties whose keys are in the union K
2 properties
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo1
array
ApaCheckoutArgs
object
19 properties
3 required
google.payments.api.PaymentMethodType
string
Payment method type enum string. Options: - CARD: CARD payment method. Note that the payment method information that may be returned to you or your processor f…
GetCheckoutLinkArgsWebhookInfo
object
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp
NewVenmoCheckoutArgsVenmoOneOf1PhoneNumber
object
2 properties
2 required
ApaCheckoutArgsRentLamports
CardCheckoutArgsRentLamports
SplitNameCustomerInfo
object
14 properties
2 required
ApaCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
AdditionalVerification
object
5 properties
4 required
NewVenmoCheckoutArgs
object
29 properties
2 required
SavedTokenCheckoutArgsRentLamports
CapturePaymentRequestRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
CurrencyCents
object
2 properties
2 required
SafeMintRedeemTransaction
object
Transaction to be called.
2 properties
2 required
EvmTransactionData
(EVM only) if you want to execute an EVM transaction on a successful purchase, you can pass a transaction request here. Gas fees for the transaction will be au…
ApplePayPaymentTokenPaymentData
object
An object containing the encrypted payment data.
4 properties
4 required
NewPayPalCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
SavedPayPalCheckoutArgs
object
28 properties
2 required
SafeMintRedeem
object
(EVM only) If your contract mints an NFT via a OpenZeppelin Safe Mint Call, then utilize this object. The contract mints the NFT to msg.sender (which is the Co…
4 properties
2 required
ReviewPaymentRequest
object
2 properties
2 required
ApplePayCheckoutArgs
object
26 properties
2 required
ApplePayPaymentTokenPaymentMethodType
string
A value representing the card's type of payment.
GooglePayCheckoutArgs
object
27 properties
2 required
GetCheckoutLinkArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire1
array
GooglePayCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
GooglePayCheckoutArgsRentLamports
CustomPayInFeesConfig
array
Checkout_CashAppCheckout_Response_200
object
3 properties
3 required
ApplePayCheckoutArgsRentLamports
Pick_ApplePayJS.ApplePayPaymentContact.emailAddress_
object
From T, pick a set of properties whose keys are in the union K
1 property
ApplePayPaymentTokenPaymentMethodNetwork1
string
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemClass
string
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal
ReturnedTokenIdRedeemType
string
GooglePayCheckoutArgsPaymentData
object
Payment data. Contains the payment data requested in [[PaymentDataRequest|PaymentDataRequest]]
8 properties
3 required
SavedPayPalCheckoutArgsRentLamports
MerchantInitiatedTransactionArgs
ChargebackProtectionAccountType
string
IbanPaymentDetails
object
8 properties
6 required
google.payments.api.PaymentMethodTokenizationData
object
Tokenization data for the payment method.
2 properties
2 required
ZeroAuthorizationCheckoutArgsWithoutReason
AccountFundingTransaction
object
Used for Account Funding Transactions
1 property
TransactionHistoryItem
object
11 properties
11 required
NewIbanCheckoutArgs
object
19 properties
3 required
GetTotalsBody
object
From T, pick a set of properties whose keys are in the union K
11 properties
1 required
Record_PaymentMethods.TotalsResponseSettlement-or-undefined_
object
Construct a type with a set of properties K of type T
16 properties
16 required
GetCheckoutLinkArgsRentLamports
PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClassListPrice
object
The item's list price
2 properties
SavedVenmoCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
SupportedTokenChainCombo
object
3 properties
3 required
CashAppCheckoutArgs
object
16 properties
1 required
CryptoHeadlessCheckoutArgs
object
18 properties
4 required
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceProductType
string
RecipientAftInfo
object
10 properties
6 required
Pick_nftCartItem.Exclude_keyofnftCartItem.sellingPrice-or-itemClass__
object
From T, pick a set of properties whose keys are in the union K
7 properties
3 required
MoneyTopUpCartItemItemClass
string
Denotes the cart item class. The item schema is chosen based on this value. Allowed value: moneyTopUp Example: moneyTopUp
Checkout_CapturePayment_Response_200
object
1 property
1 required
CryptoCartItem
object
Represents a crypto item in a shopping cart
9 properties
5 required
ZeroAuthSavedPaymentMethods
object
Configuration for zero authorization flow - controls saved payment method visibility.
1 property
1 required
TokenCheckoutArgsRentLamports
SupportedChainTokenCombos
object
1 property
1 required
ReturnedTokenIdRedeem
object
(EVM only) If your contract returns the NFT ID, then utilize this object. The contract mints the NFT to msg.sender (which is the Coinflow contract), the Coinfl…
4 properties
2 required
HeadlessCheckoutSession
object
Response from creating a payin session
8 properties
8 required
ZeroAuthorizationConfig
Configuration for zero authorization flow. The presence of this object indicates the checkout is in zero auth mode. Two mutually exclusive modes: - Saved payme…
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc
Address
object
6 properties
5 required
CardDataWithoutAddress
object
8 properties
6 required
CardCheckoutArgsCard
Credit card information. Always pass address unless explicitly told that you may not
google.payments.api.CardNetwork
string
Card network enum string. Options: - AMEX: American Express card network. - DISCOVER: Discover card network. - ELECTRON: Visa's Electron card network. Note tha…
CardCheckoutResponse
object
2 properties
1 required
ConcludeChallenge
object
1 property
1 required
SupportedToken
object
5 properties
4 required
ApplePayCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
NewPayPalCheckoutArgsRentLamports
ApplePayPaymentToken
object
3 properties
3 required
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemFulfillment
string
How the product was fulfilled.
google.payments.api.Address
object
Description of a user's address.
10 properties
4 required
ZeroAuthVerifyCard
object
Configuration for zero authorization flow - verify existing card mode. Shows the "Verify Card" flow for a specific saved card. The card token will be validated…
1 property
1 required
CheckoutCapturePostResponsesContentApplicationJsonSchemaJobId
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCashApp1
array
CardOnFileCheckoutArgsWithOriginalPaymentIdRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
CryptoTier
string
Currency tiers for crypto payins
ApplePayPaymentTokenPaymentMethodNetwork
A string, suitable for display, that is the name of the payment network backing the card.
ZeroAuthorizationCheckoutArgsNewCardWithoutReasonCard
RecipientInfoWalletCustodialType
string
The type of the wallet Allowed values: custodial, nonCustodial, unknown Example: custodial
Checkout_ApaCheckout_Response_200
object
1 property
1 required
ApaCredentialType.EMAIL
string
CustomPayInFeeValue1
object
4 properties
4 required
AchCheckoutArgsRentLamports
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch1
array
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac
CustomPayInFeeConfig
object
2 properties
2 required
MerchantInitiatedStandardTransactionArgs
object
20 properties
2 required
CryptoHeadlessCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
NewInteracCheckoutArgsRentLamports
CartClassOmitted
array
Cart item details required for Coinflow Chargeback Protection. Required if the merchant uses chargeback protection.
TokenCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
CardData
object
13 properties
9 required
CardOnFileCheckoutArgsWithOriginalPaymentIdRentLamports
ApplePayPaymentTokenPaymentMethod
object
Information about the card used in the transaction.
3 properties
3 required
PhoneInfo
object
Phone information structure
3 properties
2 required
RevalidateCVVFields
object
2 properties
2 required
Checkout_GetDestinationAuthKey_Response_200
object
1 property
1 required
GetUsdcAuthorizationResponseMessageData
object
Structured message data for transparency
6 properties
6 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay
CoinflowBlockchain
string
Coinflow Types
IbanData
object
10 properties
4 required
CardOnFileCheckoutArgsWithTokenRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
google.payments.api.PaymentMethodTokenizationType
string
Payment method tokenization type enum string. Options: - PAYMENTGATEWAY: Tokenize a payment response to be consumed or charged by a specified third-party gatew…
TokenCheckoutArgsAddress
object
The address field is not needed here unless explicitly given instructions to do so.
5 properties
3 required
Device3DSInfo
object
5 properties
4 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsVenmo
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits
PayPalCheckoutResponse
object
1 property
1 required
NewWireCheckoutArgsRentLamports
SavedVenmoCheckoutArgsRentLamports
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsInterac1
array
MerchantInitiatedStandardTransactionArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
SavedWireTokenCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
NormalRedeem
object
(EVM only) If your contract sends the item/service being purchased via a custom "receiver" field, then utilize this object. The coinflow contract calls the "to…
2 properties
1 required
Checkout_CardOnFileAuthorized_Response_200
object
1 property
1 required
CustomerUsdcTransferDataV2ValidAfter
SavedTokenCheckoutArgs
object
19 properties
3 required
Checkout_GetCheckoutJwtToken_Response_200
object
1 property
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsAch
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard
MerchantInitiatedSubscriptionTransactionArgs
object
8 properties
1 required
ChallengeFields
object
3 properties
3 required
CashAppCheckoutArgsRentLamports
ApaCredentialType.PHONE
string
GetCheckoutLinkArgs
object
41 properties
NewPayPalCheckoutArgsPaypal
The email or phone number tied to the PayPal account
MerchantInitiatedStandardTransactionArgsRentLamports
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments1
array
CashAppCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
google.payments.api.SelectionOptionData
object
Data for a [[SelectionOption|SelectionOption]].
1 property
1 required
NewInteracCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
AchCheckoutArgs
object
20 properties
2 required
CustomerUsdcTransferDataValidAfter
NewIbanCheckoutArgsRentLamports
FeeDetailRequest
object
4 properties
2 required
CardCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
SafeMintRedeemType
string
USWirePaymentDetails
object
8 properties
8 required
RecipientInfoWallet
object
The crypto wallet that will receive the funds
3 properties
3 required
CapturePaymentRequest
object
From T, pick a set of properties whose keys are in the union K
4 properties
2 required
AddUSWireBankAccountData
object
19 properties
10 required
KnownTokenIdRedeemTransaction
object
Transaction to be called.
2 properties
2 required
InteracCheckoutResponse
object
3 properties
1 required
NormalRedeemTransaction
object
Transaction to be called.
2 properties
2 required
NewWireCheckoutArgs
object
19 properties
3 required
CustomerUsdcTransferDataV2ValidBefore
GetTotalsBodyRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
NewVenmoCheckoutArgsVenmo0
object
1 property
1 required
Pick_GiftCardCartItem.Exclude_keyofGiftCardCartItem.listPrice__
object
From T, pick a set of properties whose keys are in the union K
15 properties
6 required
TokenCheckoutArgs
object
28 properties
2 required
CardOnFileCheckoutArgsWithToken
object
Card on file using a token
26 properties
2 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPix
NewPayPalCheckoutArgsPaypal1
object
1 property
1 required
SavedWireTokenCheckoutArgsRentLamports
ZeroAuthorizationCheckoutArgsSavedCardWithoutReason
object
12 properties
1 required
RecipientInfo
object
10 properties
CartItemAddress
object
Address structure
5 properties
CustomerUsdcTransferDataV2
object
V2 of CustomerUsdcTransferData — replaces the (v, r, s) triple with a single signature bytes string, matching USDC FiatTokenV22's bytes-overload transferWithAu…
7 properties
7 required
NewVenmoCheckoutArgsRentLamports
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApplePay1
array
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsGooglePay1
array
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCard1
array
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCrypto
TokenSubtotal
object
3 properties
2 required
CardCheckoutArgs
object
28 properties
2 required
Pick_Address.Exclude_keyofAddress.state__
object
From T, pick a set of properties whose keys are in the union K
5 properties
4 required
SavedTokenCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsFasterPayments
CapturePaymentRequestRentLamports
PixCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
ApplePayBillingContact
object
10 properties
4 required
NewInteracCheckoutArgs
object
22 properties
4 required
CardOnFileCheckoutArgsWithOriginalPaymentId
object
Card on file using the original payment ID
26 properties
2 required
PaymentData
object
2 properties
1 required
ZeroAuthorizationCheckoutResponse
object
2 properties
2 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsApa
NewWireCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
google.payments.api.OfferData
object
Definition for each offer to be applied to this payment request.
1 property
1 required
Partial_Record_PaymentMethods.FeeOption-Array-or-FeeDetail-or-CurrencyCents__
object
Make all properties in T optional
16 properties
CustomPayInFeeValue0
object
4 properties
4 required
StandaloneLinkConfig
object
2 properties
2 required
CustomerUsdcTransferDataValidBefore
NameCustomerInfo
object
13 properties
PixCheckoutResponse
object
4 properties
4 required
DecryptedApplePayToken
object
7 properties
7 required
CardOnFileCheckoutArgsWithTokenRentLamports
VerificationVendor
string
VoidPaymentRequest
object
1 property
1 required
CheckoutResponse
object
1 property
1 required
ZeroAuthorizationCheckoutArgsNewCardWithoutReason
object
12 properties
1 required
CardDataAdditionalVendorData
object
Optional non-PCI passthrough fields merged into the stored card vendorData. Base type is empty; tokenization providers extend it with their own fields.
TokenSubtotalAmount
Number of tokens
VenmoCheckoutResponse
object
1 property
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsUsdc1
array
ReturnedTokenIdRedeemTransaction
object
Transaction to be called.
2 properties
2 required
TotalsResponse
object
19 properties
6 required
TotalsResponseSettlement
object
22 properties
9 required
SavedPayPalCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
DecentRedeemCost
object
Amount of the token on the destination chain you will be receiving
2 properties
2 required
CryptoCartItemItemClass
string
Denotes the cart item class. The item schema is chosen based on this value. Allowed value: crypto Example: crypto
KnownTokenIdRedeem
object
(EVM only) If your know the ID of the NFT being purchased, then utilize this object. The contract transfers the NFT to msg.sender (which is the Coinflow contra…
4 properties
3 required
NewPayPalCheckoutArgs
object
29 properties
2 required
Cents
object
1 property
1 required
FeeDetail
object
2 properties
2 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsWire
Exclude_ApaCredentialType.ApaCredentialType.PAN_
Exclude from T those types that are assignable to U
google.payments.api.CardInfo
object
Data for a [[PaymentMethodType|PaymentMethodType.CARD]] payment method.
4 properties
2 required
NewIbanCheckoutArgsRent
object
(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.
1 property
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsCredits1
array
GetUsdcAuthorizationBody
object
Request body for getting USDC authorization message
2 properties
1 required
PartialRecordPaymentMethodsFeeOptionArrayOrFeeDetailOrCurrencyCentsPaypal1
array
VersionInfo
object
4 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coinflow publishes across the network.