Get an auto-ramp account

GET

/v1/auto-ramp-accounts/{id}

Returns a single auto-ramp account by ID for the authenticated user.

Authorizations

• bearerAuth
• integratorJwt
• hmacAuth
• integratorKey
• timestamp

Parameters

Path Parameters

id

required

The auto-ramp account ID

string

>= 1 characters

Responses

200

A virtual bank account that automatically converts fiat deposits to crypto. The account is opened in the user’s name - funds deposited are converted to the specified token and sent to the destination wallet address. Important: Always confirm the account status is ‘active’ before initiating a deposit.

A virtual bank account that automatically converts fiat deposits to crypto. The account is opened in the user’s name - funds deposited are converted to the specified token and sent to the destination wallet address. Important: Always confirm the account status is ‘active’ before initiating a deposit.

object

id

required

Unique identifier for this auto-ramp account

string

depositInstructions

required

Bank account details for depositing fiat funds. Use these instructions to initiate ACH or wire transfers.

object

bankName

required

Name of the bank holding the virtual account

string

bankAddress

required

Physical address of the bank

string

bankRoutingNumber

required

ABA routing number for the bank (9 digits). Used for ACH and wire transfers.

string

bankAccountNumber

required

Account number for deposits. This is the full account number required to initiate transfers to this virtual account.

string

paymentRails

required

Supported payment rails for depositing funds

Array<string>

network

required

Blockchain network where converted crypto will be sent. Lowercase network identifier.

string

address

required

Destination wallet address. Fiat deposits are converted and sent to this address.

string

token

required

Token that fiat deposits will be converted to

string

currency

required

Fiat currency accepted for deposits

string

status

required

string

Allowed values: active inactive

createdAt

required

Timestamp when this auto-ramp account was created (ISO 8601)

string format: date-time

401

Response for status 401

object

type

A URI reference that identifies the problem type

string

default: about:blank

title

required

A short, human-readable summary of the problem type

string

status

required

The HTTP status code

number

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

realm

The authentication realm

string

scope

The required scope for this resource

string

404

Response for status 404

object

type

A URI reference that identifies the problem type

string

default: about:blank

title

required

A short, human-readable summary of the problem type

string

status

required

The HTTP status code

number

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

resourceType

required

The type of resource that was not found

string

resourceId

required

The identifier of the resource that was not found

string

500

Response for status 500

object

type

A URI reference that identifies the problem type

string

default: about:blank

title

required

A short, human-readable summary of the problem type

string

status

required

The HTTP status code

number

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string