---
title: "Get offramp account"
method: GET
path: "/ledger/offramp-accounts/{offrampAccountId}"
tags: ["ledger-offramp accounts"]
---

# Get offramp account

`GET /ledger/offramp-accounts/{offrampAccountId}`

## Request

- Base URL: `https://external.dev.onboardpay.co`
- URL: `https://external.dev.onboardpay.co/ledger/offramp-accounts/{offrampAccountId}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/docs/ledger/offramp-accounts/:offrampAccountId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get offramp account by offrampAccountId

## Path parameters

- `offrampAccountId` string, required

## Response `200`

Offramp account details

- OfframpAccount
  - `id` string, uuid, required: Unique identifier for the offramp account.
  - `beneficiary` Beneficiary, required: Fiat beneficiary object
    - `id` string, uuid, required: Beneficiary identifier
    - `accountNumber` string, required: Beneficiary account number, for international payments like SEPA, this is the IBAN
    - `accountName` string, required: Beneficiary account name
    - `currency` string, required
    - `beneficiaryType` string: Discriminator value for beneficiary type. Allowed values include: - BeneficiaryLocalBankAccount - BeneficiarySepaBankAccount - BeneficiaryACHBankAccount - BeneficiarySwiftBankAccount - BeneficiaryMobileWalletAccount
    - `isThirdParty` boolean: Flag to indicate if the beneficiary is a third party
    - `accountHolderType` 'INDIVIDUAL' | 'BUSINESS', required
  - `payoutCurrency` string, required
  - `status` 'ACTIVE' | 'INACTIVE' | 'SUSPENDED': Status of the offramp account.
  - `createdDate` string, date-time

## Other responses

- `401`: Client is not authorized to make request
- `404`: Entity was not found

## Changes

- **2026-07-26** `a3c4e2742615`: 2 info
  - the endpoint scheme security `HMACAuth` was added to the API
  - the endpoint scheme security `authToken` was removed from the API
- **2026-07-13** `fc790ea4deb6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/changes/ledger/offramp-accounts/:offrampAccountId/get.md)

---

[API](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway.md) - [All operations](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/revisions/5da9ec1b2573?raw)