Get a Payee

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": "[email protected]",
    "phone": "1234567890",
    "address1": "Address 1",
    "address2": "Address 2",
    "city": "City",
    "state": "ST",
    "zip": "12345",
    "country": "US"
  }
}

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": "[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.

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

Show child attributes

data.id

string

Example:

"RJ6qGAAxJPGE1rD"

data.name

string

Example:

"John Doe"

data.nickName

string

Example:

"JD"

data.company

string

Example:

"Company A"

data.email

string

Example:

"[email protected]"

data.phone

string

Example:

"1234567890"

data.address1

string

Example:

"Address 1"

data.address2

string

Example:

"Address 2"

data.city

string

Example:

"City"

data.state

string

Example:

"ST"

data.zip

string

Example:

"12345"

data.country

string

Example:

"US"

Get Payees Create Payee

⌘I

Get Started

Bank Account

Payee

Check

Mail Check

Authorizations

Path Parameters

Response