Deals
Read and update deals routed to your lane. You never create one: a business applies on the marketplace, the request is matched against your lane, and the deal is pushed to your endpoint or waits in the list. See the deal lifecycle guide for the three ways a deal can reach you and for what the object carries before and after the client uploads documents.
Read and update deals routed to your lane. You never create one: a business applies on the marketplace, the request is matched against your lane, and the deal is pushed to your endpoint or waits in the list. See the deal lifecycle guide for the three ways a deal can reach you and for what the object carries before and after the client uploads documents.
| Operation | Method | Path |
|---|---|---|
| List deals routed to you | GET | /deals |
| Retrieve a deal | GET | /deals/{ref} |
| Report a deal's outcome | POST | /deals/{ref}/status |
| Submit an indicative offer | POST | /deals/{ref}/indicative-offer |
| Submit a firm offer | POST | /deals/{ref}/firm-offer |
| List your offers on a deal | GET | /deals/{ref}/offers |
| Attach a handover link | POST | /deals/{ref}/handover |
| Read your credit box | GET | /creditbox |
Every page below is generated from the OpenAPI document, carries a request sample in the language you pick, and sends to the sandbox server from its playground.
