action velopayments_payor_links_v1 { label: "List Payor Links" description: "

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

\n" provider: velopayments method: GET path: "/v1/payorLinks" encoding: json input: { type: "object" properties: { descendantsOfPayor: { type: "string" format: "uuid" } fields: { type: "string" } parentOfPayor: { type: "string" format: "uuid" } } additionalProperties: false } output: { type: "object" description: "List Payor Links Response Object" properties: { links: { type: "array" items: { required: ["fromPayorId", "linkId", "linkType", "toPayorId"] properties: { fromPayorId: { type: "string" format: "uuid" } linkId: { type: "string" format: "uuid" } linkType: { type: "string" description: "The type of the link. One of the following values: PARENT_OF" } toPayorId: { type: "string" format: "uuid" } } } } payors: { type: "array" items: { required: ["payorId", "payorName"] properties: { kycState: { type: "string" description: "Current KYC state. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC" } payorId: { type: "string" format: "uuid" } payorName: { type: "string" } primaryContactEmail: { type: "string" } } } } } } }