Retrieves the Account by ReferenceID. This should only be used in the case of a HTTP communication error and you did not get back the AccountID in the response. Using this for any other purposes is Anti-Pattern and is subject to failing and/or locking of your Client for all requests. You should use Retrieve Account with the AccountID to retrieve Account Information.
This request is only valid if the Account was created within 24 hours ago, otherwise SC=421 will be returned, use Retrieve by AccountID.
If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID (see notes below).
URL:
https://<FQDN>/v1/clients/<ClientIDISO>/accounts?referenceID=<ReferenceID>
Request:
No Request Data
Response:
Status Codes:
Status Code | Description | |
---|---|---|
200 | OK | The Account is retrieved. |
421 | Misdirected Request | Too late to Retrieve Account by ReferenceID, use AccountID. |
See Status Codes for other possible Status Codes that might be returned.
Response Data:
JSON Name | Value | Description | Status Code | |||
---|---|---|---|---|---|---|
200 | Other | |||||
SC | Integer 3-digit code |
HTTP Status Code | ✔ | O | ||
EC | String 1 or 8 characters |
Internal Error Code | ✔ | O | ||
EM | String | Error Message | O | |||
referenceID | String | ReferenceID | ✔ | |||
bank | object | Bank | O | |||
routingNumber | String 9 digits |
Routing Number | O | |||
last4 | String 4 digits |
Last 4 of Account Number | O | |||
accountType | String 1-character code |
Account Type | O | |||
card | object | Card | O | |||
last4 | String 4 digits |
Last 4 of Card Number | O | |||
expirationDate | String 6 digits |
Expiration Date | O | |||
owner | object | Account Owner | ✔ | |||
name | object | Name | ✔ | |||
first | String | First Name | ✔ | |||
middle | String | Middle Name or Initial | O | |||
last | String | Last Name | ✔ | |||
suffix | String | Suffix | O | |||
address | object | Address | O | |||
line1 | String | Address Line 1 | ✔ | |||
line2 | String | Address Line 2 | O | |||
city | String | City | ✔ | |||
state | String 2-character code |
State Code | ✔ | |||
zipcode | String | Zip Code | ✔ | |||
country | String 3-digit code |
ISO 3166-1 Country Code | O | |||
phone | object | Phone Number (E.164 Numbering) | O | |||
countryCode | String 1-3 digits |
Country Calling Code | O | |||
number | String Min: 4 digits Max: 12-14 digits |
Phone Number | ✔ |
Sample Response:
Account retrieved:
{
"SC": 200,
"EC": "0",
"referenceID": "1",
"card":
{
"last4": "9990",
"expirationDate": "202012"
},
"owner":
{
"name":
{
"first": "John",
"last": "Customer"
},
"address":
{
"line1": "465 Fairchild Drive",
"line2": "Suite #222",
"city": "Mountain View",
"state": "CA",
"zipcode": "94043"
},
"phone":
{
"number": "4159808222"
}
}
}
Notes:
For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID>
where:
- ClientID is your unique 22-character string and
- SubClientID is an assigned 4, 6 or 8-digit value.
See Anti-Pattern FAQ for proper usage of Retrieve by ReferenceID.
You should use Retrieve Account with the AccountID to retrieve Account Information.