Credits
Void credit
POST
/
api
/
credits
/
{credit_id}
/
void
/
Immediately voids a credit. If the credit is already expired or has already been consumed, nothing will happen.
Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Path Parameters
credit_id
string
requiredThe ID of the credit to retrieve or update.
Response
200 - application/json
amount
number
requiredamount_paid
number
requiredamount_paid_currency
object
requiredamount_remaining
number
requiredcredit_id
string
requiredcurrency
object
requiredcustomer
object
requireddescription
string | null
requireddrawdowns
object[]
requiredeffective_at
string
requiredexpires_at
string | null
requiredstatus
enum<string>
requiredactive
- Activeinactive
- Inactive
Available options:
active
, inactive