Skip to main content
The Payee Address API allows you to create and manage address records associated with an existing payee. A payee address represents the physical mailing or address linked to a recipient identity. Payee records must exist before an address can be attached.

​
What This API Provides

The Payee Address API enables your integration to:
  • Add an address to an existing payee
  • Retrieve a stored payee address
  • Update address details
  • Delete an address when it is no longer valid
All address fields should follow standard US postal formatting when applicable.

​
Available APIs

Create Address

Attach a new address to an existing payee.

List Addresses

Retrieve all addresses associated with a payee.

Get Address

Retrieve a specific address by ID.

Update Address

Modify an existing address record.

Set Default Address

Mark an address as the default address for the payee.

Delete Address

Remove an address from a payee.

​
Typical Integration Flow

1

1. Ensure payee exists

Create the payee using the Payee API before attaching an address.
2

2. Create the address

Call Create Payee Address with properly formatted address fields.
3

3. Maintain accuracy

Update address details if the recipient relocates or information changes.
4

4. Remove outdated addresses

Delete addresses that are no longer valid.

​
Best Practices

  • Store state values using two-letter abbreviations (example: CA, NY, TX).
  • Use ISO country codes (example: US).
  • Validate ZIP codes before submission.
  • Avoid storing multiple conflicting addresses for the same payee unless required by your business logic.