Skip to content

Get account lookup by ID

Request

Gets an Account Lookup entity for its account_lookup_id value.

Security
Bearer
Path
account_lookup_idstring, (uuid)required

AccountLookupId

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/account_lookups/{account_lookup_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned Account Lookup response.

Bodyapplication/json
account_lookup_idstring, (uuid)required

UUID that links Account lookup request and response.

account_lookup_statusstringrequired

State of the Account Lookup object. Should be REQUESTED/PROCESSED/FAILED.

Enum:"REQUESTED""PROCESSED""FAILED""EXPIRED"
first_namestring, <= 40 characters

First name of the beneficiary.

middle_namestring, <= 40 characters

Middle name of the beneficiary.

last_namestring, <= 40 characters

Last name of the beneficiary.

org_namestring, <= 140 characters

Name of the organization.

country_codestring

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

account_idstring, <= 40 characters

Identifier for the Account, e.g account number.

account_id_typestring

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum:"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
result_codestring

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_statusstring

Result status of Account Lookup response.

Enum:"PASS""FAIL"
result_descriptionstring

Result description of Account Lookup response.

redacted_first_namestring, <= 40 characters

First name of the beneficiary redacted by the receiver.

redacted_middle_namestring, <= 40 characters

Middle name of the beneficiary redacted by the receiver.

redacted_last_namestring, <= 40 characters

Last name of the beneficiary redacted by the receiver.

redacted_org_namestring, <= 140 characters

Name of the organization redacted by the receiver.

redacted_country_codestring

Country of the beneficiary redacted by the receiver.

redacted_account_idstring, <= 40 characters

Identifier for the Account, e.g account number, redacted by the receiver.

redacted_account_id_typestring

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum:"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
redacted_account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_codestring

Clearing system code

branch_codestring

The Branch code (e.g., routing code) that the receiver has on their system.

Response
{
  "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  "account_lookup_status": "REQUESTED",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "org_name": "string",
  "country_code": "string",
  "account_currency": "string",
  "account_id": "string",
  "account_id_type": "AIIN",
  "result_code": "string",
  "result_status": "PASS",
  "result_description": "string",
  "redacted_first_name": "string",
  "redacted_middle_name": "string",
  "redacted_last_name": "string",
  "redacted_org_name": "string",
  "redacted_country_code": "string",
  "redacted_account_id": "string",
  "redacted_account_id_type": "AIIN",
  "redacted_account_currency": "string",
  "clearing_system_code": "string",
  "branch_code": "string"
}