Get list of Payments for a Supplier
Overview
You can get list of Payments associated with a supplier via GET method.
Resource Access
GET https://<hostname>/payment/v1/supplier/{id}
Example Request
GET https://<hostname>/payment/v1/supplier/d4c3a1fa-aa77-57bb-afc9-2dd8eb2fb58b?size=2
Example Response
{
"aggregations": {
"totalAmount": {
"value": 1e+62
},
"settledCount": {
"doc_count": 4861
},
"settledAmount": {
"value": 92245.52
}
},
"totalRecords": 8287,
"totalType": "exact",
"recordCount": 2,
"records": [
{
"id": "a4a436da-3d3b-40a8-8afe-5b26223d447e",
"acl": [
"pps:cpx-acquiring",
"network:725e5656-cf83-5b00-848b-0bfa884fc7e7",
"institution:a9214d62-fe59-55f8-a2da-99b7b9c5cc95",
"buyer:dee8bae1-4c0a-5c80-b919-8d773a485289",
"supplier:d4c3a1fa-aa77-57bb-afc9-2dd8eb2fb58b",
"piftransaction:a4a436da-3d3b-40a8-8afe-5b26223d447e",
"pif:467b9d979f91d4c0e9ebb5fd55ff13978ffe2e7a-59084ae9a900f51d61c0eb05431458fc2591faab"
],
"tags": [
"SIP"
],
"xmid": null,
"buyer": {
"id": "dee8bae1-4c0a-5c80-b919-8d773a485289",
"name": "Aryan_Falcon_Buyer"
},
"ready": "2023-12-13T10:25:59.688Z",
"amount": 0.01,
"fileId": "467b9d979f91d4c0e9ebb5fd55ff13978ffe2e7a-59084ae9a900f51d61c0eb05431458fc2591faab",
"created": "2023-12-13T10:21:08Z",
"creator": {
"id": "a4a436da-3d3b-40a8-8afe-5b26223d447e",
"username": "aryan.sharma+aws+critical"
},
"faxSent": "2023-12-13T10:31:50.658Z",
"network": {
"id": "725e5656-cf83-5b00-848b-0bfa884fc7e7",
"name": "Cherrynet"
},
"pending": "2023-12-13T10:21:08Z",
"vcnLink": {
"hash": "t3TlICerVkmPv29tmj2QhLbZJ8w/IDh+a+YMJJs8Eoc=",
"mask": "RzQ9"
},
"fileDate": "2023-12-13T10:20:22Z",
"filePath": "/cpx/aws/authorization/pif/archive/2023/12/CHN001.AryanFalconInstitution.LoadTest2.txt",
"modified": "2024-01-12T17:15:42.419Z",
"modifier": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"supplier": {
"id": "d4c3a1fa-aa77-57bb-afc9-2dd8eb2fb58b",
"name": "Aryan_Supplier"
},
"accountId": null,
"vcnStatus": "Success",
"achDebitId": "97d72fca-0b98-58e7-be99-68ceea9723b2",
"emailNotes": null,
"importDate": "2023-12-13T10:20:22Z",
"isProxyPay": false,
"merchantId": "282063504",
"reference1": null,
"reference2": null,
"reference3": null,
"reference4": null,
"reference5": null,
"settlement": {
"unsettledAmount": 0.01
},
"statusDate": "2024-01-12T17:15:42.356Z",
"accountType": "VCN",
"checkNumber": null,
"createdFrom": "PIF Upload",
"hasInvoices": false,
"institution": {
"id": "a9214d62-fe59-55f8-a2da-99b7b9c5cc95",
"name": "Aryan_Falcon_Institution"
},
"isSingleUse": true,
"cardEntityId": "a87eaba834090d07f5272ca20bea094db1d6e90ad92ffe9b65",
"invoiceCount": 0,
"scheduleDate": null,
"securityCode": {
"hash": "75FS9/rT+o+JqxHTkKFJ6CdRG5tv8TdqdYdswRA98Z0=",
"mask": ""
},
"vcnReference": "906126394343",
"paymentMethod": "Card",
"paymentStatus": "Expired",
"transactionId": "d42ee876-2f7f-4b45-bc58-5a5221003d64",
"expirationDate": "2024-01-12T17:00:00.000Z",
"originalAmount": 0.01,
"vcnFaxSentDate": "2023-12-13T10:31:50.658Z",
"vcnTokenNumber": "906126394343",
"hasPendingDebit": false,
"paymentAuthCode": null,
"paymentCardType": null,
"transactionDate": "2023-12-13T10:20:22Z",
"expirationString": "0124",
"paymentReference": null,
"totalDebitAmount": 10,
"externalAccountId": "AryanFalconInstitution-AryanFa",
"virtualCardNumber": {
"hash": "NAkNB/UnLKIL6glNsdbpCtkv/ptlF3lz0MUzxwCQxGA=",
"mask": "8283"
},
"achTransactionType": null,
"paymentAuthMessage": "",
"paymentProcessDate": "2023-12-13T10:25:14.811Z",
"buyerBillingProduct": "Card",
"paymentAccountNumber": "8283",
"paymentStatusHistory": [
"20231213053150 Fax Sent"
],
"partialPaymentIndicator": null,
"vcnAccountExpirationDate": "2024-01-12T17:00:00.000Z",
"hasFailedOver": false,
"terminatedAmount": 0.01,
"expired": "2024-01-12T17:15:42.356Z"
},
{
"id": "201da0bf-fcaa-4f6c-bb07-cf6523a59c28",
"acl": [
"pps:cpx-acquiring",
"network:725e5656-cf83-5b00-848b-0bfa884fc7e7",
"institution:a9214d62-fe59-55f8-a2da-99b7b9c5cc95",
"buyer:dee8bae1-4c0a-5c80-b919-8d773a485289",
"supplier:d4c3a1fa-aa77-57bb-afc9-2dd8eb2fb58b",
"piftransaction:201da0bf-fcaa-4f6c-bb07-cf6523a59c28",
"pif:d768cc8c7da367cb046db308d512e19772b8774e-faefcbf1fff69e776e7fa97a7443fb1167e8a284"
],
"tags": [
"SIP"
],
"xmid": null,
"buyer": {
"id": "dee8bae1-4c0a-5c80-b919-8d773a485289",
"name": "Aryan_Falcon_Buyer"
},
"ready": "2024-01-09T08:53:49.882Z",
"amount": 0.01,
"fileId": "d768cc8c7da367cb046db308d512e19772b8774e-faefcbf1fff69e776e7fa97a7443fb1167e8a284",
"created": "2024-01-09T08:08:02Z",
"creator": {
"id": "201da0bf-fcaa-4f6c-bb07-cf6523a59c28",
"username": "aryan.sharma+aws+critical"
},
"network": {
"id": "725e5656-cf83-5b00-848b-0bfa884fc7e7",
"name": "Cherrynet"
},
"pending": "2024-01-09T08:08:02Z",
"fileDate": "2024-01-09T08:07:04Z",
"filePath": "/cpx/aws/authorization/pif/archive/2024/01/CHN001.AryanFalconInstitution.InvoiceDuplicate3.txt",
"modified": "2024-02-08T18:07:39.543Z",
"modifier": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"supplier": {
"id": "d4c3a1fa-aa77-57bb-afc9-2dd8eb2fb58b",
"name": "Aryan_Supplier"
},
"accountId": null,
"vcnStatus": "Success",
"achDebitId": "23a9690e-fd0f-5723-b3da-448fd1b40420",
"emailNotes": null,
"importDate": "2024-01-09T08:07:04Z",
"isProxyPay": false,
"merchantId": "",
"reference1": null,
"reference2": null,
"reference3": null,
"reference4": null,
"reference5": null,
"settlement": {
"unsettledAmount": 0.01
},
"statusDate": "2024-02-08T18:07:39.350Z",
"accountType": "VCN",
"checkNumber": null,
"createdFrom": "PIF Upload",
"hasInvoices": true,
"institution": {
"id": "a9214d62-fe59-55f8-a2da-99b7b9c5cc95",
"name": "Aryan_Falcon_Institution"
},
"isSingleUse": true,
"cardEntityId": "4aea5ff0b0e46baeccf11a7a42150a052aa1ade024ffeeffef",
"invoiceCount": 100,
"scheduleDate": null,
"securityCode": {
"hash": "75FS9/rT+o+JqxHTkKFJ6CdRG5tv8TdqdYdswRA98Z0=",
"mask": ""
},
"vcnGenerated": "2024-01-09T09:17:55.704Z",
"vcnReference": "906126418670",
"paymentMethod": "Card",
"paymentStatus": "Expired",
"transactionId": "d0cd37fa-f731-400a-9d6c-62efc66088c8",
"expirationDate": "2024-02-08T17:00:00.000Z",
"originalAmount": 0.01,
"vcnTokenNumber": "906126418670",
"hasPendingDebit": false,
"paymentAuthCode": null,
"paymentCardType": null,
"transactionDate": "2024-01-09T08:07:04Z",
"expirationString": "0224",
"paymentReference": null,
"totalDebitAmount": 1,
"externalAccountId": "AryanFalconInstitution-AryanFa",
"virtualCardNumber": {
"hash": "sORrrszxGnpCFQoFKqGt4CT/7v/v9TkkG//PITqWxjE=",
"mask": "8807"
},
"achTransactionType": null,
"paymentAuthMessage": "",
"paymentProcessDate": "2024-01-09T08:53:20.322Z",
"buyerBillingProduct": "Card",
"paymentAccountNumber": "8807",
"paymentStatusHistory": [
"20240109041753 VCN Generated"
],
"partialPaymentIndicator": null,
"vcnAccountExpirationDate": "2024-02-08T17:00:00.000Z",
"hasFailedOver": false,
"terminatedAmount": 0.01,
"expired": "2024-02-08T18:07:39.350Z"
}
]
}
Updated 3 days ago