- Component Diagram
- S360 Providers
- BackOffice Workspace
- IID Authorization
- MDM
- S360
- BackOffice
- IID Portal
- Read This First
- Application Status
- Services
- Applications
- Inventory
- Payment
- Document
- Application Workspace
- Rules Engines
- Payment
GetMyPayments
Developing
POST
/payment/v1/payments
Last modified:2024-10-02 11:18:37
OperationId:GetMyPayments
Request
Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************Header Params
Body Params application/json
Example
{
"requestControl": {
"limit": 95824976,
"page": -38052849,
"returnQuotation": false,
"returnQuotationFeeDetails": true,
"returnPaymentAudit": true,
"returnTransaction": true,
"returnDue": false
},
"query": {
"userId": "aacb545c-8295-460e-8906-c821889ccf5e",
"dulNumber": "660612774905167",
"serviceId": "843aefb4-f2f9-4fd9-b59a-ce7b01680d7c",
"applicationId": "9e0e7ab6-435f-415b-9e7c-907651cba474",
"entityId": "RTA",
"entityName": "Zulauf - Lynch",
"quoteOnMin": "2024-10-01T20:45:59.773Z",
"quoteOnMax": "2024-10-01T23:09:14.173Z",
"amountMin": -10491346.768653288,
"amountMax": -10631784.859722286,
"status": "PaymentCompleted"
},
"sort": {
"by": "InvoiceDueOn",
"order": "DES"
},
"search": {
"by": [
"elit culpa",
"ut Lorem tempor deserunt"
],
"text": "nulla cillum Lorem officia"
}
}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' \
--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": 95824976,
"page": -38052849,
"returnQuotation": false,
"returnQuotationFeeDetails": true,
"returnPaymentAudit": true,
"returnTransaction": true,
"returnDue": false
},
"query": {
"userId": "aacb545c-8295-460e-8906-c821889ccf5e",
"dulNumber": "660612774905167",
"serviceId": "843aefb4-f2f9-4fd9-b59a-ce7b01680d7c",
"applicationId": "9e0e7ab6-435f-415b-9e7c-907651cba474",
"entityId": "RTA",
"entityName": "Zulauf - Lynch",
"quoteOnMin": "2024-10-01T20:45:59.773Z",
"quoteOnMax": "2024-10-01T23:09:14.173Z",
"amountMin": -10491346.768653288,
"amountMax": -10631784.859722286,
"status": "PaymentCompleted"
},
"sort": {
"by": "InvoiceDueOn",
"order": "DES"
},
"search": {
"by": [
"elit culpa",
"ut Lorem tempor deserunt"
],
"text": "nulla cillum Lorem officia"
}
}'Responses
🟢200Success
application/json
Body
Example
{
"status": 200,
"externalId": "05297d3f-01ac-4dba-85f0-7c7fff68f698",
"esbUUID": "0475768a-087b-4a7a-b208-49915267a9d5",
"desc": {
"code": "42349-1543",
"en": "Success",
"ar": "نجاح"
},
"page": {
"total": 87296,
"limit": 78587,
"page": 23786
},
"invoices": [
{
"invoiceId": "428d1f33-8953-489a-a84a-15702e6b247f",
"dulNumber": "191045999806420",
"quotedBy": "6753f43d-d54d-42d8-9d99-083ae3baf6c6",
"pricedBy": "DET",
"serviceId": "5e2d3ce7-0608-4f33-8cd3-b0a84a8c5f13",
"serviceName": "Fantastic Cotton Pizza",
"applicationId": "6ebe1b73-a546-4ae7-aef3-40eac33a5d8c",
"entityId": "RTA",
"payType": "PayToApply",
"total": 50798171.551442236,
"totalItem": 30240,
"currency": "ANG",
"quotedOn": "2024-10-01T15:58:06.772Z",
"expiredOn": "2024-10-01T21:53:31.893Z",
"status": "Pending Payment",
"availableActions": [
"in sunt pariatur minim",
"Ut eiusmod",
"ut est ullamco"
],
"items": [
{
"itemId": "128873446807561",
"itemName": "Elegant Frozen Pizza",
"beneficiaryId": "RTA",
"beneficiaryName": "Bauch Inc",
"amount": -98830823.09485185,
"description": "The beautiful range of Apple Naturalé that has an exciting mix of natural ingredients. With the Goodness of 100% Natural Ingredients"
}
],
"transaction": [
{
"paymentBatch": {
"paymentId": "2767e24e-19fd-418d-89e0-6a22fe835696",
"paymentAudit": [
{
"executedBy": "fadc6c2f-1bec-46ca-96db-b126523b5b7d",
"executedOn": "2024-10-02T00:59:16.446Z",
"externalOps": "DetailsByToken",
"message": {
"code": "53315-7261",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "completed",
"externalRefId": "7ab7c296-b74c-4bdc-9b6b-ed7923add666"
}
]
},
"transactionId": "0b6803b3-2a49-4b59-b68f-e8eed119d2ae",
"spCode": "DET",
"servCode": "83826-1753",
"spTrn": "f9878623-612a-445b-8f1b-b3d72c22c198",
"degTrn": "f51d0d27-bf04-4d2c-87d0-70b4b8e7c84c",
"transactOn": "2024-10-01T16:16:35.204Z",
"transactBy": "b54cc567-b905-473f-add2-49eabb7eef3f",
"channel": "104",
"description": "Est voluptate corrupti. Officiis corrupti esse ea itaque fuga dicta corporis ratione. Facilis similique dolores sit facere recusandae aperiam architecto officiis aut. Nulla architecto aperiam. Illo pariatur ipsa libero iste quae. Qui rerum nam maxime corrupti cupiditate quod.",
"type": "sale",
"version": "officia deserunt eiusmod nulla",
"settlementType": "gov",
"paymentMethod": "Credit Card",
"message": {
"code": "26044",
"en": "Success",
"ar": "نجاح"
}
},
{
"paymentBatch": {
"paymentId": "278e197b-677d-436c-8116-ac4e91230b3c",
"paymentAudit": [
{
"executedBy": "b163fce1-bac6-46cd-bac7-50538412b5c6",
"executedOn": "2024-10-02T03:39:21.026Z",
"externalOps": "Confirm",
"message": {
"code": "97458",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "new",
"externalRefId": "1c75e232-5cb0-4b18-a2eb-560d338d87ac"
},
{
"executedBy": "5ccad6d3-c678-4a9c-829a-3a442b99b122",
"executedOn": "2024-10-02T09:02:22.889Z",
"externalOps": "Register",
"message": {
"code": "09778",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "new",
"externalRefId": "d82022eb-9246-4a7d-83d6-645da6aa8d65"
}
]
},
"transactionId": "7aa8d549-5c30-49e8-bce8-eb7b05d26625",
"spCode": "DET",
"servCode": "21465-2108",
"spTrn": "e2b2a726-2e26-4554-9f48-5763062adc3c",
"degTrn": "4abbd1a7-b06e-4151-b39e-d2194444796d",
"transactOn": "2024-10-01T13:55:58.419Z",
"transactBy": "919901cb-15eb-4974-8e40-df2942051298",
"channel": "104",
"description": "Itaque accusamus molestiae ducimus sint ratione at neque officia. Ipsam dolorem excepturi aliquam praesentium. Nisi ex ipsum ad eius. Odio commodi molestiae quibusdam animi voluptate veritatis. Eveniet ex sunt commodi reprehenderit cum.",
"type": "sale",
"version": "sunt elit Excepteur",
"settlementType": "private",
"paymentMethod": "Credit Card",
"message": {
"code": "33457-4164",
"en": "Success",
"ar": "نجاح"
}
}
]
},
{
"invoiceId": "4d92fc2c-ac6f-4c53-974c-4d426b4b0aca",
"dulNumber": "168729038614869",
"quotedBy": "34af6f9b-2085-42de-83a6-1309b3f66e69",
"pricedBy": "DET",
"serviceId": "7e6170d3-0e36-4ac9-b511-860bc145a42f",
"serviceName": "Sleek Bronze Chips",
"applicationId": "1b8f5b8b-0a42-4e57-b1b8-09de8c312379",
"entityId": "RTA",
"payType": "PayToApply",
"total": 5916965.5065613985,
"totalItem": 88328,
"currency": "USD",
"quotedOn": "2024-10-01T17:54:14.552Z",
"expiredOn": "2024-10-02T06:42:04.135Z",
"status": "Pending Payment",
"availableActions": [
"ex non",
"veniam"
],
"items": [
{
"itemId": "893137176203250",
"itemName": "Generic Concrete Table",
"beneficiaryId": "RTA",
"beneficiaryName": "Renner Group",
"amount": -18998515.314639524,
"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": "982054108510649",
"itemName": "Fantastic Steel Salad",
"beneficiaryId": "RTA",
"beneficiaryName": "Hand, Bergnaum and Cruickshank",
"amount": -35643795.60266735,
"description": "The Apollotech B340 is an affordable wireless mouse with reliable connectivity, 12 months battery life and modern design"
},
{
"itemId": "488594220344462",
"itemName": "Practical Concrete Pizza",
"beneficiaryId": "RTA",
"beneficiaryName": "Boyer LLC",
"amount": -95442332.88002086,
"description": "The slim & simple Maple Gaming Keyboard from Dev Byte comes with a sleek body and 7- Color RGB LED Back-lighting for smart functionality"
}
],
"transaction": [
{
"paymentBatch": {
"paymentId": "2e39ec66-74d3-4518-905d-61e94a4cab31",
"paymentAudit": [
{
"executedBy": "2bb61815-1571-41b1-acb0-851a8e8addba",
"executedOn": "2024-10-02T07:07:31.389Z",
"externalOps": "DetailsByPaymentId",
"message": {
"code": "60141",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "completed",
"externalRefId": "91fe016d-cf0c-49bd-be94-18c78122b815"
},
{
"executedBy": "520e61df-559f-47b9-beef-f1e849897ce4",
"executedOn": "2024-10-02T03:12:21.703Z",
"externalOps": "DetailsByPaymentId",
"message": {
"code": "94120-3826",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "completed",
"externalRefId": "1a0d43b9-d043-4dc0-aa54-b84d8825e06c"
}
]
},
"transactionId": "5185a118-e780-4480-8053-11bfe37f8c8b",
"spCode": "DET",
"servCode": "30315-6242",
"spTrn": "c7667533-b3c9-4031-8a49-ffdc3d8946b7",
"degTrn": "22fed70c-d586-4d02-98b3-2bdcfddb4cae",
"transactOn": "2024-10-01T18:00:06.976Z",
"transactBy": "02abb0d3-06df-41bd-b3b4-d0698c8c816a",
"channel": "103",
"description": "Ut facere sunt natus. Perspiciatis voluptatum aliquam quidem. Eaque recusandae dolores perspiciatis ratione corrupti ratione voluptatem. Magni inventore aliquam non amet repellat numquam aliquid voluptatem adipisci. Quis doloribus totam nisi. Magni necessitatibus nesciunt eius nobis nobis pariatur commodi ipsum adipisci.",
"type": "sale",
"version": "non sit nulla irure esse",
"settlementType": "gov",
"paymentMethod": "Credit Card",
"message": {
"code": "87359-3055",
"en": "Success",
"ar": "نجاح"
}
},
{
"paymentBatch": {
"paymentId": "db9a90a7-5e9d-48f2-a7cc-86725d77d351",
"paymentAudit": [
{
"executedBy": "f2ca14b4-05fa-40d1-aa20-444a67aebe82",
"executedOn": "2024-10-01T14:34:36.017Z",
"externalOps": "Register",
"message": {
"code": "09739-2954",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "failed",
"externalRefId": "aab9595d-5f6c-42a7-8968-7791849deba2"
},
{
"executedBy": "c8251bb9-f11a-4ed0-baf5-5440de2278a1",
"executedOn": "2024-10-01T22:26:33.651Z",
"externalOps": "DetailsByToken",
"message": {
"code": "13441",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "new",
"externalRefId": "bc1be746-8076-47d1-8bde-93ae3d859877"
},
{
"executedBy": "0859119d-6260-4dd3-9b47-230b6862855d",
"executedOn": "2024-10-02T05:02:24.092Z",
"externalOps": "Confirm",
"message": {
"code": "16016-7229",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "new",
"externalRefId": "c2f3cf95-3eda-4c8d-a21c-6b5b515c3280"
}
]
},
"transactionId": "407ba5ef-14b7-4489-bb0f-0625d892be99",
"spCode": "DET",
"servCode": "63828-0379",
"spTrn": "d172f13a-b84c-4462-8229-8a9cf45342ec",
"degTrn": "3e3f4a1d-a7ef-44ca-89b3-57ef1d88339d",
"transactOn": "2024-10-01T18:46:06.787Z",
"transactBy": "5c589ccc-f325-4551-91f6-9ca35fc50ebc",
"channel": "101",
"description": "Quisquam ipsa omnis architecto provident aspernatur. Commodi magnam iste facilis ipsam aspernatur praesentium ea fugit. Incidunt atque iste doloribus tenetur aspernatur perspiciatis saepe necessitatibus explicabo.",
"type": "sale",
"version": "non ad",
"settlementType": "gov",
"paymentMethod": "Credit Card",
"message": {
"code": "42910-9378",
"en": "Success",
"ar": "نجاح"
}
},
{
"paymentBatch": {
"paymentId": "d2c4288e-fdd0-4798-a371-2b6d4a6d25d0",
"paymentAudit": [
{
"executedBy": "b901e4a0-f68a-47de-b6b2-c73d51836b46",
"executedOn": "2024-10-01T14:50:40.489Z",
"externalOps": "Confirm",
"message": {
"code": "97837-8533",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "in-progress",
"externalRefId": "1d14002a-8627-48bf-814f-08724f2599be"
},
{
"executedBy": "51638f8f-90ed-4efa-9e2f-2e78d01fac22",
"executedOn": "2024-10-02T00:20:55.846Z",
"externalOps": "Confirm",
"message": {
"code": "08045-1255",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "completed",
"externalRefId": "d4954f60-a38b-4c0b-8ff7-51a71d39c1bf"
},
{
"executedBy": "dbb6c0ae-1e7b-4a09-83fe-064c304f4c5c",
"executedOn": "2024-10-02T08:51:32.750Z",
"externalOps": "DetailsByToken",
"message": {
"code": "56481-5514",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "in-progress",
"externalRefId": "43c18794-6aa2-48e1-ac6d-a5228e2b2fd8"
}
]
},
"transactionId": "88cb34ee-7942-42aa-baae-223b587a9e34",
"spCode": "DET",
"servCode": "31031-0848",
"spTrn": "8e0f8201-7401-4b8c-ad49-9400f0fa6230",
"degTrn": "faf343d1-8986-416b-a6bf-bee0aa226b8b",
"transactOn": "2024-10-01T23:22:06.964Z",
"transactBy": "dfee74b5-8fe7-41a8-92ad-073a3b3f013f",
"channel": "100",
"description": "Reprehenderit incidunt provident aperiam. Molestias consequatur non enim voluptate assumenda incidunt distinctio nesciunt qui. Possimus sint eligendi tempore voluptatibus nemo. Magnam nostrum officiis perspiciatis libero.",
"type": "sale",
"version": "Ut",
"settlementType": "private",
"paymentMethod": "Credit Card",
"message": {
"code": "27638",
"en": "Success",
"ar": "نجاح"
}
}
]
},
{
"invoiceId": "d37b37d1-7e2e-437f-9682-bd603c13d591",
"dulNumber": "477284257669398",
"quotedBy": "16955482-c5a5-4a38-a023-6f8b4209f819",
"pricedBy": "DET",
"serviceId": "e1278b59-7ed3-4c0d-9034-000f8b8817b2",
"serviceName": "Elegant Steel Computer",
"applicationId": "38662e73-9be1-45d0-9ad9-86ca7120115b",
"entityId": "RTA",
"payType": "PayToSubmit",
"total": 33610265.172100544,
"totalItem": 71755,
"currency": "KYD",
"quotedOn": "2024-10-02T04:42:23.517Z",
"expiredOn": "2024-10-01T11:50:21.336Z",
"status": "Pending Payment",
"availableActions": [
"ullamco cupidatat id enim Excepteur",
"laboris aliqua",
"consectetur"
],
"items": [
{
"itemId": "523420097116840",
"itemName": "Modern Metal Salad",
"beneficiaryId": "RTA",
"beneficiaryName": "Zieme LLC",
"amount": -72036786.24747258,
"description": "New range of formal shirts are designed keeping you in mind. With fits and styling that will make you stand apart"
},
{
"itemId": "706401460987899",
"itemName": "Handcrafted Metal Cheese",
"beneficiaryId": "RTA",
"beneficiaryName": "Marvin LLC",
"amount": -27368581.74360028,
"description": "The Football Is Good For Training And Recreational Purposes"
},
{
"itemId": "827507425157983",
"itemName": "Handmade Fresh Hat",
"beneficiaryId": "RTA",
"beneficiaryName": "Robel - Smith",
"amount": 90224433.21107191,
"description": "Boston's most advanced compression wear technology increases muscle oxygenation, stabilizes active muscles"
}
],
"transaction": [
{
"paymentBatch": {
"paymentId": "e3a753ad-53d5-4e1d-81d2-325b57cd82c2",
"paymentAudit": [
{
"executedBy": "28ccf966-9f73-4a4f-bce2-dbafc9c4312e",
"executedOn": "2024-10-01T13:16:55.521Z",
"externalOps": "Confirm",
"message": {
"code": "57624-7682",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "in-progress",
"externalRefId": "12a8de5b-df71-48e6-a5e4-3342b7f1264f"
},
{
"executedBy": "fddde54c-aef2-4fb7-983e-598ea31762c7",
"executedOn": "2024-10-02T07:09:49.631Z",
"externalOps": "Confirm",
"message": {
"code": "52475",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "in-progress",
"externalRefId": "390b6e4e-4097-4e63-b096-3310b99714a0"
},
{
"executedBy": "690a15e0-425f-4a2b-b562-69c67f9554c6",
"executedOn": "2024-10-01T12:41:38.336Z",
"externalOps": "Register",
"message": {
"code": "06707-1163",
"en": "Success",
"ar": "نجاح"
},
"externalStatus": "completed",
"externalRefId": "344d37d5-3717-442b-a441-ce107fab1aa7"
}
]
},
"transactionId": "dce2e163-292e-4f99-9608-6890081d9061",
"spCode": "DET",
"servCode": "15844-6646",
"spTrn": "a8b8769b-3555-41a7-b79a-a9f5d5962460",
"degTrn": "2925f1d5-83e2-45a1-a074-847a86787d30",
"transactOn": "2024-10-02T05:54:52.230Z",
"transactBy": "1f498fdf-25da-4704-bc03-b7e548eeee43",
"channel": "100",
"description": "Praesentium sed quibusdam omnis incidunt perspiciatis. Maiores repellat quasi ut quos. Quisquam sit pariatur sequi dolor rerum aut fugit. Architecto quam perferendis exercitationem. Aliquam sint commodi libero iure in blanditiis omnis.",
"type": "sale",
"version": "proident dolore Excepteur incididunt",
"settlementType": "gov",
"paymentMethod": "Credit Card",
"message": {
"code": "71194-4852",
"en": "Success",
"ar": "نجاح"
}
}
]
}
]
}Modified at 2024-10-02 11:18:37