POST
/
v1
/
charge
/
adjust
curl --request POST \
  --url https://api.decodahealth.com/v1/charge/adjust \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '{
  "amount": 123,
  "chargeId": "<string>",
  "providerId": "<string>",
  "reason": "<string>"
}'
{
  "adjustmentType": "WRITE_OFF",
  "amount": 123,
  "chargeId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "providerId": "<string>",
  "reason": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
amount
integer
required
chargeId
string
required
reason
string
required
providerId
string | null

Response

200
application/json
Successful Response
adjustmentType
enum<string>
required

Type of the adjustment

Available options:
WRITE_OFF,
ADJUSTMENT,
EXTERNAL_SETTLEMENT
amount
integer
required

Amount of the adjustment

chargeId
string
required
createdDate
string
required

Date when the adjustment was created

id
string
required

Unique identifier for the adjustment

providerId
string | null
reason
string | null

Reason for the adjustment