Skip to main content

Request Refund Approval

Retrieve Product ID from Get Order Details API using reference. In the message field you need to pass the message why you can not complete the refund via regular refund flow, better to add the exact message received while trying to refund with the regular endpoint.

Endpoint

POST https://demo-api.frontpayment.no/api/v1/orders/refund/request/approval/{{ORDER_UUID}}

Authorization

To access this endpoint, include a Bearer Token in the Authorization header of your request. You can obtain this token from Frontpayment.

Example Authorization Header: Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN

Request Payload

Send the following parameters as a JSON object in the request body:

{
    "type": "regular",
    "grandTotal": 10,
    "products": [
        {
            "id": 5410,
            "amount": 10
        }
    ],
    "source": null,
    "reference": null,
}

Validation Rules

Make sure your request meets the following requirements:

FieldTypeDescription
typestringRequired Using type. Available types are regular, invoiced and reservation
grandTotalnumericRequired Grand total of the refunded amount.
products.*idnumericRequired Order product id. From which product you want to refund.
products.*.amountnumericRequired Refund amount for the product.
sourcestringConditional Required When type is reservation then this field is required. Available source are captured and charged
referencestringConditional Required

Response

A successful request will return a 201 OK status with the following JSON payload:

{
    "status_code": 201,
    "status_message": "OK",
    "message": "requestedOrderRefundSuccessfully",
    "is_data": false,
    "data": null
}

Error Response

API returns a 404 error, it means requested order with ORDER_UUID could not be found in our system.

{
    "status_code": 404,
    "status_message": "Not Found",
    "message": "orderNotFound",
    "is_error": false,
    "errors": null
}

API return a 417 error, it means request payload validation failed.

{
    "status_code": 417,
    "status_message": "Client Error",
    "message": "payloadValidationErrors",
    "is_error": true,
    "errors": "Array"
}

API returns a 510 error, it means something failed on the server side

{
    "status_code": 510,
    "status_message": "Execution Exception Occurred",
    "message": "somethingWentWrong",
    "is_error": true,
    "errors": "Array"
}

Others refund rejections errors

Endpoint

:

https://demo-api.frontpayment.no/api/v1/orders/refund/request/approval/{{ORDER_UUID}}

Method

:

POST

Authorization

:

Bearer

Payload Validation

:

 

'type' => 'required|string|in:regular,invoiced,reservation',
'grandTotal' => 'required|numeric',
'message' => 'required|string',
'products' => 'required|array',
'products.*.id' => 'required|numeric',
'products.*.amount' => 'required|numeric',
'source' => 'nullable|string|in:captured",charged|requiredIf('type') === reservation',
'reference' => 'nullable|string|requiredIf('type') === reservation

Example Payload

:

 

{
    "type": "reservation",
    "grandTotal": 55,
    "message": "refundRejectionForWeeklyThresholdExceed",
    "products": [
        {
            "id": 451,
            "amount": 30
        },
        {
            "id": 452,
            "amount": 25
        }
    ],
    "source": "charged",
    "reference": "CHA3852658817"
}

 

Response Structure

:

 

// Success
{
    "status_code": 201,
    "status_message": "OK",
    "message": "requestedOrderRefundSuccessfully",
    "is_data": false,
    "data": null
}

// Errors
{
"status_code": 417,
"status_message": "Client Error",
"message": "payloadValidationErrors",
"is_error": true,
"errors": "Array"
}


{
"status_code": 404,
"status_message": "Not Found",
"message": "orderNotFound",
"is_data": false,
"data": null
}


{
"status_code": 400,
"status_message": "Conflict of Business Logic",
"message": "refundRejectionForRefundedCancelledInvoicedOrderParamRefunded",
"is_data": false,
"data": null
}


{
"status_code": 400,
"status_message": "Conflict of Business Logic",
"message": "requestProductIdNotAvailable",
"is_data": false,
"data": null
}


{
"status_code": 400,
"status_message": "Conflict of Business Logic",
"message": "refundRejectionForRefundedCancelledInvoicedOrderParamCancelled",
"is_data": false,
"data": null
}


{
"status_code": 400,
"status_message": "Conflict of Business Logic",
"message": "refundRejectionForRefundedCancelledInvoicedOrderParamInvoiced",
"is_data": false,
"data": null
}


{
"status_code": 400,
"status_message": "Conflict of Business Logic",
"message": "orderRefundRequestAlreadySubmitted",
"is_data": false,
"data": null
}


{
"status_code": 510,
"status_message": "Execution Exception Occurred",
"message": "somethingWentWrong",
"is_error": true,
"errors": "Array"
}

 

Example Response

:

 

 

{
    "status_code": 201,
    "status_message": "OK",
    "message": "requestedOrderRefundSuccessfully",
    "is_data": false,
    "data": null
}

 
Back to top