Skip to main content
GET
/
payees
/
{payeeId}
Retrieve a payee
curl --request GET \
  --url https://test.onlinecheckwriter.com/api/v3/payees/{payeeId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "RJ6qGAAxJPGE1rD",
    "name": "John Doe",
    "nickName": "JD",
    "company": "Company A",
    "email": "johndoe@example.com",
    "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.

Path Parameters

​
payeeId
string
required

The ID of the payee to retrieve.

Example:

"RJ6qGAAxJPGE1rD"

Response

Successful response with payee details.

​
success
boolean
Example:

true

​
data
object