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

User AccountDELETE User Account ProfileGET Update User Account ProfilePUT User LoginPOST User LogoutPOST Refresh Authentication TokenGET Login Via UAE PassGET Access TokenGET Update Mobile NumberPUT Verify Passwordless TokenPOST Get Application InfoPOST

Content

Content DetailsGET

Invoice

Download InvoiceGET

Notifications

Save Notification PreferencesPOST Notification PreferencesGET Notifications HistoryGET User Device TokenGET Register Device TokenPOST Send SMS OTPPOST Send Email OTPPOST Send IVR OTPPOST Verify OTPPOST

Payments

Add Payment CardPOST Payment CardDELETE Saved Payment CardsGET Download Payment InvoiceGET Payment HistoryGET Update Payment CardPOST

PoBoxes

Confirm Linking PO BoxPOST User PO BoxesGET Agency PO BoxesGET Agency Box Status FiltersGET PO Boxes By Mobile NumberGET Unlink PO BoxPOST Validate Linking PO BoxPOST

Shipments

Check Shipment OptionsGET Process Shipment ActionsPOST Calculate Shipment ChargesPOST Confirm Shipment Address Update PaymentPOST Get Shipment CountPOST Shipment DetailsGET Get Shipment ListPOST Shipment Tracking HistoryGET Update Shipment Delivery AddressPOST Update Shipment PO BoxPOST

Doc Hub

EP.Retail.PoBox.User.BackEnd.API EndPoints/Payments//api/v1/Payments/paymenthistory

Docs

Guides & Documentation

Overview Quick Start Authentication Changelog

API Operations

All Operations

Account

Content

Content DetailsGET

Invoice

Download InvoiceGET

Notifications

Payments

Add Payment CardPOST Payment CardDELETE Saved Payment CardsGET Download Payment InvoiceGET Payment HistoryGET Update Payment CardPOST

PoBoxes

Confirm Linking PO BoxPOST User PO BoxesGET Agency PO BoxesGET Agency Box Status FiltersGET PO Boxes By Mobile NumberGET Unlink PO BoxPOST Validate Linking PO BoxPOST

Shipments

Doc Hub

EP.Retail.PoBox.User.BackEnd.API EndPoints/Payments//api/v1/Payments/paymenthistory

Overview

Returns historical payment transactions filtered by optional date range. Covers PO Box and shipment-related charges visible to the current user.

Request builder

GET

/api/v1/Payments/paymenthistory

Access Token

FromDatestring

ToDatestring

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

FromDate?string

Formatdate-time

ToDate?string

Formatdate-time

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Payments/paymenthistory"

{  "message": "string",  "payload": [    {      "orderTitle": "string",      "orderReferenceNumber": "string",      "paymentStatus": "Started",      "orderType": "RENT",      "paymentDate": "2019-08-24T14:15:22Z",      "amount": 0.1,      "paymentMethodName": "string",      "invoiceURL": "string",      "enableInvoiceDownload": true    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": 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}

Overview

Returns historical payment transactions filtered by optional date range. Covers PO Box and shipment-related charges visible to the current user.

Request builder

GET

/api/v1/Payments/paymenthistory

Access Token

FromDatestring

ToDatestring

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

FromDate?string

Formatdate-time

ToDate?string

Formatdate-time

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Payments/paymenthistory"

{  "message": "string",  "payload": [    {      "orderTitle": "string",      "orderReferenceNumber": "string",      "paymentStatus": "Started",      "orderType": "RENT",      "paymentDate": "2019-08-24T14:15:22Z",      "amount": 0.1,      "paymentMethodName": "string",      "invoiceURL": "string",      "enableInvoiceDownload": true    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": 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}

Authorization

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Authorization

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`