Get Account by ID

GET /v1/accounts/ — Retrieves a single virtual account by UUID, including account number, bank, currency, and wire instructions.

Retrieve a single virtual account by its Diameter-issued UUID. The response includes the account number, account name, currency, bank partner, associated end user and product identifiers, and the wire instructions needed to fund the account. Optionally, you can request the resolved end-user name by passing the includeEndUserName query parameter.

​

Endpoint

GET /v1/accounts/{id}

Required scope: com.diameterpay.api/accounts.read

​

Request Headers

Authorization · string · required

Bearer token obtained from your OAuth 2.0 token endpoint. Format: Bearer {access_token}

​

Path Parameters

id · string · required

The UUID of the virtual account to retrieve.

​

Query Parameters

includeEndUserName · boolean

When true, the response includes the endUserName field resolved from the associated end user record. Defaults to false.

​

Response Fields

id · string

The Diameter-issued UUID for the account.

accountNumber · string

The bank-assigned account number for this virtual account.

accountName · string

A human-readable label for the account. Present only when one has been assigned.

currency · string

The account currency. Currently always USD.

bank · string

The bank partner holding this account. One of PORTAGE or SLOVAK_SAVINGS_BANK.

endUserId · string

UUID of the end user associated with this account.

productId · string

UUID of the product this account belongs to.

wireInstructions · object

Routing details required to send an inbound wire to this account.

Show wireInstructions fields

wireInstructions.bicCode · string

The BIC/SWIFT code of the receiving bank.

wireInstructions.routingNumber · string

The ABA routing number of the receiving bank.

endUserName · string

The resolved name of the end user. Only present when includeEndUserName=true is passed in the request.

createdAt · string

ISO 8601 timestamp of when the account was created.

updatedAt · string

ISO 8601 timestamp of the most recent update to the account.

​

Example Request

curl --request GET \
  --url "https://api.sandbox.diameterpay.com/v1/accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  --header "Authorization: Bearer {access_token}"

With the optional end-user name:

curl --request GET \
  --url "https://api.sandbox.diameterpay.com/v1/accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890?includeEndUserName=true" \
  --header "Authorization: Bearer {access_token}"

​

Example Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "accountNumber": "8675309001",
  "accountName": "Operating Account",
  "currency": "USD",
  "bank": "PORTAGE",
  "endUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "productId": "c9d8e7f6-a5b4-3c2d-1e0f-9a8b7c6d5e4f",
  "wireInstructions": {
    "bicCode": "PRTGUS33",
    "routingNumber": "071004200"
  },
  "endUserName": "Acme Corp",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-06-01T08:45:00Z"
}