Skip to main content
Use this endpoint to fetch the full details of a single contact by its unique ID. The response includes the contact’s current status, payment direction, bank account summary, tax information, and whether the contact is currently payment-ready.

​
Base URL

​
Authentication

All requests must include a Bearer token in the Authorization header.

​
Path Parameters

​
contactId
string
required
The unique identifier of the contact to retrieve. This is the same ID referenced as contact.id in payables.

​
Response

Returns a Contact object.
​
id
string
Unique identifier for the contact.
​
type
string
The contact type: payee or business.
​
status
string
The contact’s current status: active, archived, or revoked.
​
displayName
string | null
The contact’s display name, if set.
​
emails
string[]
Email addresses associated with the contact. Always empty for business-type contacts.
​
phone
string | null
Phone number for the contact. Always null for business-type contacts.
​
paymentDirection
string
Indicates the allowed payment direction for this contact. One of:
  • bidirectional — can both send and receive payments
  • can_pay — can only send payments
  • can_be_paid — can only receive payments
  • none — no payment capability configured
​
netTerms
number | null
Net payment terms in days, if configured.
​
bankAccount
object | null
Summary of the contact’s linked bank account. null if no bank account has been added.
​
taxInfo
object | null
Tax information for the contact. null if no tax info has been provided.
​
paymentReady
boolean
Whether this contact can currently receive payments. A contact is payment-ready when a valid bank account is on file and the contact is in active status.
​
createdAt
datetime
ISO 8601 timestamp of when the contact was created.
​
updatedAt
datetime | null
ISO 8601 timestamp of the most recent update. null if the contact has never been updated.
​
archivedAt
datetime | null
ISO 8601 timestamp of when the contact was archived. null if the contact is not archived.

​
Example Request

curl

​
Example Response

200
The paymentReady flag reflects whether a payment can be initiated to this contact right now. A contact may have a bank account on file but still have paymentReady: false if their account is in a non-active status.