API ReferenceRedeem

(EVM only) Get Credits Authorization Message

Endpoint to generate an EIP-712 typed data message for authorizing credits usage on EVM chains. This endpoint is used to retrieve a "CreditsAuthorization" message that the user must sign using their wallet (e.g., MetaMask) via the eth_signTypedData_v4 method. The resulting signed message (permitCredits) is then supplied to the `/api/redeem/evm/sendGaslessTx` endpoint to execute a gasless redeem transaction. **Request Body:** - `merchantId` (string): The ID of the merchant requesting redemption. - `subtotal` (Subtotal): The transaction subtotal (either in USDC or a token-based subtotal). - `transactionData` (EvmTransactionData): Transaction details used for calculating gas fees and total credits required. **Response:** Returns an object with the following properties: - `message` (string): A JSON string representing the EIP-712 typed data. - `validBefore` (string): A timestamp or block number indicating until when the message is valid. - `nonce` (string): A unique value to prevent replay attacks. - `creditsRawAmount` (number): The raw credits amount calculated based on the transaction subtotal and estimated gas fees.

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

OR
x-coinflow-auth-session-keystring

The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

Request body containing the parameters required for generating the credits authorization message.
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.

usdcAmountobjectOptional

Response

Ok
messagestring

EIP-712 typed-data JSON string for the user to sign via eth_signTypedData_v

validBeforestring
Timestamp indicating signature validity period
noncestring
Unique identifier for the transaction
creditsRawAmountdouble
Total amount of credits that will be used including gas fees

Errors