OPopenpayd

Get Beneficiary

Get a beneficiary by its UUID.

get/beneficiaries/{id}

Request

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

Path parameters

idstring required

id (UUID) of the beneficiary from the create beneficiary request.

Response

200

idstring
accountHolderIdstring
beneficiaryTypestring
companyNamestring
tagstring
uploadedKycDocumentboolean

Example response

{
  "id": "1f9e41c7-cbf2-4287-ba23-eb3f287ac3f6",
  "accountHolderId": "1f9e41c7-cbf2-4287-ba23-eb3f287ac3f6",
  "beneficiaryType": "CORPORATE",
  "companyName": "Apple Inc.",
  "tag": "THIRD_PARTY"
}

Changes

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