API Reference

With this endpoint the Off-ramp is executed with the following data in the body:

customerId, quoteId, fromCurrency, toCurrency, amount, paymentMethodType, depositAddress, onrampTransactionRequiredFieldsJson.

where:

*fromCurrency will default to ARS, BRL, MXN

*toCurrency can be: USDT

*chain can be: TRON

*paymentMethodType will default to BANK.

onrampTransactionRequiredFieldsJson is a user data object:
firstName and address.

Considerations

  1. In order to perform an OffRamp transaction you must complete Submit KYC or Submit KYB, depending on the type of client (BUSINESS or INDIVIDUAL).
  2. QuoteId is only valid for a single transaction and can not be used in another transaction.
  3. OffRamp information must correspond to what is recorded in Quotes (fromCurrency, toCurrency, amount, chain, PaymentMethodType).
  4. depositAddress must correspond to Address of the indicated chain (TRON).
  5. In the case of OffRamp an INDIVIDUAL person's firstname and address must match what is indicated in the KYC submit endpoint.
  6. In the case of OffRamp for BUSINESS legalName and addressCity must match what is indicated in the KYB submit.
  7. The amount must be exact, down to decimals, to the amount provided earlier in the quote.

Body:

{
    "customerId": "e985358c-d8c0-456a-b5cf-a172c00b5ceb",
    "quoteId": "936aa29b-5e8e-4049-9e5f-01f3954907c9",
    "fromCurrency": "BRL",
    "toCurrency": "USDT",
    "amount": "32.13231200",
    "chain": "ETH",
    "paymentMethodType": "BANK",
    "depositAddress": "0xb794f5ea0ba39494ce839613fffba74279579268",
    "OfframpTransactionRequiredFieldsJson": {
            "firsName": "Josmir",
            "address": "Streeet 1"
    }
}

Response:

{
        "transaction": {
            "transactionId": "f3a13b24-ba57-4586-8fb6-81bdb5c5e4a1",
            "createdAt": "2023-12-13T16:16:53.679Z",
            "quoteId": "e1fe40f4-7fb0-41e7-895e-8353bedda914",
            "fromCurrency": "BRL",
            "toCurrency": "USDT",
            "amount": "120.00",
            "chain": "TRON",
            "paymentMethodType": "BANK",
            "fiatPaymentInstructions": {
                "message": "Scan the QR code with your PIX account to generate the deposit.",
                "qrCode": "00020126890014BR.GOV.BCB.PIX2567api-pix.bancobs2.com.br/spi/v2/0d4831ae-7762-4a87-9aaa-477aaf8c77315204000053039865406248.755802BR5920Just Pagamentos Ltda6014Belo Horizonte61083038040362070503***63045D6E"
            }
        }
    }
}

Language
Click Try It! to start a request and see the response here!