Skip to main content
POST
Create a credit refund

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
credit_transaction_id
string
required

Id of the credit_purchase lot to refund against.

Maximum string length: 128
amount_cents
integer
required

Amount to refund, in wallet cents. Must not exceed the lot's remaining refundable balance.

Required range: 1 <= x <= 1000000000
reason
string

Optional reason attached to the refund and audit log.

Maximum string length: 500

Response

200 - application/json

The created refund request and its processing status.

data
object
meta
object