checkout

Create Pix Payment

Changed on

Initiates a Pix payment order. Returns a BR code used to pay the order. Must be paid before the returned expiration date (5 minutes).

post/checkout/pix

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/checkout/pix
  • Auth
    API key in header x-coinflow-auth-session-key

Request body

feePercentagenumber double

If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is taken from the subtotal amount.

jwtTokenstring

This is a token encoding the parameters for the request. Allows purchase parameters to be verified to prevent manipulation when the checkout page is presented to the user.

stellarTransactionstring

(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.

For transaction purchases, pass the base64 XDR string created using .toXDR() on a transaction built with generated TypeScript bindings (e.g., NftClientWrapper.buildNftPurchaseTx).

For direct USDC transfers (no merchant transaction), omit this field or pass undefined.

Gas fees for the transaction will be automatically calculated and added to the total charged to the customer.

settlementType'Credits' | 'USDC'
destinationAuthKeystring

If utilizing USDC settlement to addresses other than your main merchant settlement address. Utilize this destinationAuthKey which is a JWT encoded with the information for which address to send the USDC to.

overrideChargebackProtectionDecisionboolean
doNotReviewChargebackProtectionboolean
emailstring required
merchantIdstring required

Merchant Identifier

Response

Ok

paymentIdstring required

The ID of the payment that was created.

brCodestring required

QR code to display to complete payment.

expiresstring required

BR Code expiration

Changes

  • c6e94e0ae714Revision changes
    • breaking

      request property / list-of-types was narrowed by removing types number from media type application/json

    • breaking

      the // request property type changed from number to integer, and format from double to no format

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-session-key

    • info

      the endpoint scheme security sessionKey was added to the API