VEvelopaymentsapi
Payor Hierarchy

List Payor Links

Changed on

If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy

get/v1/payorLinks

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Query parameters

descendantsOfPayorstring uuid

The Payor ID from which to start the query to show all descendants

parentOfPayorstring uuid

Query for the parent payor details for this payor id

fieldsstring
<p>List of additional Payor fields to include in the response for each Payor</p> <p>The values of payorId and payorName are always included for each Payor by default</p> <p>You can add fields to the response for each payor by including them in the fields parameter separated by commas</p> <p>The supported fields are any combination of: primaryContactEmail,kycState</p>

Response

Details of Payor Links

Example response

{
  "payors": [
    {
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "kycState": "kycState",
      "primaryContactEmail": "primaryContactEmail",
      "payorName": "payorName"
    },
    {
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "kycState": "kycState",
      "primaryContactEmail": "primaryContactEmail",
      "payorName": "payorName"
    }
  ],
  "links": [
    {
      "toPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "fromPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkType": "linkType"
    },
    {
      "toPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "fromPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkType": "linkType"
    }
  ]
}

Changes

  • 3cf504795910Revision changes
    • info

      api operation id payorLinks removed and replaced with payorLinksV1

    • info

      api tag Payor Hierarchy added

    • info

      api tag Payors removed

  • 1e7a1734a45cRevision changes
    • info

      removed the FAILED_KYC enum value from the // response property for the response status

    • info

      removed the PARENT_OF enum value from the // response property for the response status

    • info

      removed the PASSED_KYC enum value from the // response property for the response status

    • info

      removed the REQUIRES_KYC enum value from the // response property for the response status