List Payor Links

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v1/payorLinks

This endpoint allows you to list payor links

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v1/payorLinks'

Response Example

200 - Example 1

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

Request

Query Params

Responses

🟢200Details of Payor Links

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:18

Create a quote for the payout

Get Payor