Skip to main content

Cancel Refund Request

This API allows you to cancel Refund request into Terminal.

Endpoint

POST https://demo-api.frontpayment.no/api/v1/connect/terminal/orders/cancel/{{ORDER_UUID}}

Authorization

Include a Bearer Token in the Authorization header. You can obtain this token from Front Payment.

API

returnsa
Endpoint:https://demo-api.frontpayment.no/api/v1/connect/terminal/orders/cancel/{{ORDER_UUID}}
Method:POST
Authorization:Bearer
Payload Validation:

 Example:

'type'=>Authorization: 'required|string'Bearer YOUR_FRONTPAYMENT_BEARER_TOKEN
Example

Request Payload

:

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

{
    "type": "refund"
}

Validation Rules

Make sure your request meets the following requirements:

FieldTypeDescription
typestringRequired Using type. Available type is refund

Response Structure

:

A

successful 
request will return a 200 //OK Successstatus {with "status_code":the 200,following "status_message":JSON "OK",
    "message": "refundRequestRejectedSuccessfully",
    "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": 510,
"status_message": "Execution Exception Occurred",
"message": "somethingWentWrong",
"is_error": true,
"errors": "Array"
}
Example Response:

 payload:

{
    "status_code": 200,
    "status_message": "OK",
    "message": "refundRequestRejectedSuccessfully",
    "is_data": false,
    "data": null
}
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_data": false,
    "data": null
}

API returns a 417 error, it means requested payload is not valid.

{
    "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": "Something Went Wrong",
    "is_error": true,
    "errors": "Array"
}
Back to top