7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Confirms payment completion for an address-update request using payment reference number. Returns normalized payment result details for downstream shipment update completion.

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Path Parameters

paymentReferenceNo*string

Query Parameters

api-version?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Shipments/ConfirmUpdateAddress/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}

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`