GetPastPaymentDetails

Integrating

POST

/payment/v1/payments/past/{id}

Last modified:2024-10-03 12:51:09

OperationId:GetPastPaymentDetails

Request

Authorization

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "requestControl": {
        "returnQuotation": false,
        "returnQuotationFeeDetails": false,
        "returnPaymentAudit": true,
        "returnTransaction": false
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/payment/v1/payments/past/{% faker datatype.uuid %}' \
--header 'X-Request-ID: {% faker datatype.uuid %}' \
--header 'x-IID-Sid: {% faker datatype.uuid %}' \
--header 'X-IID-TraceId: {% faker datatype.uuid %}' \
--header 'x-IID-Usr-CorrelationId: userid' \
--header 'Content-Type: application/json' \
--header 'X-API-Key;' \
--data-raw '{
    "requestControl": {
        "returnQuotation": false,
        "returnQuotationFeeDetails": false,
        "returnPaymentAudit": true,
        "returnTransaction": false
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "8e1ca157-294a-4d51-9e44-1c9f7c669a0a",
    "esbUUID": "87479552-6bcb-4a37-9c8b-52f979995df9",
    "desc": {
        "code": "11656-6103",
        "en": "Success",
        "ar": "نجاح"
    },
    "payment": {
        "paymentId": "1143daec-b33e-45ff-83a0-359afc30f88b",
        "lastExternalRefId": "c8156135-fb8b-401b-9dda-3345d6206ae1",
        "paidThru": "DubaiPay",
        "paidBy": "754c744e-d3dc-4b74-aac5-4f138d885c49",
        "paymentAudit": [
            {
                "executedBy": "19f8a78d-d85a-4f41-8bd6-e8ce51a173e4",
                "executedOn": "2024-09-25T06:03:32.590Z",
                "externalOps": "Confirm",
                "message": "quantify primary firewall",
                "code": "60839-0316",
                "externalStatus": "failed",
                "externalRefId": "cfc5b970-6613-4025-987d-be71fabd4efd"
            },
            {
                "executedBy": "6cedb484-5c50-49c1-a357-ecbc19ff7280",
                "executedOn": "2024-09-24T16:01:38.198Z",
                "externalOps": "DetailsByToken",
                "message": "connect primary monitor",
                "code": "86059-1840",
                "externalStatus": "new",
                "externalRefId": "d896a740-b15b-4bdc-8c06-c8e17f05890c"
            }
        ],
        "quotations": [
            {
                "invoiceId": "64c493d5-a584-421f-967c-71b8226b67b9",
                "dulNumber": "61385371698749",
                "quotedBy": "4277debb-64b6-42a3-83fe-22be09d13fae",
                "pricedBy": "DET",
                "serviceId": "d5144e33-c80f-49c5-ba08-b2cbc168ebbd",
                "applicationId": "15e75b02-e5c2-4306-9ade-bfc40111fa02",
                "entityId": "RTA",
                "payType": "PayToFulfill",
                "total": -55752875.883449085,
                "totalItem": 39363,
                "currency": "INR",
                "quotedOn": "2024-09-24T22:49:15.592Z",
                "expiredOn": "2024-09-24T13:42:12.061Z",
                "status": "Pending Payment",
                "availableActions": [
                    "id in",
                    "id sed laboris commodo"
                ],
                "items": [
                    {
                        "itemId": "222328467597067",
                        "itemName": "Awesome Soft Bacon",
                        "beneficiaryId": "RTA",
                        "amount": 17202517.93995872,
                        "description": "New ABC 13 9370, 13.3, 5th Gen CoreA5-8250U, 8GB RAM, 256GB SSD, power UHD Graphics, OS 10 Home, OS Office A & J 2016"
                    }
                ]
            },
            {
                "invoiceId": "78033b6a-9d7a-4b0a-a728-8ace826a7ce2",
                "dulNumber": "691350268538571",
                "quotedBy": "4c537aaf-4ec0-46f8-aff8-bd11147670d3",
                "pricedBy": "DET",
                "serviceId": "ac988c13-c3df-489b-bd71-de9f6ce00dbb",
                "applicationId": "118a9d5f-846e-4c00-a6f3-c78fea1fee1b",
                "entityId": "RTA",
                "payType": "PayToApply",
                "total": 68508317.86727664,
                "totalItem": 26097,
                "currency": "LTL",
                "quotedOn": "2024-09-25T02:56:17.771Z",
                "expiredOn": "2024-09-24T16:20:45.606Z",
                "status": "Pending Payment",
                "availableActions": [
                    "est eiusmod"
                ],
                "items": [
                    {
                        "itemId": "743800657959546",
                        "itemName": "Oriental Fresh Car",
                        "beneficiaryId": "RTA",
                        "amount": -2168647.065830067,
                        "description": "Boston's most advanced compression wear technology increases muscle oxygenation, stabilizes active muscles"
                    },
                    {
                        "itemId": "705465405247337",
                        "itemName": "Handcrafted Granite Gloves",
                        "beneficiaryId": "RTA",
                        "amount": -56904663.66014393,
                        "description": "New range of formal shirts are designed keeping you in mind. With fits and styling that will make you stand apart"
                    }
                ]
            }
        ],
        "transactions": [
            {
                "invoiceId": "249f9f58-7d45-4055-9168-39037579b323",
                "spCode": "DET",
                "spTrn": "44b56e8f-308a-4d0f-9265-ffbde0ec23eb",
                "degTrn": "7c1a02f8-f76e-4aa5-9222-1e30da1a3bb5",
                "servCode": "59274-0782",
                "transactOn": "2024-09-25T05:48:05.742Z",
                "transactBy": "ccf5b27c-4ac6-4a5b-b2e6-9f5e05fe9de2",
                "channel": "100",
                "description": "Perferendis possimus quis eligendi dignissimos fuga fuga voluptatem. Repudiandae sequi voluptate quas dicta architecto tenetur officiis. Iusto impedit perspiciatis accusantium quae a deleniti. Tempore perspiciatis consectetur laboriosam alias dolore incidunt laboriosam voluptate harum. Exercitationem vero pariatur. Similique provident aut.",
                "type": "sale",
                "version": "aliquip eu cupidatat",
                "settlementType": "private",
                "paymentMethod": "Credit Card",
                "message": {
                    "code": "96504",
                    "text": "in"
                }
            },
            {
                "invoiceId": "24c52d6c-824d-416c-a2b6-cc6009e8b42c",
                "spCode": "DET",
                "spTrn": "766344c5-ac22-43a4-8578-c2bdb8245654",
                "degTrn": "e2de3ea0-9f78-4831-be5b-9f75fa6c8398",
                "servCode": "52380-2883",
                "transactOn": "2024-09-24T18:47:11.646Z",
                "transactBy": "b90de37b-ce49-46f7-8a71-f189d3f0d1b2",
                "channel": "103",
                "description": "Similique consequuntur nostrum nemo illum. Sit odio maxime cum. Nobis adipisci placeat.",
                "type": "sale",
                "version": "laborum",
                "settlementType": "gov",
                "paymentMethod": "Credit Card",
                "message": {
                    "code": "60487-2926",
                    "text": "nisi"
                }
            }
        ]
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Modified at 2024-10-03 12:51:09

GetDuePaymentDetails

GetMyDuePayments