Use v4 instead
Get a paginated response listing the payees for a payor.643 matches
88 actions
Velo Payments
88 actions
- Add LogoPOSTv1.0.0
- Create a Payor LinkPOSTv1.0.0
- Create a quote for the payoutPOSTv1.0.0
- Create API KeyPOSTv1.0.0
- Create ApplicationPOSTv1.0.0
- Create Funding AccountPOSTv1.0.0
- Create Funding RequestPOSTv1.0.0
- Create Funding RequestPOSTv1.0.0
- Delete a source account by IDDELETEv1.0.0
- Delete a UserDELETEv1.0.0
- Delete Payee by IdDELETEv1.0.0
- Delete Payee by IdDELETEv1.0.0
- Deschedule a payoutDELETEv1.0.0
- Disable a UserPOSTv1.0.0
- Enable a UserPOSTv1.0.0
- Get BrandingGETv1.0.0
- Get details about given source account.GETv1.0.0
- Get FundingGETv1.0.0
- Get Funding AccountGETv1.0.0
- Get Funding AccountsGETv1.0.0
- Get Funding Audit DeltaGETv1.0.0
- Get Fundings for PayorGETv1.0.0
- Get List of PaymentsGETv1.0.0
- Get list of source accountsGETv1.0.0
- Get list of source accountsGETv1.0.0
- Get Payee by IdGETv1.0.0
- Get Payee by IdGETv1.0.0
- Get Payee Invitation StatusGETv1.0.0
- Get Payee Invitation StatusGETv1.0.0
- Get PaymentGETv1.0.0
- Get Payments for PayoutGETv1.0.0
- Get PayorGETv1.0.0
- Get PayorGETv1.0.0
- Get Payout StatisticsGETv1.0.0
- Get Payout SummaryGETv1.0.0
- Get Payouts for PayorGETv1.0.0
- Get SelfGETv1.0.0
- Get Source AccountGETv1.0.0
- Get UserGETv1.0.0
- Initiate Payee CreationPOSTv1.0.0
- Initiate Payee CreationPOSTv1.0.0
- Instruct PayoutPOSTv1.0.0
- Invite a UserPOSTv1.0.0
- List Payee ChangesGETv1.0.0
- List Payee ChangesGETv1.0.0
- List PayeesGETv1.0.0
- List PayeesGETv1.0.0
- List Payment ChangesGETv1.0.0
- List Payment Channel Country RulesGETv1.0.0
- List Payor LinksGETv1.0.0
- List Supported CountriesGETv1.0.0
- List Supported CountriesGETv1.0.0
- List Supported CurrenciesGETv1.0.0
- List UsersGETv1.0.0
- LogoutPOSTv1.0.0
- Register SMS NumberPOSTv1.0.0
- Reminder Email Opt-OutPOSTv1.0.0
- Resend Payee InvitePOSTv1.0.0
- Resend Payee InvitePOSTv1.0.0
- Reset passwordPOSTv1.0.0
- Retrieve payments for a payoutGETv1.0.0
- Schedule a payoutPOSTv1.0.0
- Set notificationsPOSTv1.0.0
- Set notificationsPOSTv1.0.0
- Submit PayoutPOSTv1.0.0
- Transfer Funds between source accountsPOSTv1.0.0
- Transfer Funds between source accountsPOSTv1.0.0
- Unlock a UserPOSTv1.0.0
- Unregister MFA for SelfPOSTv1.0.0
- Unregister MFA for the userPOSTv1.0.0
- Update Password for selfPOSTv1.0.0
- Update Payee DetailsPOSTv1.0.0
- Update Payee DetailsPOSTv1.0.0
- Update Payee Remote IdPOSTv1.0.0
- Update Payee Remote IdPOSTv1.0.0
- Update User DetailsPOSTv1.0.0
- Update User Details for selfPOSTv1.0.0
- Update User RolePOSTv1.0.0
- V1 Get Fundings for PayorGETv1.0.0
- V1 Get Payout StatisticsGETv1.0.0
- V1 List Payment ChangesGETv1.0.0
- V3 Get List of PaymentsGETv1.0.0
- V3 Get PaymentGETv1.0.0
- V3 Get Payments for PayoutGETv1.0.0
- V3 Get Payouts for PayorGETv1.0.0
- Validate the proposed passwordPOSTv1.0.0
- Withdraw a PaymentPOSTv1.0.0
- Withdraw PayoutDELETEv1.0.0
E-commerce/Velo Payments
List Payees
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
{
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"onboardedStatus": {
"type": "string",
"description": "Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED"
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"payeeCountry": {
"type": "string"
},
"payeeType": {
"type": "string",
"description": "Type of Payee. One of the following values: Individual, Company"
},
"payorId": {
"type": "string",
"format": "uuid"
},
"remoteId": {
"type": "string"
},
"sort": {
"type": "string"
},
"watchlistStatus": {
"type": "string",
"description": "Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED"
}
},
"required": [
"payorId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
{
"type": "object",
"description": "List Payees Response Object",
"properties": {
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"operatingName": {
"type": "string"
}
}
},
"country": {
"type": "string",
"description": "Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
},
"created": {
"type": "string",
"format": "date-time"
},
"disabled": {
"type": "boolean"
},
"disabledComment": {
"type": "string"
},
"disabledUpdatedTimestamp": {
"type": "string",
"format": "date-time"
},
"displayName": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"individual": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"otherNames": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
}
},
"language": {
"type": "string",
"description": "An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR>\nSee the /v1/supportedLanguages endpoint to list the available codes for an environment.\n"
},
"onboardedStatus": {
"type": "string",
"description": "Onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED"
},
"payeeId": {
"type": "string",
"format": "uuid"
},
"payeeType": {
"type": "string",
"description": "Type of Payee. One of the following values: Individual, Company"
},
"payorRefs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invitationStatus": {
"type": "string"
},
"invitationStatusTimestamp": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the invitation status is updated"
},
"payableIssues": {
"type": "array",
"description": "Indicates any conditions which prevent the payee from being payable for this payor",
"items": {
"type": "object",
"description": "payable issues for the payee and payor combination",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"payableStatus": {
"type": "boolean",
"description": "Indicates if the payee is payable for this payor"
},
"paymentChannelId": {
"type": "string",
"format": "uuid"
},
"payorId": {
"type": "string",
"format": "uuid"
},
"remoteId": {
"type": "string"
}
}
}
},
"watchlistOverrideComment": {
"type": "string"
},
"watchlistStatus": {
"type": "string",
"description": "Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED"
},
"watchlistStatusUpdatedTimestamp": {
"type": "string",
"format": "date_time"
}
}
}
},
"links": {
"type": "array",
"items": {
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"page": {
"properties": {
"numberOfElements": {
"type": "integer"
},
"page": {
"type": "integer"
},
"pageSize": {
"type": "integer"
},
"totalElements": {
"type": "integer"
},
"totalPages": {
"type": "integer"
}
}
},
"summary": {
"properties": {
"totalInvitedCount": {
"type": "integer"
},
"totalOnboardedCount": {
"type": "integer"
},
"totalPayeesCount": {
"type": "integer"
},
"totalRegisteredCount": {
"type": "integer"
},
"totalWatchlistFailedCount": {
"type": "integer"
}
}
}
}
}