GetMyDuePayments

Integrating

POST

/payment/v1/payments/due

Last modified:2024-10-02 10:27:14

OperationId:GetMyDuePayments

Request

Authorization

Add parameter in header

X-API-Key

Example:

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

Header Params

Body Params application/json

Example

{
    "requestControl": {
        "limit": -55960003,
        "page": -8298058,
        "returnQuotation": true,
        "returnQuotationFeeDetails": false,
        "returnPaymentAudit": false,
        "returnTransaction": true
    },
    "query": {
        "userId": "7bed7549-a846-49c0-8fec-0733739cc228",
        "dulNumber": "684769295285063",
        "serviceId": "561f1aa9-5215-47ae-ad5e-12ba0b650995",
        "applicationId": "ec414d2b-6705-4e32-9fbf-ef4afe52206c",
        "entityId": "RTA",
        "entityName": "Daugherty Group",
        "quoteOnMin": "2024-10-01T22:42:51.621Z",
        "quoteOnMax": "2024-10-01T20:39:02.301Z",
        "amountMin": -13697146.205834538,
        "amountMax": 88730265.50412756,
        "status": "PaymentInProgress"
    },
    "sort": {
        "by": "EntityName",
        "order": "DES"
    },
    "search": {
        "by": [
            "Excepteur esse",
            "irure laborum",
            "id"
        ],
        "text": "sint commodo in officia amet"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/payment/v1/payments/due' \
--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": {
        "limit": -55960003,
        "page": -8298058,
        "returnQuotation": true,
        "returnQuotationFeeDetails": false,
        "returnPaymentAudit": false,
        "returnTransaction": true
    },
    "query": {
        "userId": "7bed7549-a846-49c0-8fec-0733739cc228",
        "dulNumber": "684769295285063",
        "serviceId": "561f1aa9-5215-47ae-ad5e-12ba0b650995",
        "applicationId": "ec414d2b-6705-4e32-9fbf-ef4afe52206c",
        "entityId": "RTA",
        "entityName": "Daugherty Group",
        "quoteOnMin": "2024-10-01T22:42:51.621Z",
        "quoteOnMax": "2024-10-01T20:39:02.301Z",
        "amountMin": -13697146.205834538,
        "amountMax": 88730265.50412756,
        "status": "PaymentInProgress"
    },
    "sort": {
        "by": "EntityName",
        "order": "DES"
    },
    "search": {
        "by": [
            "Excepteur esse",
            "irure laborum",
            "id"
        ],
        "text": "sint commodo in officia amet"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "7f805ac5-212a-4810-af01-f6d800be2507",
    "esbUUID": "952ab7a7-8c74-4b51-aa69-dd62aa1b2634",
    "desc": {
        "code": "98531",
        "en": "Success",
        "ar": "نجاح"
    },
    "page": {
        "total": 76312,
        "limit": 67366,
        "page": 34371
    },
    "myDuePayments": [
        {
            "invoiceId": "2cb50cb3-df9f-4b52-a1fa-c61000acb956",
            "dulNumber": "44795370912190",
            "quotedBy": "4450056d-cc17-4506-8e42-2a2133c8b109",
            "pricedBy": "DET",
            "serviceId": "f4725747-b506-4dfb-aa52-4f609322546a",
            "serviceName": "Ergonomic Bronze Table",
            "applicationId": "d835c345-693f-4db0-831a-6a284502e2b2",
            "entityId": "RTA",
            "payType": "PayToApply",
            "total": -35618415.52862779,
            "totalItem": 41404,
            "currency": "BYN",
            "quotedOn": "2024-10-01T23:28:14.664Z",
            "expiredOn": "2024-10-02T03:11:19.631Z",
            "status": "Pending Payment",
            "availableActions": [
                "culpa",
                "consequat Lorem non adipisicing",
                "non commodo"
            ],
            "items": [
                {
                    "itemId": "150994142952336",
                    "itemName": "Small Bronze Tuna",
                    "beneficiaryId": "RTA",
                    "beneficiaryName": "Jast Group",
                    "amount": 89289006.33383891,
                    "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": "843105994114575",
                    "itemName": "Gorgeous Fresh Chips",
                    "beneficiaryId": "RTA",
                    "beneficiaryName": "Hettinger, Harvey and Schroeder",
                    "amount": 7275112.6873551905,
                    "description": "The Football Is Good For Training And Recreational Purposes"
                }
            ]
        },
        {
            "invoiceId": "192a1169-9f2f-412b-bc0f-322aa3b2a105",
            "dulNumber": "946757060933023",
            "quotedBy": "ac4058c4-226e-4113-abe4-b75cf9561481",
            "pricedBy": "DET",
            "serviceId": "7e106e99-61d6-4f50-8e1f-b3fdfbbb4326",
            "serviceName": "Ergonomic Soft Bike",
            "applicationId": "9e011d67-3e04-4928-a664-9f33790b48d2",
            "entityId": "RTA",
            "payType": "PayToApply",
            "total": 67084346.10483232,
            "totalItem": 56951,
            "currency": "CVE",
            "quotedOn": "2024-10-02T05:05:21.224Z",
            "expiredOn": "2024-10-02T07:06:41.127Z",
            "status": "Pending Payment",
            "availableActions": [
                "minim in laboris ullamco amet",
                "enim irure ut ad"
            ],
            "items": [
                {
                    "itemId": "908138010187746",
                    "itemName": "Gorgeous Metal Computer",
                    "beneficiaryId": "RTA",
                    "beneficiaryName": "Terry Inc",
                    "amount": -74708340.20580167,
                    "description": "The Apollotech B340 is an affordable wireless mouse with reliable connectivity, 12 months battery life and modern design"
                }
            ]
        }
    ],
    "myDueTransactions": [
        {
            "invoiceId": "6664e8cb-a1a7-4f6e-a888-bde3bcab1951",
            "spCode": "DET",
            "spTrn": "e74ad22a-2e15-4c13-9a9c-39e40d4ec607",
            "degTrn": "b05f0dfd-8aa7-49b6-bc36-8de27f432888",
            "servCode": "94500",
            "transactOn": "2024-10-01T19:47:36.279Z",
            "transactBy": "5e15736f-cbe7-4713-a49a-b39c8c6c1f82",
            "channel": "102",
            "description": "Incidunt magnam exercitationem ad modi magnam magni non saepe. Omnis iste totam non voluptas magnam recusandae minus. Et ipsum deserunt fugit animi voluptates quos asperiores non magni. Fugit libero incidunt expedita maxime earum. Quae maxime accusantium alias. Nihil iste minus.",
            "type": "auth",
            "version": "dolore",
            "settlementType": "gov",
            "paymentMethod": "Credit Card",
            "message": {
                "code": "44112",
                "text": "Excepteur dolore ea"
            }
        },
        {
            "invoiceId": "6664e8cb-a1a7-4f6e-a888-bde3bcab1951",
            "spCode": "DET",
            "spTrn": "e74ad22a-2e15-4c13-9a9c-39e40d4ec607",
            "degTrn": "b05f0dfd-8aa7-49b6-bc36-8de27f432888",
            "servCode": "94500",
            "transactOn": "2024-10-01T19:47:36.279Z",
            "transactBy": "5e15736f-cbe7-4713-a49a-b39c8c6c1f82",
            "channel": "102",
            "description": "Incidunt magnam exercitationem ad modi magnam magni non saepe. Omnis iste totam non voluptas magnam recusandae minus. Et ipsum deserunt fugit animi voluptates quos asperiores non magni. Fugit libero incidunt expedita maxime earum. Quae maxime accusantium alias. Nihil iste minus.",
            "type": "auth",
            "version": "dolore",
            "settlementType": "gov",
            "paymentMethod": "Credit Card",
            "message": {
                "code": "44112",
                "text": "Excepteur dolore ea"
            }
        }
    ]
}

Modified at 2024-10-02 10:27:14

GetPastPaymentDetails

GetMyPastPayments