GetPaymentDetails

Integrating

POST

/payment/v1/payments/details

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

OperationId:GetPaymentDetails

Request

Authorization

Add parameter in header

X-API-Key

Example:

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

Header Params

Body Params application/json

Example

{
    "entityCode ": "eiusmod",
    "token": "219029ED6CB05BB95C093CFCDF716922C079CD57DB9AB08528DB2CED71DE391183C2916E6266B225BD15943E9A2A755BBDF8F5DB03FF001B55A969A2568D686DF989A088A85DB59CE847384748B04581FF5DE5E13224105F79211901E8163A9D26731FCB6976DF4441FA0C08731D05B5",
    "paymentId": "nulla sint culpa ad elit",
    "requestControl": {
        "returnQuotation": false,
        "returnQuotationFeeDetails": true,
        "returnPaymentAudit": true,
        "returnTransaction": false
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/payment/v1/payments/details' \
--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 '{
    "entityCode ": "eiusmod",
    "token": "219029ED6CB05BB95C093CFCDF716922C079CD57DB9AB08528DB2CED71DE391183C2916E6266B225BD15943E9A2A755BBDF8F5DB03FF001B55A969A2568D686DF989A088A85DB59CE847384748B04581FF5DE5E13224105F79211901E8163A9D26731FCB6976DF4441FA0C08731D05B5",
    "paymentId": "nulla sint culpa ad elit",
    "requestControl": {
        "returnQuotation": false,
        "returnQuotationFeeDetails": true,
        "returnPaymentAudit": true,
        "returnTransaction": false
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "bd5b1fb3-f019-4bd4-8c73-89ddd62044ac",
    "esbUUID": "a2dba3e4-b55c-4fad-a426-5eb16bfc4298",
    "desc": {
        "code": "96284",
        "en": "Success",
        "ar": "نجاح"
    },
    "payment": {
        "paymentId": "5ce939ae-44b0-4fcf-a350-fad27c5ac31c",
        "lastExternalRefId": "b344d9d4-d7a5-4ec0-9c7f-1cdacc148dad",
        "paidThru": "DubaiPay",
        "paidBy": "274b1f46-57a8-4797-a072-5d8dc9b41c58",
        "paymentAudit": [
            {
                "executedBy": "fc754e68-b17f-46a5-8fd6-a18151391944",
                "executedOn": "2024-09-24T22:37:11.053Z",
                "externalOps": "Register",
                "message": "program digital array",
                "code": "16697-8240",
                "externalStatus": "completed",
                "externalRefId": "026e5be6-7e43-4483-8c66-408591eab23b"
            },
            {
                "executedBy": "cb30c586-477a-4f55-be1e-5342d09bc8a5",
                "executedOn": "2024-09-25T02:56:33.867Z",
                "externalOps": "Confirm",
                "message": "copy optical driver",
                "code": "30639",
                "externalStatus": "in-progress",
                "externalRefId": "c828e8f6-8eb2-40de-b08e-7b8e695f07f7"
            },
            {
                "executedBy": "8dad7d69-cf9b-4649-96f5-876bdc840592",
                "executedOn": "2024-09-24T21:08:10.248Z",
                "externalOps": "Register",
                "message": "back up 1080p capacitor",
                "code": "34753-9344",
                "externalStatus": "new",
                "externalRefId": "47bd47fd-f896-4238-9c44-5aabbef3fba8"
            }
        ],
        "quotations": [
            {
                "invoiceId": "8b250b3a-24ec-44db-a8f9-5dc8d1cc1796",
                "dulNumber": "507040717349738",
                "quotedBy": "b7180e5a-ffef-49b5-b99d-eb3c7658ab5f",
                "pricedBy": "DET",
                "serviceId": "f9078683-0fa8-4297-8906-1f1e80482e93",
                "applicationId": "bfc05000-3457-4f73-aa0e-941c16ba19be",
                "entityId": "RTA",
                "payType": "PayToSubmit",
                "total": 90475022.23722455,
                "totalItem": 60200,
                "currency": "XAU",
                "quotedOn": "2024-09-25T01:24:03.843Z",
                "expiredOn": "2024-09-25T04:57:49.474Z",
                "status": "Pending Payment",
                "availableActions": [
                    "ut",
                    "enim Lorem",
                    "consequat Lorem"
                ],
                "items": [
                    {
                        "itemId": "985418320525833",
                        "itemName": "Handcrafted Soft Shoes",
                        "beneficiaryId": "RTA",
                        "amount": -82885517.50539504,
                        "description": "The automobile layout consists of a front-engine design, with transaxle-type transmissions mounted at the rear of the engine and four wheel drive"
                    },
                    {
                        "itemId": "272411085361076",
                        "itemName": "Handmade Frozen Chips",
                        "beneficiaryId": "RTA",
                        "amount": 34207202.49331848,
                        "description": "The automobile layout consists of a front-engine design, with transaxle-type transmissions mounted at the rear of the engine and four wheel drive"
                    },
                    {
                        "itemId": "451561080386424",
                        "itemName": "Awesome Soft Tuna",
                        "beneficiaryId": "RTA",
                        "amount": -76378840.75506335,
                        "description": "The Apollotech B340 is an affordable wireless mouse with reliable connectivity, 12 months battery life and modern design"
                    }
                ]
            },
            {
                "invoiceId": "30ad5345-e062-45d0-b2c2-793893ccae98",
                "dulNumber": "875625647580159",
                "quotedBy": "8e43c725-4c32-4fc3-a808-a20d60aeb491",
                "pricedBy": "DET",
                "serviceId": "ee341560-fb23-4b7d-be80-e12d53bb79f7",
                "applicationId": "981c3ec3-7810-4caa-8fa4-17645c4f0f4e",
                "entityId": "RTA",
                "payType": "PayToFulfill",
                "total": -16877035.814828426,
                "totalItem": 17766,
                "currency": "DKK",
                "quotedOn": "2024-09-25T07:06:22.889Z",
                "expiredOn": "2024-09-24T13:52:03.624Z",
                "status": "Pending Payment",
                "availableActions": [
                    "sed et occaecat reprehenderit"
                ],
                "items": [
                    {
                        "itemId": "942853100493824",
                        "itemName": "Incredible Soft Shoes",
                        "beneficiaryId": "RTA",
                        "amount": 3294830.944637224,
                        "description": "Boston's most advanced compression wear technology increases muscle oxygenation, stabilizes active muscles"
                    },
                    {
                        "itemId": "435998417477511",
                        "itemName": "Handmade Granite Chair",
                        "beneficiaryId": "RTA",
                        "amount": -64100893.99555838,
                        "description": "Carbonite web goalkeeper gloves are ergonomically designed to give easy fit"
                    },
                    {
                        "itemId": "457237607101590",
                        "itemName": "Unbranded Frozen Bacon",
                        "beneficiaryId": "RTA",
                        "amount": -61859332.87252969,
                        "description": "The Nagasaki Lander is the trademarked name of several series of Nagasaki sport bikes, that started with the 1984 ABC800J"
                    }
                ]
            }
        ],
        "transactions": [
            {
                "invoiceId": "75c25a63-4a09-4800-af3b-5dd91e978d94",
                "spCode": "DET",
                "spTrn": "a6ccf8d5-1265-4e30-b5c5-30dbed993a3d",
                "degTrn": "f0a70aab-170e-418b-9353-54b1537ed3a6",
                "servCode": "27269",
                "transactOn": "2024-09-24T16:30:09.556Z",
                "transactBy": "184197bf-4dd3-479b-986c-b540072139b1",
                "channel": "100",
                "description": "Dolor vero quis culpa quasi in quo. Nisi eveniet molestiae cumque eius in deleniti. Ipsam hic corrupti aut. Error unde ullam. Nobis perferendis consequuntur quae. Ex quisquam tempore excepturi eaque dolorem quis eaque totam.",
                "type": "auth",
                "version": "dolor consectetur officia in",
                "settlementType": "private",
                "paymentMethod": "Credit Card",
                "message": {
                    "code": "27569-3175",
                    "text": "sit sunt nisi"
                }
            },
            {
                "invoiceId": "7600ee5f-db7e-4446-91d6-aa966fdce1cf",
                "spCode": "DET",
                "spTrn": "990ecb1f-91fd-47db-affa-f47c2333cb83",
                "degTrn": "c417695d-1418-4ea6-85d5-bcb78a936018",
                "servCode": "61048-4782",
                "transactOn": "2024-09-25T04:08:45.329Z",
                "transactBy": "837baa0c-188a-428b-9b5a-4a9fdfa1bdf5",
                "channel": "103",
                "description": "Molestias rem facere nisi error inventore aliquam aliquam. Inventore facilis ipsam quaerat nostrum consequatur inventore cum. Hic cupiditate reiciendis blanditiis. Possimus officiis quod officia fugit. Nostrum repellendus quibusdam voluptas.",
                "type": "auth",
                "version": "est magna in culpa",
                "settlementType": "gov",
                "paymentMethod": "Credit Card",
                "message": {
                    "code": "16868",
                    "text": "aute labore non officia"
                }
            }
        ]
    }
}

🟠400Bad Request

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

CompletePayment

ConfirmPayment