Skip to content

Beneficiary confirmation

Use these operations to perform beneficiary confirmations.

OperationMethodDescription
Get account lookup by statusGETGet Account Lookup entities by status and other filters.
Initiate account lookupPOSTCreates an Account Lookup request to validate a beneficiary's account details before sending a payment.
Complete account lookupPOSTPosts an Account Lookup response to validate a beneficiary's account details before payment.
Get account lookup by IDGETGets an Account Lookup entity for its account_lookup_id value.
Operations

Get account lookup by status

Request

Get Account Lookup entities by status and other filters. Status defaults to REQUESTED.

Security
Bearer
Query
pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

Default:0
sizeinteger, [ 1 .. 100 ]

Number of objects to return per page

Default:10
account_lookup_statusArray of strings

Account Lookup status

Default:["REQUESTED"]
Items Enum:"REQUESTED""PROCESSED""FAILED""EXPIRED"
start-datestring

The lower bound of the date-time range you want to return account lookup for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-datestring

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

sort_fieldstring

Attribute for how to sort the results

Default:"LAST_MODIFIED_DATE"
Enum:"CREATED_DATE""LAST_MODIFIED_DATE"
sort_directionstring

Direction of sorted results.

Default:"ASC"
Enum:"ASC""DESC"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/account_lookups?page=0&size=10&account_lookup_status=REQUESTED&start-date=string&end-date=string&sort_field=CREATED_DATE&sort_direction=ASC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned response for Account Lookup

Bodyapplication/json
firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger, (int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

contentArray of objects
Response
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}