Skip to main content

Get All Order Status

By this API all order statues can be retrieved. Each order's status will be denoted by it's UUID. Can be filtered by status type as query (?type=). Types are listed below: 

  • Paid
  • Invoiced

Endpoint

GET 

Example

URL
https://demo-api.frontpayment.no/api/v1/connect/orders/status?type=Paid
Endpoint:https://demo-api.frontpayment.no/api/v1/connect/orders/status
Method :GET
Authorization:Bearer
Response Structure:

Authentication

This endpoint requires a Bearer Token for authentication. You will need to obtain this token from Frontpayment and include it in the Authorization header of your request.

Example Authorization Header: Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN

Response

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

// Success
{
    "status_code": 200,
    "status_message": "OK",
    "message": "Order Status Retrieved Successfully",
    "is_data": true,
    "data": [
      {
        "uuid": "String",
        "status": "String"
      },
      {
        "uuid": "String",
        "status": "String"
      }
    ]
}
//
Errors

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": "Order Not Found"orderNotFound",
    "is_data"is_error": false,
    "data"errors": null
}

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"
}
Example Response:

 

{
  "status_code": 200,
  "status_message": "OK",
  "message": "Order Status Retrieved Successfully",
  "is_data": true,
  "data": [
    {
      "uuid": "ODR347888404",
      "status": "REFUNDED"
    },
    {
      "uuid": "ODR139036234",
      "status": "PAID"
    }
  ]
}