Skip to main content
POST
Initiate a managed-wallet on-ramp

Authorizations

Authorization
string
header
required

A secret NorthFond business API key. Keep it on your server.

Headers

Idempotency-Key
string
required

A unique key for this logical write operation. Reuse it when retrying the exact same request.

Required string length: 8 - 255

Body

application/json
quote_id
string<uuid>
required
payment_method
object
required
external_reference
string
Required string length: 1 - 120
simulation
enum<string>
default:success

Sandbox only.

Available options:
success,
failed,
delayed,
action_required

Response

On-ramp created

id
string<uuid>
required
direction
enum<string>
required
Available options:
offramp,
onramp
quote_id
string<uuid>
required
status
enum<string>
required
Available options:
created,
awaiting_funds,
funded,
signing,
submitting,
processing,
action_required,
completed,
failed
source
object
required
destination
object
required
fees
object
required
exchange_rate
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
external_reference
string | null
beneficiary_id
string<uuid> | null
wallet_id
string<uuid> | null
funding_source
object
payment_source
object
failure
null | object
completed_at
string<date-time> | null