Sign in
Payors

List Payor Links

This endpoint allows you to list payor links

get/v1/payorLinks

Query parameters

descendantsOfPayorstring uuid

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

parentOfPayorstring uuid

Look for the parent payor details for this payor id

fieldsstring

List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: fields=primaryContactEmail,kycState - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState

Response

Details of Payor Links

Example response

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

Changes