7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Confirms payment completion for guest renewal transactions using a payment reference. Finalizes renewal payment status and returns payment details for client follow-up.

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"

paymentReferenceNumber*string

Length1 <= length

transactionType?eCRMTransactionType

Value in

"AddAgent"
"EditAgent"
"CorporateRental"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Guest/Renewal/ConfirmPayment" \  -H "Content-Type: application/json" \  -d '{    "paymentReferenceNumber": "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}

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`