Get account

  • Updated on Oct 14, 2025
  • Published on Mar 19, 2025
  • 11 minute(s) read
Prev Next
Get
/customers/{customer_id}/accounts/{account_id}

Get account by id.

Security
OAuth

OAuth Grant type use on OpenAPI subscriptions, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
accounts.readReading customer accounts information via open API
Header parameters
x-client-id
string (uuid) Required

Client ID header

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Path parameters
customer_id
stringRequired

Customer unique id.

Min length1
Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esESB76134758
account_id
string (uuid) Required

Account unique identifier generated by PagoNxt.

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
Query parameters
account_id_type
string

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Default"uuid"
Exampleiban
country
string

Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/). Required with account_id_type BBAN.

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleGB
Responses
200

Account response.

{
  "accountIdentifiers": [
    {
      "accountIdType": "uuid",
      "accountId": "0589bd6c-cca4-4b46-9c8a-b786171e66e1",
      "country": "GB"
    },
    {
      "accountIdType": "iban",
      "accountId": "GB40PNXT09991100000010",
      "country": "GB"
    },
    {
      "accountIdType": "bban",
      "accountId": "PNXT09991100000010",
      "country": "GB"
    }
  ],
  "customerId": "PNXTGB2LXXXUS1234567890",
  "baseCurrency": "EUR",
  "productName": "eMoney Account",
  "nickName": "My E Money Account",
  "reconciliationModel": "PS-REF",
  "supplementaryId": "PN2345ABCD",
  "virtualAccountStructureId": "42dbdc87-a491-4566-bb97-eb2d9aea4707",
  "legalEntity": {
    "bic": "PNXTGB2LXXX",
    "legalEntityId": "pagonxt_uk",
    "legalEntityName": "PagoNxt OneTrade UK Ltd"
  },
  "balances": {
    "available": {
      "amount": {
        "amount": 99.99,
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28Z"
    }
  },
  "createdAt": "2024-11-08T16:08:36.068Z",
  "updatedAt": "2024-11-06T16:08:36.068Z",
  "_links": {
    "self": {
      "href": "https://{host}/accounts/0589bd6c-cca4-4b46-9c8a-b786171e66e1"
    }
  }
}
Expand All
object
createdAt
string (date-time)

Date and time when the entry was created.

Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example2024-10-04T10:02:03.482Z
updatedAt
string (date-time)

Date and time when the entry was updated.

Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example2024-10-04T10:02:03.482Z
customerId
string

Customer unique id.

Min length1
Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esESB76134758
baseCurrency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]{3}$
ExampleEUR
virtualAccountStructureId
string (uuid)

Unique identifier for an account's virtual account structure. Present for all virtual accounts and real accounts with related virtual accounts.

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
reconciliationModel
string

Account reconciliation model. Determines how an account's collections will be reconciled. Only present in real acount. Option are:

  • PS-VA: Payment subject virtual account

  • PS-REF: Payment subject referencePS-VA

  • COL-VA: Collection virtual account

  • COL-REF: Collection reference

Valid values[ "PS-VA", "PS-REF", "COL-VA", "COL-REF" ]
ExamplePS-VA
accountIdentifiers
Array of object (AccountIdentifier)

List of account identifiers.

Max items3
object
accountId

Account identifier. Type depends on accountIdType.

AnyOf
string (uuid)
string
Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
string
string
Min length15
Max length34
Pattern^[A-Z]{2}[0-9A-Z\s]{17,32}$
ExampleGB40PNXT09991100000010
string
string
Min length11
Max length30
Pattern^[0-9A-Z\s]{11,30}$
ExamplePNXT09991100000010
accountIdType
string

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Exampleiban
country
string

Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleGB
nickName
string

NickName account Name (alias) that the customer has assigned to the account for easy identification.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@.#&+-_ ''""]*$
ExampleMy eMoney Account
productName
string

Name of the product associated with the account

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@.#&+-_ ''""]*$
ExampleeMoney Account
supplementaryId
string

Account reference for referenced virtual accounts. Unique by customer and real account.

Min length10
Max length10
Pattern^PN[2-9]{4}[A-HJ-KM-NP-Z]{4}$
ExamplePN2345ABCD
legalEntity
object

Legal Entity details object.

bic
string

Bic of the legal entity associated with the account.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@.#&+-_ ''""]*$
ExamplePNXTGB2LXXX
legalEntityId
string

Unique identifier of the legal entity associated with the account.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@.#&+-_ ''""]*$
Examplepagonxt_uk
legalEntityName
string

Legal Name of the legal entity associated with the account.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@.#&+-_ ''""]*$
ExamplePagoNxt OneTrade UK Ltd
realAccountIdentifiers
Array of object (RealAccountIdentifier)

List of real account identifiers.

Max items3
object
realAccountId

Account identifier. Type depends on accountIdType.

AnyOf
string (uuid)
string
Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
string
string
Min length15
Max length34
Pattern^[A-Z]{2}[0-9A-Z\s]{17,32}$
ExampleGB40PNXT09991100000010
string
string
Min length11
Max length30
Pattern^[0-9A-Z\s]{11,30}$
ExamplePNXT09991100000010
realAccountIdType
string

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Exampleiban
country
string

Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleGB
balances
object

Account balances object.

available
object

Available balance object.

amount
object

The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]{3}$
ExampleEUR
lastChangeDateTime
string (date-time)

Last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'', type: BalanceAmount

Example2017-07-21T17:32:28Z
_links
object

Single links object.

self
object

Self links object.

href
string

Self link.

Max length999
Pattern^(www|http:|https:)+[^\s]+[\w]$
Examplehttps://host/?_offset=0&_limit=10
400

Bad Request

example-1
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "message": "Bad Request",
      "level": "FATAL",
      "description": "Description of the Bad Request error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
401

Unauthorized

example-1
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "FATAL",
      "description": "Description of the Unauthorized error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
403

Forbidden

example-1
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "message": "Forbidden",
      "level": "FATAL",
      "description": "Description of the Forbidden error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
404

Not Found

example-1
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "message": "Not Found",
      "level": "FATAL",
      "description": "Description of the Not Found error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
406

Not Acceptable The Accept header does not specifically contain one of the allowable types. Missing Accept header, usually 'application/json'

example-1
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "message": "Not Acceptable",
      "level": "FATAL",
      "description": "Description of the Not Acceptable error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
413

Request Entity Too Large Most web servers have a limit of 8192 bytes (8 KB). The server will close the connection to prevent the client from continuing the request.

example-1
{
  "errors": [
    {
      "code": "ENTITY_TOO_LARGE",
      "message": "Request Entity Too Large",
      "level": "FATAL",
      "description": "Description of the Request Entity Too Large error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
414

URI Too Long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "FATAL",
      "message": "URI Too Long",
      "description": "URI Too Long description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
422

Unprocessable Entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESSABLE_ENTITY",
      "level": "FATAL",
      "message": "Unprocessable Entity",
      "description": "Unprocessable Entity description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
429

Too Many Requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "Too Many Requests description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
500

Internal server error

err500Example
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Internal server error",
      "description": "Internal server error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
503

Service unavailable

err503Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Service unavailable error description"
    }
  ]
}
healthFailedExample
{
  "errors": [
    {
      "code": "fail",
      "level": "ERROR",
      "message": "Health check failed",
      "description": "Health check failed"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Gateway timeout error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
default

Default error

errDefaultExample
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Error message",
      "description": "Error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription