Retrieve a customer account record with the given account identifier

This operation retrieves the details of an Account given an accountId. The accountId is one of the unique identifiers for an account (e.g. FiAccountIdentifier.identification or MsisdnAccountIdentifier.msisdn).

Request

path Parameters

accountId

required

string

One of the unique identifiers of an account, such as an account number or additional identifier. This value must be URL encoded.

query Parameters

identifierType

string

The type of identifier used to retrieve the account. When included, this value allows for faster retrieval of the account information by reducing the search space to a specific identifierType additionally, the inclusion of this parameter will filter results such that if the identifier specified exists but is of a different type, it will not be found.

Enum: "FI_ACCOUNT_IDENTIFIER" "PROPRIETARY_ACCOUNT_IDENTIFIER" "IBAN_ACCOUNT_IDENTIFIER" "MSISDN_ACCOUNT_IDENTIFIER"

Responses

200

The account information as found based on the provided accountId.

400

Bad Request.

404

Account not found.

500

Internal server error. Any 5xx should be considered as transitive and the original request should therefore be retried.

get/accounts/{accountId}

Response samples

application/json

{"account": {"primaryIdentifier": {"identifierType": "FI_ACCOUNT_IDENTIFIER",
"identifier": 1234567890
},
"additionalIdentifiers": [{"identifierType": "PROPRIETARY_ACCOUNT_IDENTIFIER",
"identifier": "27-0821111111",
"name": "My Savings Account"
}
],
"type": "CASH",
"currency": "ZAR",
"openingDate": "2022-05-03T15:02:01.000Z",
"status": "ENABLED",
"restrictions": [{"restrictionType": "NO_CREDITS",
"validFrom": "2022-05-04T03:02:01.000Z",
"validUntil": "2022-05-05T15:02:01.000Z"
}
]
},
"primaryAccountOwnerDetails": {"name": {"title": "Mr",
"initials": "AG",
"firstName": "Andrew",
"lastName": "Gates",
"knownAs": "Stretch",
"identification": null,
"identificationType": "NATIONAL_ID",
"ownerType": "INDIVIDUAL",
"address": {"addressType": "HOME",
"streetName": "Wonderland Road",
"buildingNumber": 42,
"buildingName": "AnswerToLife",
"floor": 42,
"postBox": 42,
"postCode": 4242,
"townName": "Hitch",
"districtName": "Outer Regions District"
},
"contactDetails": {"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "andrew42@42.com"
},
"countryOfResidence": "ZA"
}
},
"otherAccountOwnerDetails": [{"name": "Electrum Payments",
"identification": "2012/1234567/123456789",
"identificationType": "COMPANY_REGISTRATION_NUMBER",
"ownerType": "ORGANISATION",
"address": {"addressType": "BIZZ",
"streetName": "New Market Street",
"buildingNumber": "16A",
"buildingName": "Castle Mews",
"floor": 3,
"postCode": 8001,
"townName": "Cape Town",
"districtName": "Foreshore"
},
"contactDetails": {"phoneNumber": "+27-0214486422",
"emailAddress": "hello@electrum.co.za"
},
"countryOfResidence": "ZA"
}
]
}