Getting Accounts
Primary account ID to filter virtual accounts.
e0cab2dd-739f-43de-b131-3e423e935bf1
Page number for paginated results.
1
Example: 1
Number of accounts per page.
10
Example: 10
Authorization header containing your API Token
Nonce used to generate the payload signature
Payload signature
Date of the request un UTC/GMT
List of accounts available to the partner
Input validation error
Unprocessable entity
GET /v1/partner/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=INITIALIZING&page=1&limit=10 HTTP/1.1
Host: api-url
Accept: */*
{
"items": [
{
"id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
"customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
"partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
"primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
"type": "PRIMARY",
"currencyCode": "GBP",
"createDate": "2025-01-01",
"identifiers": [
{
"type": "UK_ACCOUNT",
"beneficiary": "John Doe",
"bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
"data": {
"type": "UK_ACCOUNT",
"sortCode": "010102",
"accountNumber": "12345678"
}
}
],
"state": "READY",
"balance": {
"currency": "GBP",
"availableBalance": 1,
"ledgerBalance": 1,
"pendingCredits": 1
}
}
],
"meta": {
"currentPage": 1,
"itemCount": 10,
"itemsPerPage": 10,
"totalItems": 100,
"totalPages": 10
}
}
Authorization header containing your API Token
Nonce used to generate the payload signature
Payload signature
Date of the request un UTC/GMT
Returns the account details
Input validation error
Forbidden
Account not found
Unprocessable entity
GET /v1/partner/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*
{
"id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
"customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
"partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
"primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
"type": "PRIMARY",
"currencyCode": "GBP",
"createDate": "2025-01-01",
"identifiers": [
{
"type": "UK_ACCOUNT",
"beneficiary": "John Doe",
"bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
"data": {
"type": "UK_ACCOUNT",
"sortCode": "010102",
"accountNumber": "12345678"
}
}
],
"state": "READY",
"balance": {
"currency": "GBP",
"availableBalance": 1,
"ledgerBalance": 1,
"pendingCredits": 1
}
}
Primary account ID to filter virtual accounts.
e0cab2dd-739f-43de-b131-3e423e935bf1
Page number for paginated results.
1
Example: 1
Number of accounts per page.
10
Example: 10
Authorization header containing your API Token
Nonce used to generate the payload signature
Payload signature
Date of the request un UTC/GMT
List of accounts available to the partner
Input validation error
Forbidden
Unprocessable entity
GET /v1/partner/customers/{customerId}/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=INITIALIZING&page=1&limit=10 HTTP/1.1
Host: api-url
Accept: */*
{
"items": [
{
"id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
"customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
"partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
"primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
"type": "PRIMARY",
"currencyCode": "GBP",
"createDate": "2025-01-01",
"identifiers": [
{
"type": "UK_ACCOUNT",
"beneficiary": "John Doe",
"bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
"data": {
"type": "UK_ACCOUNT",
"sortCode": "010102",
"accountNumber": "12345678"
}
}
],
"state": "READY",
"balance": {
"currency": "GBP",
"availableBalance": 1,
"ledgerBalance": 1,
"pendingCredits": 1
}
}
],
"meta": {
"currentPage": 1,
"itemCount": 10,
"itemsPerPage": 10,
"totalItems": 100,
"totalPages": 10
}
}
Authorization header containing your API Token
Nonce used to generate the payload signature
Payload signature
Date of the request un UTC/GMT
Returns the account details
Input validation error
Forbidden
Account not found
Unprocessable entity
GET /v1/partner/customers/{customerId}/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*
{
"id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
"customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
"partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
"primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
"type": "PRIMARY",
"currencyCode": "GBP",
"createDate": "2025-01-01",
"identifiers": [
{
"type": "UK_ACCOUNT",
"beneficiary": "John Doe",
"bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
"data": {
"type": "UK_ACCOUNT",
"sortCode": "010102",
"accountNumber": "12345678"
}
}
],
"state": "READY",
"balance": {
"currency": "GBP",
"availableBalance": 1,
"ledgerBalance": 1,
"pendingCredits": 1
}
}
Last updated
Was this helpful?