{ "opencollection": "1.0.0", "info": { "name": "API Reference authentication checkout API", "version": "1.0.0" }, "items": [ { "info": { "name": "checkout", "type": "folder" }, "items": [ { "info": { "name": "ACH Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/ach/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Processes a checkout via ACH." }, { "info": { "name": "APA Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/apa/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the checkout for an APA Payment" }, { "info": { "name": "Apple Pay Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/v2/apple-pay/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apple Pay Checkout" }, { "info": { "name": "Apple Pay Validate Merchant", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.coinflow.cash/api/checkout/apple-pay/validatemerchant", "params": [ { "name": "domainName", "value": "", "type": "query", "description": "- Top level domain that the Apple Pay Button is associated with" }, { "name": "merchantId", "value": "", "type": "query", "description": "The merchant ID associated with this request, required\nif you are utilizing custom certificates\n- The Merchant ID of the Merchant" } ] }, "docs": "Apple Pay Validate Merchant" }, { "info": { "name": "Capture Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/capture", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "If a payment has been created with authOnly=true, capture it using this endpoint." }, { "info": { "name": "Card Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/card/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Processes a checkout via credit card information, will tokenize and save the card for reuse by the customer in the future." }, { "info": { "name": "Card on File Authorized", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/card-on-file-authorized", "headers": [ { "name": "x-coinflow-auth-user-id", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Card On File Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/card-on-file", "headers": [ { "name": "x-coinflow-auth-user-id", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Cash App Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/cashapp/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the checkout for a Cash App Payment" }, { "info": { "name": "Create Pix Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/pix", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a Pix payment order. Returns a BR code used to pay the order. Must be paid before the returned expiration date (5 minutes)." }, { "info": { "name": "Get supported chains and tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.coinflow.cash/api/checkout/crypto", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "subtotalCents", "value": "", "type": "query", "description": "- (Optional) - include parameter to receive quoted fee in response" }, { "name": "subtotalCurrency", "value": "", "type": "query", "description": "- (Optional) - include parameter if subtotal is not USD" }, { "name": "tier", "value": "", "type": "query", "description": "- (Optional) - filter tokens by fee tier" } ] }, "docs": "Get the supported chains and tokens for crypto payin w/ merchant settings" }, { "info": { "name": "Crypto Payin", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/crypto", "headers": [ { "name": "x-coinflow-auth-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a payment where the customer is paying with Crypto" }, { "info": { "name": "Get Checkout Jwt Token", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/jwt-token", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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...)" }, { "info": { "name": "Get Checkout Link", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/link", "headers": [ { "name": "x-coinflow-auth-user-id", "value": "" }, { "name": "x-coinflow-submerchant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets a checkout link for the UserID that can be embedded in vanilla iframe\nor the user can be redirected to" }, { "info": { "name": "Get Destination Auth Key", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/destination-auth-key", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Interchange Fees", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/fees", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Totals", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/totals/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets the fees, quotes, and totals for a particular checkout." }, { "info": { "name": "Get USDC Authorization Message (EVM only)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/evm/usdc-authorization", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Google Pay Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/google-pay/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Google Pay Checkout" }, { "info": { "name": "Interac e-Transfer Checkout (New Contact)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/interac", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates an Interac e-Transfer payin with a new contact. Returns the paymentId." }, { "info": { "name": "Interac e-Transfer Checkout (Saved Contact)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/interac/token", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates an Interac e-Transfer payin with a previously saved contact." }, { "info": { "name": "Merchant Initiated Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/merchant-initiated-transaction", "headers": [ { "name": "x-coinflow-auth-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "PayPal New Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/paypal/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the checkout for PayPal payment with a new account" }, { "info": { "name": "PayPal Saved Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/paypal/token/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the checkout for PayPal payment with a saved account" }, { "info": { "name": "Review Payment Protection", "type": "http" }, "http": { "method": "PUT", "url": "https://api-sandbox.coinflow.cash/api/checkout/review", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "If a payment has a chargeback protection status of Pending Review, select the action to be taken on the payment" }, { "info": { "name": "Saved Card Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/token/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Processes a checkout via tokenized card information." }, { "info": { "name": "Sepa/Faster Payments Checkout (New Account)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/iban", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Sepa/Faster Payments Checkout (Saved Account)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/iban/token", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a Sepa/Faster Payments payment order. Returns destination account info.\nMust be paid before the returned expiration date (5 minutes)." }, { "info": { "name": "US Wire Domestic Payments Checkout (New Account)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/wire", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "US Wire Domestic Payments Checkout (Saved Account)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/wire/token", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Venmo New Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/venmo/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the checkout for Venmo payment with a new account" }, { "info": { "name": "Venmo Saved Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/venmo/token/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the checkout for Venmo payment with a saved account" }, { "info": { "name": "Void Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/void", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "If a payment has been created with authOnly=true, void the authorization using this endpoint." }, { "info": { "name": "Zero Authorization", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.coinflow.cash/api/checkout/zero-authorization/:merchantId", "headers": [ { "name": "x-coinflow-auth-session-key", "value": "" }, { "name": "x-device-id", "value": "" }, { "name": "x-coinflow-client-ip", "value": "" } ], "params": [ { "name": "merchantId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] } ], "bundled": true }