Transfers
Create a transfer program
PlannedPut a transfer program in place on a facility: the triggers, the transition budget cap and the standby list of vetted buyers.
post/v1/facilities/{facility_id}/transfer-program
transfer:writePath parameters
- facility_idSynpute IDrequired
- Facility ID e.g. SYN-FC-5D20
Body parameters
- budget_capobjectrequired
- Transition budget cap
+Show propertiesHide properties
- amountinteger
- Amount in the currency's minor unit (cents)
- currencystring
- ISO 4217 currency
USDEURGBP
- triggersarray of stringrequired
- Triggers
Response 201 · TransferProgram
- budget_capobjectrequired
- Most the transition can cost, paid from collections
+Show propertiesHide properties
- amountinteger
- Amount in the currency's minor unit (cents)
- currencystring
- ISO 4217 currency
USDEURGBP
- eligible_buyersintegerrequired
- Vetted buyers on the standby list
- facilitySynpute IDrequired
- Facility
- idstringrequired
- Transfer program ID
- objectstringrequired
- Object type
- statusstringrequired
- State
activesuspendedended- triggersarray of stringrequired
- What lets the lender start a transfer
Errors
404409return the standard error shape.