7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Saves standard PO Box renewal payload and creates/updates renewal order data. Returns order references and payment gateway details when payment is needed.

Request builder

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

requestSource?Source

Value in

"Web"
"Mobile"
"AutoRenewJobEngine"
"Wayn"
"Escher"

boxNumber*integer

Formatint32

emirateCode*string

Length1 <= length

expiryDate*string

Formatdate-time

Length1 <= length

isBundleChanged?boolean

renewedBy?string

newBundleId?string

totalAmount?number

Formatdouble

physicalBoxRequired?boolean

customerKYC?

changeAddress?

discountRequest?

paymentProperties?

resellerId?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Renewal/Save" \  -H "Content-Type: application/json" \  -d '{    "boxNumber": 0,    "emirateCode": "string",    "expiryDate": "2019-08-24T14:15:22Z"  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "orderNumber": "string",  "orderExpiryDate": "2019-08-24T14:15:22Z",  "revenueOfficeId": "string",  "officeId": "string",  "uniqueBoxId": "string",  "paymentGateWayResponse": {    "paymentUrl": "string",    "referenceNumber": "string",    "niOrderResult": null,    "savedCardResponse": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Query Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`