7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Creates agent renewal records and optionally prepares payment order information. Accepts agent profile and payment properties to continue the renewal journey.

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"

quantity?integer

Formatint32

amount?number

Formatdouble

boxNumber*integer

Formatint32

emirateCode*string

Length1 <= length

boxAgentDetails*array<>

paymentProperties?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Renewal/SaveAgent" \  -H "Content-Type: application/json" \  -d '{    "boxNumber": 0,    "emirateCode": "string",    "boxAgentDetails": [      {}    ]  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "orderNumber": "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`