H!HOPPA
GET/api/v2/banking/payees

List payees across all banking providers

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
Limit (query)unknownNo
Page (query)unknownNo
Currency (query)stringNo
SearchName (query)stringNo
userId (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Payeesarray of UnifiedPayeeNo
TotalunknownNo
PageunknownNo
LimitunknownNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/banking/payees" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.