Overview
Get accounts details V2. If originAccountId is provided, then only the account with that originAccountId will be returned.
GET (/internal/v2/parties/{partyId}/accounts)
Parameters
- partyId (path) (required): Unique identifier for the party. See PartyId model.
- originAccountId (query): Origin account identifier. See OriginAccountId model.
Responses
200 OK
400 Bad Request
Bad request response
404 Not Found
Not found error response
500 Internal Server Error
Internal server error response
Architecture
Account identification details.
IBAN of an account.
[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier.
[a-zA-Z0-9]{1,30}Mobile phone number.
35Other identification details.
ISO 4217 Alpha 3 currency code.
[A-Z]{3}Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here. For a corporate account, the corporate name is used for this attribute.
140Name of the account.
70Product name of the bank for this account, proprietary definition.
35ExternalCashAccountType1Code from ISO 20022.
CACC CARD CASH CHAR CISH COMM CPAC LLSV LOAN MGLD MOMA NREX ODFT ONDP OTHR SACC SLRY SVGS TAXE TRAN TRAS VACC NFCAAccount status. The value is one of the following: - "ENABLED": account is available - "DELETED": account is terminated - "BLOCKED": account is blocked e.g. for legal reasons
ENABLED DELETED BLOCKEDBICFI
[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}Specifies the usage of the account: * INDIVIDUAL: private personal account * ORGANISATION: professional account
4INDIVIDUAL ORGANISATIONAdditional information on the account.
500A list of balances regarding this account, e.g. the current balance, the last booked balance. The list might be restricted to the current balance.
ISO 4217 Alpha 3 currency code.
[A-Z]{3}The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78
-?[0-9]{1,14}(\.[0-9]{1,3})?The following balance types are defined: - "closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. - "openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report. - "interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. - "interimBooked": Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
closingBooked openingBooked interimAvailable interimBookedA flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
Indicates the date and time of the balance.
3rd party service ID modified with the 3rd party identifier prefix
No properties match your search
Try a different search term or clear the search to see all properties
Bad request response
urn:plmr:accounts:api:INTERNAL_SERVER_ERROR urn:plmr:accounts:api:BAD_REQUEST urn:plmr:accounts:api:RESOURCE_UNKNOWN urn:plmr:accounts:api:UNAUTHORIZED urn:plmr:accounts:api:FORBIDDEN urn:plmr:accounts:api:INVALID_PARAM urn:plmr:accounts:api:WEB_APPLICATION urn:plmr:accounts:api:ACCOUNT_NOT_FOUND urn:plmr:accounts:api:ILLEGAL_ENUM_VALUEurn:plmr:accounts:api:NOT_BLANKNo properties match your search
Try a different search term or clear the search to see all properties
Not found error response
urn:plmr:accounts:api:ACCOUNT_NOT_FOUNDNo properties match your search
Try a different search term or clear the search to see all properties
Internal server error response
urn:plmr:accounts:api:INTERNAL_SERVER_ERROR urn:plmr:accounts:api:BAD_REQUEST urn:plmr:accounts:api:RESOURCE_UNKNOWN urn:plmr:accounts:api:UNAUTHORIZED urn:plmr:accounts:api:FORBIDDEN urn:plmr:accounts:api:INVALID_PARAM urn:plmr:accounts:api:WEB_APPLICATION urn:plmr:accounts:api:ACCOUNT_NOT_FOUND urn:plmr:accounts:api:ILLEGAL_ENUM_VALUEurn:plmr:accounts:api:NOT_BLANKNo properties match your search
Try a different search term or clear the search to see all properties