S360 Services
Home
Home
Azure DevOps Repository
  1. Payment
  • Component Diagram
  • S360 Providers
    • BackOffice Workspace
      • Application
        • Submit Application
        • Application Status
      • Service Provisioning
        • Service Provisioning Request
        • Service Provisioning Status
      • Payment
        • Pricing Request
        • Payment Confirmation
      • References
    • IID Authorization
      • Get Context
      • Create Child Session
      • Get Child Session
      • Refresh Child Session
      • Validate Child Session
      • Logout Child Session
      • Add messages
    • MDM
      • License
        • QueryLicenses
  • S360
    • BackOffice
      • Application
        • Application Decision
      • Service Provisioning
        • Service Provisioning
    • IID Portal
      • Read This First
      • Application Status
      • Services
        • Get My Services
        • Get My Service Details
        • Start My Application
      • Applications
        • Get My Applications
        • Get My Application Details
        • Complete My Application
        • View My Application
      • Inventory
        • Get My Inventories
        • Get My Inventory Details
      • Payment
        • CompletePayment
          POST
        • GetPaymentDetails
          POST
        • ConfirmPayment
          POST
        • GetDuePaymentDetails
          POST
        • GetPastPaymentDetails
          POST
        • GetMyDuePayments
          POST
        • GetMyPastPayments
          POST
        • GetMyPaymentDetails
          POST
        • GetMyPayments
          POST
      • Document
        • Retrieve Document
    • Application Workspace
      • Read This First
      • SSO
        • Authenticate
        • Refresh Session
      • Application
        • GetContext App
        • GetContext User
        • Submit My Application
        • Notify Application Status
      • Document
        • Upload Document
        • Retrieve Document
      • Proxy
        • Get Reference Data from Entity
      • DesignTime
        • Upload Application Schema
    • Rules Engines
      • Payment
  1. Payment

CompletePayment

Integrating
POST
/payment/v1/payments/completion
Last modified:2024-10-03 12:51:09
OperationId:CompletePayment

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Header Params

Body Params application/json

