Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Beneficiary confirmation

Initiate account lookup

Creates an Account Lookup request to validate a beneficiary's account details before sending a payment. Account lookups are not part of the payment flow and can be made at any time in the payment process.

post/account_lookups/request

Request body

account_currencystring

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

clearing_system_codestring

Clearing system code

destination_addressstring required

RippleNet address of the receiver.

first_namestring

First name of the beneficiary.

middle_namestring

Middle name of the beneficiary.

last_namestring

Last name of the beneficiary.

org_namestring

Name of the organization.

country_codestring required

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

account_idstring required

Identifier for the Account, e.g account number.

account_id_type'AIIN' | 'BBAN' | 'CARD' | 'CUID' | 'UPIC' | 'EMAIL' | 'MSISDN' | 'DMST' | 'OTHER' required

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)

Response

Successfully returned Account Lookup response.

account_lookup_idstring uuid required

UUID that links Account lookup request and response.

account_lookup_status'REQUESTED' | 'PROCESSED' | 'FAILED' | 'EXPIRED' required

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

first_namestring

First name of the beneficiary.

middle_namestring

Middle name of the beneficiary.

last_namestring

Last name of the beneficiary.

org_namestring

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

Identifier for the Account, e.g account number.

account_id_type'AIIN' | 'BBAN' | 'CARD' | 'CUID' | 'UPIC' | 'EMAIL' | 'MSISDN' | 'DMST' | 'OTHER'

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)
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_status'PASS' | 'FAIL'

Result status of Account Lookup response.

result_descriptionstring

Result description of Account Lookup response.

redacted_first_namestring

First name of the beneficiary redacted by the receiver.

redacted_middle_namestring

Middle name of the beneficiary redacted by the receiver.

redacted_last_namestring

Last name of the beneficiary redacted by the receiver.

redacted_org_namestring

Name of the organization redacted by the receiver.

redacted_country_codestring

Country of the beneficiary redacted by the receiver.

redacted_account_idstring

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

redacted_account_id_type'AIIN' | 'BBAN' | 'CARD' | 'CUID' | 'UPIC' | 'EMAIL' | 'MSISDN' | 'DMST' | 'OTHER'

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)
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.