Retrieve beneficiaries

get https://api-sandbox.modulrfinance.com/api-sandbox-token/beneficiaries

The ability to get the details of beneficiaries using various pieces of information, e.g. using customer ID, retrieve all beneficiaries created by that customer. Can get details of one particular beneficiary based on the unique beneficiary reference number.

Log in to see full request history

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

id

array of strings

Id of Beneficiary(s) to fetch

id

customerId

string

Filter by Customer Id

modifiedSince

string

Beneficiaries modified after this date time

hasExternalReference

json

Filter by existence of external reference

externalReference

string

External reference for beneficiary

iban

string

IBAN

abaRoutingNumber

string

abaRoutingNumber

currency

string

Currency

qualifier

array of strings

A list of external qualifiers

qualifier

state

array of strings

Approval item state(s) to filter by

state

validForAccount

string

Source account BID. Limit results to beneficiaries which would be valid recipients of payments from the given account (e.g. IBAN can’t be paid from GBP account, SCAN can’t be paid from non-GBP account). The specified account must be accessible to the user

sortOrder

string

Sort order

sortField

string

Sort by field, This defaults to name if not present

orSortCode.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orSortCode.value

string

orAccountNumber.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orAccountNumber.value

string

orIban.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orIban.value

string

orAbaRoutingNumber.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orAbaRoutingNumber.value

string

orName.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orName.value

string

orExternalReference.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orExternalReference.value

string

orDefaultReference.type

string

WORD_MATCH - using word boundaries,
WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,
PREFIX - same case prefix,
SUFFIX - same case suffix,
CONTAINS - same case contains
EXACT - same case exact

orDefaultReference.value

string

createdDate

date

Created date

partialName

string

Partial name

sortCode

string

Sort code

accountNumber

string

Account number

page

int32

Page to fetch (0 indexed)

size

int32

≤ 500

Size of Page to fetch

Show Deprecated

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/beneficiaries \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*