For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
RegisterLoginSandbox Login
GuidesRecipesAPI Reference
GuidesRecipesAPI Reference
  • API Reference
    • POSTGets USDC/SBC/EuroE on testnets
      • POST(EVM only) Get Credits Authorization Message
      • POST(EVM only) Send Redeem Transaction with Credits Authorization Message
      • POSTCreate Merchant Wallet Redemption Transaction
      • POSTCreate Redeem Transaction
LogoLogo
RegisterLoginSandbox Login
API ReferenceRedeem

(EVM only) Send Redeem Transaction with Credits Authorization Message

POST
https://api-sandbox.coinflow.cash/api/redeem/evm/sendGaslessTx
POST
/api/redeem/evm/sendGaslessTx
$curl -X POST https://api-sandbox.coinflow.cash/api/redeem/evm/sendGaslessTx \
>     -H "x-coinflow-auth-wallet: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "merchantId": "merchant_9f8b7c6d5e4a3b2c1d0e",
>  "subtotal": {
>    "cents": 2599,
>    "currency": "USD"
>  },
>  "transactionData": {
>    "transaction": {
>      "data": "0xa9059cbb000000000000000000000000b794f5ea0ba39494ce839613fffba7427957926800000000000000000000000000000000000000000000000000000000000003e8",
>      "to": "0x5B38Da6a701c568545dCfcB03FcB875f56beddC4"
>    },
>    "type": "safeMint"
>  },
>  "signedMessages": {
>    "permitCredits": "0x2c6401ff1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1b"
>  },
>  "validBefore": "2024-07-01T12:00:00Z",
>  "nonce": "0x1a2b3c4d5e6f7890",
>  "creditsRawAmount": 25.99
>}'
1{
2  "hash": "0x9f8b7c6d5e4a3b2c1d0e9f8b7c6d5e4a3b2c1d0e9f8b7c6d5e4a3b2c1d0e9f8b"
3}
Endpoint to send a credits redeem transaction on EVM-based blockchains. This endpoint processes a gasless transaction for redeeming credits. It requires a signed permit message (contained in `signedMessages.permitCredits`) that was previously generated by the `/evm/creditsAuthMsg` endpoint. **How It Works:** - Validates that the provided signed permit (EIP-712 signature) is correct. - Constructs the transaction using provided details and sends it through the appropriate EVM network provider. **Request Body:** - `merchantId` (string): The ID of the merchant. - `subtotal` (Subtotal): The transaction subtotal. - `transactionData` (EvmTransactionData): Details of the transaction to be executed. - `signedMessages` (SignedMessages): Contains the signed permit message (permitCredits) for credit authorization. - `chargebackProtectionData?` (CartItemClassOmitted): Optional chargeback protection data. - `validBefore`, `nonce`, `creditsRawAmount`: Values returned by `/evm/creditsAuthMsg` for further verification. **Response:** Returns an object containing: - `hash` (string): The transaction hash of the submitted gasless transaction.
Was this page helpful?
Previous

Create Merchant Wallet Redemption Transaction

Next
Built with

Endpoint to send a credits redeem transaction on EVM-based blockchains.

This endpoint processes a gasless transaction for redeeming credits. It requires a signed permit message (contained in signedMessages.permitCredits) that was previously generated by the /evm/creditsAuthMsg endpoint.

How It Works:

  • Validates that the provided signed permit (EIP-712 signature) is correct.
  • Constructs the transaction using provided details and sends it through the appropriate EVM network provider.

Request Body:

  • merchantId (string): The ID of the merchant.
  • subtotal (Subtotal): The transaction subtotal.
  • transactionData (EvmTransactionData): Details of the transaction to be executed.
  • signedMessages (SignedMessages): Contains the signed permit message (permitCredits) for credit authorization.
  • chargebackProtectionData? (CartItemClassOmitted): Optional chargeback protection data.
  • validBefore, nonce, creditsRawAmount: Values returned by /evm/creditsAuthMsg for further verification.

Response: Returns an object containing:

  • hash (string): The transaction hash of the submitted gasless transaction.

Authentication

x-coinflow-auth-walletstring
The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
x-coinflow-auth-blockchainstring
The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Headers

x-device-idstringOptional
Optional device identifier provided in the request header.

Request

Request body with all necessary parameters to execute the gasless redeem transaction.
merchantIdstringRequired
The ID of the merchant requesting redemption.
subtotalobjectRequired
transactionDataobjectRequired

(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 automatically calculated and added to the total charged to the customer. Optionally the merchant can opt to pay for these gas fees.

signedMessagesobjectRequired
validBeforestringRequired
Values returned from getEvmCreditsAuthMsg endpoint
noncestringRequired
creditsRawAmountdoubleRequired
usdcAmountobjectOptional
chargebackProtectionDatalist of objectsOptional

Response

Ok
hashstring

Errors

412
Precondition Failed Error

The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key