> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oyapasteaza.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve dedicated account

> Retrieve a dedicated account by external reference, account reference, or account number.

Use this endpoint to retrieve one dedicated account.

You can retrieve by `externalReference`, `accountReference`, or `accountNumber`.

## Endpoint

```http theme={null}
GET /v1/collections/dedicated-accounts/{reference}
```

## Headers

```http theme={null}
Authorization: Bearer sk_test_xxx
```

## Path parameters

| Field       | Type   | Required | Description                                                      |
| ----------- | ------ | -------- | ---------------------------------------------------------------- |
| `reference` | string | Yes      | The `externalReference`, `accountReference`, or `accountNumber`. |

## Example request

```bash theme={null}
curl https://api.oyapasteaza.com/v1/collections/dedicated-accounts/CUS_001 \
  -H "Authorization: Bearer sk_test_xxx"
```

## Successful response

```json theme={null}
{
  "status": true,
  "message": "Dedicated account retrieved successfully.",
  "data": {
    "externalReference": "CUS_001",
    "accountReference": "PZ_DCA_abc123",
    "accountNumber": "8023456789",
    "accountName": "LUCKY TECHNOLOGIES LTD",
    "bankName": "PASTEAZA TEST BANK",
    "status": "ACTIVE",
    "totalReceived": 500000,
    "transactionCount": 1,
    "metadata": {
      "customerId": "123",
      "plan": "premium"
    },
    "createdAt": "2026-06-27T10:00:00.000Z",
    "updatedAt": "2026-06-27T10:05:00.000Z"
  }
}
```

## Errors

| Code                          | Meaning                                              |
| ----------------------------- | ---------------------------------------------------- |
| `authentication_failed`       | The API key is missing or invalid.                   |
| `validation_failed`           | `reference` is missing.                              |
| `dedicated_account_not_found` | No dedicated account matched the supplied reference. |

## Next step

<CardGroup cols={2}>
  <Card title="List dedicated accounts" icon="list" href="/collections/dedicated-accounts/list-dedicated-accounts">
    Retrieve active dedicated accounts for your merchant account.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/getting-started/webhooks">
    Process dedicated account credit webhooks.
  </Card>
</CardGroup>
