List all recipients

Returns a list of recipients on an account.

Ordered alphabetically by name.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
limit
integer <int32> (limit) [ 1 .. 1000 ]
Default: 100

The maximum number of items to return.

Example: limit=100
offset
integer <int32> (offset)
Default: 0

The number of items to skip before returning the results.

Example: offset=200
search
string

The term to filter results by. Searches on name, country, currency, recipientBankAccount, accountNumber and BIC.

Example: search=John Doe
deleted
boolean

Whether to return deleted recipients

Example: deleted=true
status
string

Filter by status

Enum: "AUTHORISED" "PENDING"
Example: status=AUTHORISED
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/recipients
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 200,
  • "count": 67,
  • "rows": [
    ]
}