7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Docs

Guides & Documentation

Overview Quick Start Authentication Changelog

API Operations

All Operations

Account

Request Passwordless TokenPOST Verify Passwordless TokenPOST

POBox

Update Auto Renew ConfigurationPOST

CRM

Approve CRM AgentPOST Approve CRM RentalPOST

GuestRenewal

Confirm Guest Renewal PaymentPOST Guest Renewal DetailsGET Guest Renewed By OptionsGET Calculate Guest Renewal PricingPOST Save Guest Renewal DetailsPOST Send Guest Renewal NotificationPOST Charges For Guest Additional Renewal ServicesGET

Guest

Issuing Entities For Escher GuestGET Update Guest Auto Renew ConfigurationPOST

MOE

MOE Entities By IDGET MOE Entities By License NumberGET MOE Issuing EntitiesGET

Renewal

Cancel PO Box RenewalDELETE Renewal AgentsGET Process Renewal PaymentPOST Process Tijari Renewal PaymentPOST Save Renewal AgentPOST Save Tijari Renewal DetailsPOST Update Renewal AgentPUT Validate Renewal CancellationGET Verify Renewal CancellationPOST Renewal Additional DetailsGET PO Box Renewal DetailsGET Additional Renewal OptionsGET Charges For Additional Renewal ServicesGET Confirm Renewal PaymentPOST Renewed By OptionsGET Calculate PO Box Renewal PricingPOST Save PO Box Renewal DetailsPOST

ChangeAddress

Confirm Address Change PaymentPOST Save Address Change RequestPOST

ChangeLock

Confirm Lock Change PaymentPOST Save Lock Change RequestPOST

Rental

Rental Bundle DetailsGET Rental Expiry DatesGET Available Free BoxesGET PO Box Rental LocationsGET Rejected Box DetailsGET Rental Renewal DetailsGET Save PO Box Rental RequestPOST Select PO Box For RentalPOST Update Rental Payment StatusPOST Update Rejected Box DetailsPOST

Doc Hub

EP.Retail.PoBox.BackEnd.API EndPoints/ChangeLock//api/v1/ChangeLock/Confirm/{paymentRefNo}

Docs

Guides & Documentation

Overview Quick Start Authentication Changelog

API Operations

All Operations

Account

Request Passwordless TokenPOST Verify Passwordless TokenPOST

POBox

Update Auto Renew ConfigurationPOST

CRM

Approve CRM AgentPOST Approve CRM RentalPOST

GuestRenewal

Guest

Issuing Entities For Escher GuestGET Update Guest Auto Renew ConfigurationPOST

MOE

MOE Entities By IDGET MOE Entities By License NumberGET MOE Issuing EntitiesGET

Renewal

ChangeAddress

Confirm Address Change PaymentPOST Save Address Change RequestPOST

ChangeLock

Confirm Lock Change PaymentPOST Save Lock Change RequestPOST

Rental

Doc Hub

EP.Retail.PoBox.BackEnd.API EndPoints/ChangeLock//api/v1/ChangeLock/Confirm/{paymentRefNo}

Overview

Confirms payment outcome for a submitted lock-change request. Finalizes lock-change payment status for downstream fulfillment.

Request builder

POST

/api/v1/ChangeLock/Confirm/{paymentRefNo}

paymentRefNo*string

api-versionstring

Reference details

Path Parameters

paymentRefNo*string

Query Parameters

api-version?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/ChangeLock/Confirm/string"

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "paymentStatus": "Started",  "orderNumber": "string",  "isPaymentSuccess": true,  "paymentDetails": {    "paymentRefNo": "string",    "amountPaid": 0.1,    "paymentDate": "2019-08-24T14:15:22Z",    "paymentPeriod": "string",    "maskedCard": "string",    "cardScheme": "string",    "cardExpiry": "string",    "invoiceUrl": "string"  },  "transactionDetails": {    "poBox": "string",    "emirateName": "string",    "officeName": "string",    "bundleDesc": "string",    "boxExpiryDate": "string",    "sunScriptionStartDate": "string",    "sunScriptionEndDate": "string",    "agentId": "string",    "awbNo": "string",    "uniqueBoxId": "string",    "custProfId": "string"  },  "retryUrl": "string",  "isAutoRenewEnabled": true,  "autoRenewRefNo": "string"}

{  "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}

Overview

Confirms payment outcome for a submitted lock-change request. Finalizes lock-change payment status for downstream fulfillment.

Request builder

POST

/api/v1/ChangeLock/Confirm/{paymentRefNo}

paymentRefNo*string

api-versionstring

Reference details

Path Parameters

paymentRefNo*string

Query Parameters

api-version?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/ChangeLock/Confirm/string"

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "paymentStatus": "Started",  "orderNumber": "string",  "isPaymentSuccess": true,  "paymentDetails": {    "paymentRefNo": "string",    "amountPaid": 0.1,    "paymentDate": "2019-08-24T14:15:22Z",    "paymentPeriod": "string",    "maskedCard": "string",    "cardScheme": "string",    "cardExpiry": "string",    "invoiceUrl": "string"  },  "transactionDetails": {    "poBox": "string",    "emirateName": "string",    "officeName": "string",    "bundleDesc": "string",    "boxExpiryDate": "string",    "sunScriptionStartDate": "string",    "sunScriptionEndDate": "string",    "agentId": "string",    "awbNo": "string",    "uniqueBoxId": "string",    "custProfId": "string"  },  "retryUrl": "string",  "isAutoRenewEnabled": true,  "autoRenewRefNo": "string"}

{  "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}

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Path Parameters

Query Parameters

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`