Create Quote

Create an onramp transfer quote for a given customer.

Endpoint

POST /v0/customers/{customer_id}/payin-transfer/quote

Path parameters

  • customer_id (string · uuid) — Required The unique identifier of the customer

Header parameters

  • Authorization (string) — Required Token for authentication

Body (application/json)

  • Either source_amount OR destination_amount must be provided to calculate the quote in the desired direction.

1

BySourceAmount (provide source_amount)

JSON object with properties such as:

  • source_amount

  • source_currency

  • source_payment_rails

  • destination_token

  • destination_network

  • developer_fee_percent

Example request (HTTP):

Request
POST /v0/customers/{customer_id}/payin-transfer/quote HTTP/1.1
Host: gateway.noxxo.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "source_amount": "100.50",
  "source_payment_rails": "ach",
  "source_currency": "usd",
  "destination_token": "usdc",
  "destination_network": "polygon",
  "developer_fee_percent": "0.5"
}
2

ByDestinationAmount (provide destination_amount)

JSON object with properties such as:

  • destination_amount

  • source_currency

  • source_payment_rails

  • destination_token

  • destination_network

  • developer_fee_percent

(Use this shape when you want to specify the desired destination amount and calculate required source amount.)

Response

  • 201 — Quote created successfully (application/json)

Response example:

Response
{
  "quote_id": "123e4567-e89b-12d3-a456-426614174000",
  "source_amount": "100.50",
  "source_currency": "usd",
  "source_payment_rails": "ach",
  "destination_token": "usdc",
  "destination_network": "polygon",
  "destination_amount": "100.50",
  "fee_amount": "10.50",
  "exchange_rate": "text"
}

References

  • BySourceAmount: https://docs.noxxo.com/main/api/payin-transfers/create-quote#bysourceamount-provide-source_amount

  • ByDestinationAmount: https://docs.noxxo.com/main/api/payin-transfers/create-quote#bydestinationamount-provide-destination_amount