Fence API v3
Connect your systems to Fence
Send your asset programs' assets, payment plans, payments and asset groups, and read what Fence works out from them. Every endpoint is in the API reference; sign in to see the exact shape your own programs' records must have.
Start here
- Quickstart: your first accepted batch
From the credentials Fence gives you to a first asset Fence has accepted, in five calls.
- How Fence's API works
What Fence does with the data you send, the asset program everything belongs to, your ids and Fence's, and who may call what.
- Conventions
Ids, pages, amounts, dates and errors: the rules every route follows.
Concepts
- Asset programs and their rules
What each setting of your asset program decides, and where to read them.
- Submissions and records
How a batch becomes a submission, how Fence decides each record, and how to know a batch is done.
- Assets and asset groups
Declare your assets and the data they share, link them, and remove an asset declared by mistake.
- Payment plans and expected payments
Send a plan as terms Fence calculates or as your own schedule, change it, and read the expected payments.
- Payments and allocation
The four types of payment, how Fence places each on its asset, and how it works out what each paid.
- Asset state
Lifecycle, performance, delinquency bands and defaults: what Fence works out for each asset, and your program's rules for it.
How to
- Send your whole book
Send asset groups, assets, payment plans and payments in the right order, and check each batch.