OPopenpayd

List Bank Beneficiaries

Get a list of all bank beneficiaries for a parent beneficiary.

get/beneficiaries/{parentId}/banks

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/beneficiaries/{parentId}/banks
  • Auth
    API key in header Authorization

Path parameters

parentIdstring required

id (UUID) from the create beneficiary request for the parent beneficiary under who the bank beneficiary was created.

Query parameters

externalIdstring

externalId (UUID) of the bank beneficiary.

friendlyNamestring
statusstring

PENDING, VALID, INVALID

pagedboolean
unpagedboolean
pageNumberinteger
pageSizeinteger
offsetinteger
sortedboolean
unsortedboolean

Response

200

Changes

No recorded changes to this operation across all 1 revision of this API.