Skip to main content
GET
/
payees
Retrieve all payees
curl --request GET \
  --url https://test.onlinecheckwriter.com/api/v3/payees \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "meta": {
      "total": 100,
      "currentPage": 1,
      "perPage": 1
    },
    "payees": [
      {
        "payeeId": "RJ6qGAAxJPGE1rD",
        "name": "John Doe",
        "nickName": "JD",
        "company": "Company A",
        "email": "[email protected]",
        "phone": "1234567890",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "City",
        "state": "ST",
        "zip": "12345",
        "country": "US"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
perPage
integer
default:10

Number of records to retrieve per page. Default is 10.

Example:

10

​
page
integer
default:1

Page number for paginated results. Default is 1.

Example:

1

​
term
string

Filter records using any keywords.

Example:

"John"

Response

Successful response with a list of payees.

​
success
boolean
Example:

true

​
data
object