Example
{
    "requestControl": {
        "returnQuotation": true,
        "returnQuotationFeeDetails": true,
        "returnPaymentAudit": true,
        "returnTransaction": false
    },
    "payment": {
        "paidThru": "DubaiPay",
        "paidBy": "elit aliquip est",
        "invoiceId": [
            "e56fb6a7-5a4e-4ae2-9d2f-c8223ceb3d9b",
            "bde51a49-329f-465f-94c7-63aa955371dd"
        ]
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/payment/v1/payments/completion' \
--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": true,
        "returnQuotationFeeDetails": true,
        "returnPaymentAudit": true,
        "returnTransaction": false
    },
    "payment": {
        "paidThru": "DubaiPay",
        "paidBy": "elit aliquip est",
        "invoiceId": [
            "e56fb6a7-5a4e-4ae2-9d2f-c8223ceb3d9b",
            "bde51a49-329f-465f-94c7-63aa955371dd"
        ]
    }
}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 200,
    "externalId": "d9d1a622-a5ad-4946-b84c-b9c9e361ffd4",
    "esbUUID": "218a8f1a-bbd1-4633-99e7-d59f0481ec5c",
    "desc": {
        "code": "10296",
        "en": "Success",
        "ar": "نجاح"
    },
    "redirectionUrl": "https://agreeable-sled.name",
    "paymentId": "af9f5036-f3e6-4a66-9c8e-8acaefb99a38",
    "lastExternalRefId": "2569f981-01fc-469e-8d46-3d70feb6974b",
    "paidThru": "DubaiPay",
    "paidBy": "ba32125b-7117-439a-a631-99979e92c3a5",
    "paymentAudit": [
        {
            "executedBy": "5da07000-7404-4e4c-9715-0ce8a48d303f",
            "executedOn": "2024-09-25T06:21:30.427Z",
            "externalOps": "DetailsByPaymentId",
            "message": "program auxiliary monitor",
            "code": "59258-9496",
            "externalStatus": "in-progress",
            "externalRefId": "b1db7e15-efd8-4389-ac32-a8de34f94783"
        }
    ],
    "quotations": [
        {
            "invoiceId": "069e8ea4-7f10-41ea-9f17-76bbb1e7d950",
            "dulNumber": "67508973876838",
            "quotedBy": "a5e338e0-1f0f-452a-abe2-bc6222459187",
            "pricedBy": "DET",
            "serviceId": "8bc1d2ee-f867-4ecf-ac09-c5e82e0ff3a7",
            "applicationId": "8e964ede-c3f0-4b3f-8b27-bfce203575c6",
            "entityId": "RTA",
            "payType": "PayToFulfill",
            "total": -39639450.94949999,
            "totalItem": 10248,
            "currency": "KMF",
            "quotedOn": "2024-09-24T14:43:23.073Z",
            "expiredOn": "2024-09-25T01:57:13.578Z",
            "status": "Pending Payment",
            "availableActions": [
                "pariatur velit dolore non in"
            ],
            "items": [
                {
                    "itemId": "283204664265584",
                    "itemName": "Bespoke Frozen Cheese",
                    "beneficiaryId": "RTA",
                    "amount": -569359.4226718396,
                    "description": "New range of formal shirts are designed keeping you in mind. With fits and styling that will make you stand apart"
                }
            ]
        },
        {
            "invoiceId": "17a06238-941b-4607-a3b8-bb68a2452e00",
            "dulNumber": "113348385016625",
            "quotedBy": "d8569a7d-70fc-439a-8e22-78844c337d31",
            "pricedBy": "DET",
            "serviceId": "cb4e60a0-2975-410f-8db7-e08cf08f3b06",
            "applicationId": "6a0a5b7c-2d21-4e77-ab86-7bc14df5808e",
            "entityId": "RTA",
            "payType": "PayToSubmit",
            "total": -42914860.2080049,
            "totalItem": 84360,
            "currency": "PHP",
            "quotedOn": "2024-09-25T03:48:25.474Z",
            "expiredOn": "2024-09-25T10:58:05.510Z",
            "status": "Pending Payment",
            "availableActions": [
                "sunt amet nisi Duis fugiat"
            ],
            "items": [
                {
                    "itemId": "44446235030327",
                    "itemName": "Bespoke Bronze Chair",
                    "beneficiaryId": "RTA",
                    "amount": -50181179.26361883,
                    "description": "The Nagasaki Lander is the trademarked name of several series of Nagasaki sport bikes, that started with the 1984 ABC800J"
                },
                {
                    "itemId": "688778771688759",
                    "itemName": "Bespoke Fresh Computer",
                    "beneficiaryId": "RTA",
                    "amount": 65688130.32031083,
                    "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"
                },
                {
                    "itemId": "279634351962761",
                    "itemName": "Sleek Wooden Shoes",
                    "beneficiaryId": "RTA",
                    "amount": -13683404.813458651,
                    "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": "e08be24d-0650-470b-b2e4-8ccab392b685",
            "dulNumber": "858572768223025",
            "quotedBy": "cb9c6d5d-83f8-4f2f-99b5-b6f78b431bc2",
            "pricedBy": "DET",
            "serviceId": "5ffc9fd6-9896-477a-b25d-aa47a32eb8ad",
            "applicationId": "11b2c8b0-4db6-4591-a9bf-95f9c79c601c",
            "entityId": "RTA",
            "payType": "PayToApply",
            "total": -93777009.66218168,
            "totalItem": 21532,
            "currency": "IRR",
            "quotedOn": "2024-09-25T09:24:13.056Z",
            "expiredOn": "2024-09-24T21:06:19.277Z",
            "status": "Pending Payment",
            "availableActions": [
                "sunt laboris enim",
                "id ad culpa"
            ],
            "items": [
                {
                    "itemId": "71707981891785",
                    "itemName": "Refined Fresh Mouse",
                    "beneficiaryId": "RTA",
                    "amount": 21137941.27196607,
                    "description": "The Nagasaki Lander is the trademarked name of several series of Nagasaki sport bikes, that started with the 1984 ABC800J"
                },
                {
                    "itemId": "876066445732271",
                    "itemName": "Ergonomic Bronze Gloves",
                    "beneficiaryId": "RTA",
                    "amount": 58032765.66720709,
                    "description": "Andy shoes are designed to keeping in mind durability as well as trends, the most stylish range of shoes & sandals"
                },
                {
                    "itemId": "991117148691521",
                    "itemName": "Incredible Steel Pizza",
                    "beneficiaryId": "RTA",
                    "amount": -62136835.49109055,
                    "description": "The Nagasaki Lander is the trademarked name of several series of Nagasaki sport bikes, that started with the 1984 ABC800J"
                }
            ]
        }
    ],
    "transactions": [
        {
            "invoiceId": "fe99e2a8-5117-4c34-8f80-e5fe7eafcbae",
            "spCode": "DET",
            "spTrn": "3411cde7-3435-4855-80f3-31ba8ebc2c00",
            "degTrn": "f0875edf-00fe-485e-b1c3-002731427c66",
            "servCode": "79125-1166",
            "transactOn": "2024-09-25T06:10:21.372Z",
            "transactBy": "2aee59b9-a52c-4480-bb74-5c65730d2d62",
            "channel": "100",
            "description": "Ab quasi commodi ipsum adipisci possimus. Minima in veritatis hic optio vel in. Aspernatur error distinctio debitis voluptatibus occaecati aliquam ab ducimus distinctio.",
            "type": "sale",
            "version": "aliquip",
            "settlementType": "private",
            "paymentMethod": "Credit Card",
            "message": {
                "code": "10989-1018",
                "text": "eiusmod Ut id"
            }
        },
        {
            "invoiceId": "8c9ab86d-0fc6-43a5-8332-2498dcfa116a",
            "spCode": "DET",
            "spTrn": "145cb0b6-0fd9-449d-b6c2-e78f147b8cd9",
            "degTrn": "92d60de2-1f66-4856-b282-6dacb31d6d28",
            "servCode": "35522",
            "transactOn": "2024-09-25T04:14:54.630Z",
            "transactBy": "19309e83-1eb9-4519-a636-6dd7e624dc00",
            "channel": "104",
            "description": "Perspiciatis nisi omnis quaerat laborum maxime. Nobis nisi consectetur adipisci labore quidem quae ullam sint laboriosam. Maxime cupiditate est enim error sunt odit quod magni. Cupiditate similique distinctio nam aliquam quidem at reiciendis doloremque. Deleniti eius libero error doloremque.",
            "type": "sale",
            "version": "ut quis",
            "settlementType": "private",
            "paymentMethod": "Credit Card",
            "message": {
                "code": "59275",
                "text": "minim mollit qui elit"
            }
        },
        {
            "invoiceId": "8c9ab86d-0fc6-43a5-8332-2498dcfa116a",
            "spCode": "DET",
            "spTrn": "145cb0b6-0fd9-449d-b6c2-e78f147b8cd9",
            "degTrn": "92d60de2-1f66-4856-b282-6dacb31d6d28",
            "servCode": "35522",
            "transactOn": "2024-09-25T04:14:54.630Z",
            "transactBy": "19309e83-1eb9-4519-a636-6dd7e624dc00",
            "channel": "104",
            "description": "Perspiciatis nisi omnis quaerat laborum maxime. Nobis nisi consectetur adipisci labore quidem quae ullam sint laboriosam. Maxime cupiditate est enim error sunt odit quod magni. Cupiditate similique distinctio nam aliquam quidem at reiciendis doloremque. Deleniti eius libero error doloremque.",
            "type": "sale",
            "version": "ut quis",
            "settlementType": "private",
            "paymentMethod": "Credit Card",
            "message": {
                "code": "59275",
                "text": "minim mollit qui elit"
            }
        }
    ]
}
Modified at 2024-10-03 12:51:09
Previous
Get My Inventory Details
Next
GetPaymentDetails
Built with