Skip to main content
GET
/
recipient
/
search
/
{currency}
Receive internal recipient account 
curl --request GET \
  --url https://client-api.dev.finhost.io/recipient/search/{currency} \
  --header 'Authorization: Bearer <token>'
[
  {
    "isTransferPossible": true,
    "isRecipientFound": "true",
    "name": "Mark",
    "surname": "Smith",
    "client": "39eab26c-8788-4375-810c-9807aaf98191",
    "account": "39eab26c-8788-4375-810c-9807aaf98191",
    "currency": "USD"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
currency
string
required

Currency code (ISO 4217)

Required string length: 3

Query Parameters

​
attribute
enum<string>
required

Attribute to use for search

Available options:
phone,
email
​
value
string
required

Value of the search attribute

Response

200 - application/json

200 response

​
isTransferPossible
boolean
required

True if transfer is possible

Example:

true

​
isRecipientFound
string
required

True if recipient was found

Example:

"true"

​
name
string
required

Recipient name

Example:

"Mark"

​
surname
string
required

Recipient surname

Example:

"Smith"

​
client
string<uuid>
required

Recipient identifier

Example:

"39eab26c-8788-4375-810c-9807aaf98191"

​
account
string<uuid>
required

Recipient default account identifier for appropriate currency

Example:

"39eab26c-8788-4375-810c-9807aaf98191"

​
currency
string
required

Currency code (ISO 4217)

Required string length: 3
Example:

"USD"