API Reference

An associate id is a short secure alias that points to an object in the database.

Below is an sample associate id of an invoice/order.

f2f135

Resource Ids

The resource id is a complete unique id of the object in the database. It is designed so that a human can easily understand what type of object the associate id points to.

Example:

INV-f2f135 # Invoice
EST-f2f135 # Escrow transaction
DPL-f2f135 # Payment link

Below is a complete table of all the resource id prefixes and their corresponding object type.

PrefixObject
INVInvoice/Order
ESTEscrow transaction
DPLPayment link
CUSCustomer
PSP_DISBDisbursement
PSP_DEPDirect deposit