Get crypto deposit instructions

GET 
/payment-methods/crypto/:currency/deposit-instructions

Returns the on-chain deposit address for the authenticated account's crypto wallet in the given currency (e.g. BASE-USDC). The wallet is provisioned on demand: if it does not yet exist it is created on demand, provided the account has completed crypto onboarding (KYC). Send USDC to the returned on_chain_address on the returned chain, then poll GET /payment-methods/crypto/{currency}/deposits to see it land.

Request

Path Parameters

currency stringrequired

Crypto currency code in CHAIN-TOKEN format. Currently supported: BASE-USDC.

Responses

200

Deposit instructions retrieved (wallet provisioned if it did not already exist)

application/json

Schema

Schema

status string

Possible values: [success]

data

object

Deposit instructions for an account's crypto wallet.

chain string

On-chain network the address lives on.

currency string

Crypto currency code in CHAIN-TOKEN format.

on_chain_address string

Address to send funds to on the given chain.

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "data": {
    "chain": "base",
    "currency": "BASE-USDC",
    "on_chain_address": "string"
  },
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

409

The wallet could not be provisioned — most commonly because the account hasn't completed crypto onboarding (KYC) yet

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

500

Server error

Loading...