List Payees

Velo Payments Sandbox for testing

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

GET

/v4/payees

Get a paginated response listing the payees for a payor.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v4/payees?payorId='

Response Example

200 - Example 1

{
    "content": [
        {
            "company": {
                "name": "ABC Group Plc",
                "operatingName": "ABC Co"
            },
            "country": "US",
            "created": "2019-01-20T09:00:00Z",
            "disabled": true,
            "disabledComment": "reason for disabled",
            "disabledUpdatedTimestamp": "2019-01-20T09:00:00Z",
            "displayName": "ABC",
            "email": "bob@example.com",
            "individual": {
                "name": {
                    "firstName": "Bob",
                    "lastName": "Smith",
                    "otherNames": "H",
                    "title": "Mr"
                }
            },
            "language": "en-US",
            "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
            "payorRefs": [
                {
                    "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                    "payableIssues": [
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        },
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        }
                    ],
                    "payableStatus": true,
                    "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                    "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                    "remoteId": "uniqueIdForRemoteEntity"
                },
                {
                    "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                    "payableIssues": [
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        },
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        }
                    ],
                    "payableStatus": true,
                    "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                    "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                    "remoteId": "uniqueIdForRemoteEntity"
                }
            ],
            "watchlistOverrideComment": "Example reason for the watchlist status being overridden",
            "watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00"
        },
        {
            "company": {
                "name": "ABC Group Plc",
                "operatingName": "ABC Co"
            },
            "country": "US",
            "created": "2019-01-20T09:00:00Z",
            "disabled": true,
            "disabledComment": "reason for disabled",
            "disabledUpdatedTimestamp": "2019-01-20T09:00:00Z",
            "displayName": "ABC",
            "email": "bob@example.com",
            "individual": {
                "name": {
                    "firstName": "Bob",
                    "lastName": "Smith",
                    "otherNames": "H",
                    "title": "Mr"
                }
            },
            "language": "en-US",
            "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
            "payorRefs": [
                {
                    "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                    "payableIssues": [
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        },
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        }
                    ],
                    "payableStatus": true,
                    "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                    "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                    "remoteId": "uniqueIdForRemoteEntity"
                },
                {
                    "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                    "payableIssues": [
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        },
                        {
                            "code": "3",
                            "message": "payee-disabled"
                        }
                    ],
                    "payableStatus": true,
                    "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                    "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                    "remoteId": "uniqueIdForRemoteEntity"
                }
            ],
            "watchlistOverrideComment": "Example reason for the watchlist status being overridden",
            "watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00"
        }
    ],
    "links": [
        {
            "href": "href",
            "rel": "rel"
        },
        {
            "href": "href",
            "rel": "rel"
        }
    ],
    "page": {
        "numberOfElements": 10,
        "page": 10,
        "pageSize": 10,
        "totalElements": 10,
        "totalPages": 10
    },
    "summary": {
        "totalInvitedCount": 10,
        "totalOnboardedCount": 10,
        "totalPayeesCount": 10,
        "totalRegisteredCount": 10,
        "totalWatchlistFailedCount": 0
    }
}

Request

Query Params

Responses

🟢200Details of Payee

application/json

Body

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

🟠401Invalid access token. May be expired or invalid

🟠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

Update Payee Remote Id

List Payee Changes