Create an Onramp

Creates a new onramp (pay-in) transaction that converts fiat to a crypto token and deposits it to the provided depositAddress.

Behavior and validations:

  • Required fields: customerId, quoteId, fromCurrency, toCurrency, amount, chain, paymentMethodType, depositAddress.
  • chain must be one of the supported chains (see Supported chains below).
  • memo is optional but required for some chains (e.g., XLM).
  • The service will attach businessId from request headers when present.
  • The endpoint returns a representation of the created onramp transaction (201) or an error when validation fails.

Example usage: POST /third-party-service/penny/onramp Body: { "customerId": "...uuid...", "quoteId": "...uuid...", "fromCurrency": "MXN", "toCurrency": "USDC", "amount": "100.00", "chain": "MATIC", "paymentMethodType": "BANK", "depositAddress": "0x..." }

Supported chains:

  • ETH, MATIC, XLM, TRX, SOL, CELO, AVAX, BNB.
    • Note: XLM commonly requires a memo for destination tagging — provide memo when needed.

Notes:

  • Request must include service headers api-key and api-secret.
  • The API may perform normalization and enrichment before returning the created resource.
Language
URL
Click Try It! to start a request and see the response here!