Credits
Void credit
Credits
Void credit
POST
/api/credits/{credit_id}/void/
X-API-KEY*
Authorization*
curl --request POST \
--url https://api.uselotus.io/api/credits/{credit_id}/void/ \
--header 'Authorization: <authorization>' \
--header 'X-API-KEY: <x-api-key>'
Immediately voids a credit. If the credit is already expired or has already been consumed, nothing will happen.
lotus.void_credit(credit_id='credit_0569173ee6654369')
Authorizations
Authorization[header]required
string
Token-based authentication with required prefix "Token"
Path Parameters
credit_idrequired
string
The ID of the credit to retrieve or update.
Response
amountrequired
number
amount_paidrequired
number
amount_paid_currencyrequired
object
amount_remainingrequired
number
credit_idrequired
string
currencyrequired
object
customerrequired
object
descriptionrequired
string
drawdownsrequired
array
effective_atrequired
string
expires_atrequired
string
statusrequired
string
active
- Activeinactive
- Inactive
Available options:
active
, inactive
curl --request POST \
--url https://api.uselotus.io/api/credits/{credit_id}/void/ \
--header 'Authorization: <authorization>' \
--header 'X-API-KEY: <x-api-key>'