Get All Beneficiaries

Get All Beneficiaries with is_external: true

Headers

X-BUSINESS-API-KEY

string

required

Query Parameters

query

string

Search by holder name / nickname

per_page

integer

default:

10

Response

200 - application/json

data

object[]

required

Show child attributes

data.account_number

string

required

data.address

object

required

Show child attributes

data.address.city

string

required

data.address.postcode

string

required

data.address.state

string

required

data.address.street

string

required

data.bank_routing_number

string

required

data.country

string

required

data.created_at

string

required

data.currency

string

required

data.deleted_at

any

required

data.email

string

required

data.holder_name

string

required

data.holder_type

string

required

data.id

string

required

data.is_external

boolean

default:

true

required

It's always true for public API

data.is_favourite

boolean

required

data.nickname

any

required

data.remark

string

required

data.transfer_method

string

required

data.updated_at

string

required

links

object

required

Show child attributes

links.first

string

required

links.last

string

required

links.next

string

required

links.prev

any

required

meta

object

required

Show child attributes

meta.current_page

number

required

meta.from

number

required

meta.last_page

number

required

meta.links

object[]

required

Show child attributes

meta.links.active

boolean

required

meta.links.label

string

required

meta.links.url

string

meta.path

string

required

meta.per_page

number

required

meta.to

number

required

meta.total

number

required