Skip to main content
POST
/
v3
/
oauth
/
billing
/
refunds
Refund a captured OAuth billing charge
curl --request POST \
  --url https://api.scalev.com/v3/oauth/billing/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund_idempotency_key": "<string>",
  "reason_code": "<string>",
  "reason": "<string>",
  "billing_reservation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_charge_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {}
}
'
{
  "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_charge_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_reservation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refund_status": "succeeded",
  "amount": 123,
  "currency": "IDR",
  "reason_code": "<string>",
  "reason": "<string>",
  "merchant_volt_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "developer_earnings_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inserted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Either billing_reservation_id or billing_charge_id is required. If both are supplied, they must identify the same captured charge. Refunds are full post-capture reversals.

​
refund_idempotency_key
string
required
Required string length: 1 - 255
​
reason_code
string
required
Required string length: 1 - 100
​
reason
string
required
Required string length: 1 - 1000
​
billing_reservation_id
string<uuid> | null
​
billing_charge_id
string<uuid> | null
​
metadata
object

Response

OAuth billing refund

​
refund_id
string<uuid>
required
​
billing_charge_id
string<uuid>
required
​
billing_reservation_id
string<uuid>
required
​
refund_status
enum<string>
required
Available options:
succeeded
​
amount
integer
required
​
currency
enum<string>
required
Available options:
IDR
​
reason_code
string
required
​
reason
string
required
​
merchant_volt_transaction_id
string<uuid>
required
​
developer_earnings_entry_id
string<uuid>
required
​
inserted_at
string<date-time>
required