Refund consumption

Refund consumption.

PATH:

/v1/clients/{clientId}/consumptions/{consumptionId}/refunds/{refundId}

PATH PARAMETERS:

clientId

required

integer

Your assigned ClientId.

consumptionId

required

string

Id of the consumption.

refundId

required

string

Id of the refund.

RESPONSES:

200 Success, Consumption is refunded.

RESPONSE SCHEMA:

consumptionTotal

consumptionTotal object

The totals of the consumption.

grossAmount

number decimal

The gross amount.

vatAmount

number decimal

The VAT amount.

currencyCode

string

The currency code.

refundTotal

refundTotal object

The totals of the refund(s).

grossAmount

number decimal

The gross amount.

vatAmount

number decimal

The VAT amount.

currencyCode

string

The currency code.

400 Bad request.

RESPONSE SCHEMA:

undefined

401 Missing or invalid "Authorization" header.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

403 Lacking permissions.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

500 Unexpected internal server error.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

Path

put

/v1/clients/{clientId}/consumptions/{consumptionId}/refunds/{refundId}

Response samples

200400401403500

              {
                  
"consumptionTotal": {...
                          "currencyCode": "string"
                        
},
"refundTotal": {...
                          "currencyCode": "string"
                        
}
}

undefined

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            