Skip to main content
POST
/
api
/
credits
/
{credit_id}
/
void
/
cURL
curl --request POST \
  --url https://api.uselotus.io/api/credits/{credit_id}/void/ \
  --header 'Authorization: <api-key>'
{
  "credit_id": "<string>",
  "customer": {
    "customer_name": "<string>",
    "email": "jsmith@example.com",
    "customer_id": "<string>"
  },
  "amount": 5000000000,
  "amount_remaining": 5000000000,
  "currency": {
    "code": "<string>",
    "name": "<string>",
    "symbol": "<string>"
  },
  "description": "<string>",
  "effective_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "status": "active",
  "amount_paid": 0,
  "amount_paid_currency": {
    "code": "<string>",
    "name": "<string>",
    "symbol": "<string>"
  },
  "drawdowns": [
    {
      "credit_id": "<string>",
      "amount": -5000000000,
      "description": "<string>",
      "applied_at": "2023-11-07T05:31:56Z"
    }
  ]
}
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
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
credit_id
string
required

The ID of the credit to retrieve or update.

Response

200 - application/json
​
credit_id
string
required
​
customer
object
required
​
amount
number
required
Required range: 0 <= x < 10000000000
​
amount_remaining
number
required
Required range: 0 <= x < 10000000000
​
currency
object
required
​
description
string | null
required
​
effective_at
string<date-time>
required
​
expires_at
string<date-time> | null
required
​
status
enum<string>
required
  • active - Active
  • inactive - Inactive
Available options:
active,
inactive
​
amount_paid
number
required
Required range: -10000000000 < x < 10000000000
​
amount_paid_currency
object
required
​
drawdowns
object[]
required