Sign in
public.offramps

List Offramps

Lists all offramps for the authenticated merchant with optional filtering and pagination

get/v1/offramps

Query parameters

limitinteger

Number of results per page (default: 50, max: 200)

pageinteger

Page number (default: 1)

type'TEMPORARY' | 'PERMANENT'

Filter by offramp type

chain'APTOS' | 'BASE' | 'BSC' | 'CELO' | 'ETHEREUM' | 'POLYGON' | 'SOLANA' | 'SUI' | 'TEMPO' | 'TRON'

Filter by blockchain network

asset'USDC' | 'USDT'

Filter by asset

statusstring

Filter by offramp status

settlement_mode'INTERNAL_BALANCE' | 'NGN_PAYOUT'

Filter by settlement mode

addressstring

Filter by active crypto receive address

Response

OK

limitinteger
pageinteger
totalinteger
total_pagesinteger

Example response

{
  "data": [
    {
      "developer_fee": {
        "percentage": "1.5"
      },
      "settlement": {
        "destination_bank": {
          "account_name": "Jane Doe",
          "account_number": "0123456789",
          "bank_code": "058"
        }
      },
      "type": "PERMANENT"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.