Get list of Payments

Overview

You can get list of Payments associated with GET method.

Resource Access

GET https://<hostname>/payment/v1/payment

Example Request

🚧

GET https://<hostname>/payment/v1/payment?sort=created%3Adesc&size=2

Example Response


{
    "aggregations": {
        "totalAmount": {
            "value": 5.05000000000005e+80
        },
        "settledCount": {
            "doc_count": 182670
        },
        "settledAmount": {
            "value": 98331372.43
        }
    },
    "totalRecords": 696659,
    "totalType": "exact",
    "recordCount": 2,
    "records": [
        {
            "settlements": [
                {
                    "transactionCodeType": "VSC",
                    "balance": "159.00",
                    "interchangeFee": 150,
                    "created": "2020-08-05T19:15:44.114Z",
                    "transactionAmount": 20281.04,
                    "id": "acbb1581-914d-51df-8dda-30c78755f239",
                    "timestamp": "2020-08-05T12:00:00.000Z"
                },
                {
                    "transactionCodeType": "VSC",
                    "balance": "0.00",
                    "interchangeFee": 4.39,
                    "created": "2020-09-24T22:10:26.943Z",
                    "transactionAmount": 159,
                    "id": "83c30784-5193-52eb-b5f5-efd848d891a8",
                    "timestamp": "2020-09-24T12:00:00.000Z"
                }
            ],
            "statusDate": "2020-09-24T22:09:41.000Z",
            "modifier": {
                "id": "50335456-0300-45cc-b01c-37c5f20f69b2",
                "username": "system"
            },
            "acl": [
                "network:6308287485908074496",
                "institution:d69256cd-c742-55f7-bf56-38b9727fcaeb",
                "buyer:f203336e-1bb0-52fc-aad9-68364aa3618b",
                "pps:cpx-acquiring",
                "pif:470b3691-210a-50aa-b13a-140bf78ffcf6",
                "supplier:493e7cea-27a9-51f5-b6dc-406a6660a5c5"
            ],
            "vcnStatus": "Success",
            "authorization": {
                "amtAvail": -159,
                "authAmount": 159,
                "authDateTime": "2020-09-23T16:19:10.000Z"
            },
            "institution": {
                "id": "d69256cd-c742-55f7-bf56-38b9727fcaeb",
                "name": "Inworks"
            },
            "authorized": "2020-08-06T22:10:52.000Z",
            "supplier": {
                "id": "493e7cea-27a9-51f5-b6dc-406a6660a5c5",
                "name": "Brasseler USA Medical"
            },
            "modified": "2020-09-25T15:28:48.096Z",
            "paymentProcessDate": "2020-07-31T20:35:21.089Z",
            "id": "0fe7847d-ed3b-590a-86eb-d5acc0e79d63",
            "paymentStatusHistory": [
                "20200924221026 Settled"
            ],
            "paymentAccountNumber": "9613",
            "created": "2020-07-31T19:32:40.546Z",
            "settled": "2020-09-24T22:09:41.000Z",
            "accountType": "VCN",
            "invoiceCount": 0,
            "transactionId": "20073112320064",
            "buyer": {
                "id": "f203336e-1bb0-52fc-aad9-68364aa3618b",
                "name": "Surgical Partners B"
            },
            "tags": [
                "SIP"
            ],
            "expirationString": "0920",
            "externalAccountId": "IW002-EAS001A",
            "buyerBillingProduct": "Card",
            "partiallySettled": "2020-08-05T19:13:41.000Z",
            "paymentMethod": "Card",
            "vcnAccountExpirationDate": "2020-09-29T12:00:00.000Z",
            "vcnTokenNumber": "906102375415",
            "isSingleUse": false,
            "fileId": "470b3691-210a-50aa-b13a-140bf78ffcf6",
            "vcnGenerated": "2020-07-31T20:36:45.210Z",
            "awaitingApproval": "2020-07-31T19:33:19.330Z",
            "reference3": "eamc",
            "hasPendingDebit": false,
            "paymentAuthMessage": "",
            "reference4": "",
            "vcnReference": "906102375415",
            "reference5": "",
            "pending": "2020-07-31T19:32:40.132Z",
            "authorizations": [
                {
                    "amount": 20281.04,
                    "created": "2020-09-23T16:19:16.046Z",
                    "transactionAmount": 20281.04,
                    "id": "f57b8aa7-7a46-538b-8e0f-59fa2f8d8645",
                    "timestamp": "2020-08-04T15:00:55.000Z"
                },
                {
                    "amount": 159,
                    "created": "2020-09-23T16:19:16.046Z",
                    "transactionAmount": 159,
                    "id": "4752a374-2445-408e-9d61-eaa4874f28e6",
                    "timestamp": "2020-08-06T22:10:52.000Z"
                },
                {
                    "amount": 159,
                    "created": "2020-09-23T16:19:16.046Z",
                    "transactionAmount": 159,
                    "id": "256b805c-7d57-52d1-a945-a9a2a793ef93",
                    "timestamp": "2020-09-23T16:19:10.000Z"
                }
            ],
            "reference1": "EAS001",
            "reference2": "STR12",
            "network": {
                "id": "6308287485908074496",
                "name": "Priority One Network"
            },
            "partiallyAuthorized": "2020-08-04T18:00:55.000Z",
            "settlement": {
                "amount": 20440.04,
                "balance": "0.00",
                "unsettledAmount": 0,
                "settlementAmount": 159,
                "settlementDateTime": "2020-09-24T22:09:41.000Z",
                "status": "Settled"
            },
            "partialPaymentIndicator": "N",
            "importDate": "2020-07-31T19:32:40.127Z",
            "ready": "2020-07-31T20:35:21.089Z",
            "cardEntityId": "332a20738f8a5c7978db7cef3e54067fb945e9fd9f951af090",
            "isProxyPay": false,
            "paymentStatus": "Settled",
            "expirationDate": "2020-09-29T12:00:00.000Z",
            "amount": 20440.04,
            "creator": {
                "id": "c224fa1b-60ef-5496-9a80-bc8db9feea3f",
                "username": "[email protected]"
            },
            "hasInvoices": false,
            "filePath": "pps01.IW002.pif.pif07312020123239_20200731153239.csv",
            "securityCode": {
                "hash": "BlwoilC7T3cPmiEbIBPNNiMwoCoXmcy23gMIg6fxXh4=",
                "mask": ""
            },
            "fileDate": "2020-07-31T00:00:00.000Z",
            "transactionDate": "2020-07-31T19:32:40.127Z",
            "declined": "2020-09-23T16:19:10.000Z",
            "createdFrom": "Single Payment",
            "originalAmount": 20440.04,
            "virtualCardNumber": {
                "hash": "j4pceXjbfO8+VAZ/uUXp/Z+VGvCQm5gbXV6/BJfQfv0=",
                "mask": "9613"
            }
        },
        {
            "accountId": "",
            "accountType": "VCN",
            "acl": [
                "pps:cpx-acquiring",
                "pif:17cb9727-58ac-5a53-8e42-790ca04f8189",
                "network:b5027e31-b9d6-577c-b600-69c03c1f7c90",
                "institution:5914a690-00d0-5981-8d83-5c3b0c607c75",
                "buyer:6411ac90-4290-5a75-a672-e80870fe2e84",
                "supplier:aa39c8b1-78ea-505e-8a33-0d85e5c72276"
            ],
            "amount": 0.01,
            "buyer": {
                "id": "6411ac90-4290-5a75-a672-e80870fe2e84",
                "name": "Quality Assurance Buyer United"
            },
            "buyerBillingProduct": "Card",
            "cardRules": {
                "activeInd": "Active",
                "admClientId": "6053",
                "admOptionId": "VP01P",
                "amtAvail": 0.01,
                "bid": "qualityAssuranceBidUnited",
                "buyerName": "Quality Assurance Buyer United",
                "creditLmt": 0.01,
                "dateEffective": {
                    "dateBegin": "2019-06-21",
                    "dateEnd": "2019-07-11"
                },
                "dateExp": "2019-07-11",
                "dateSettlementExp": "2019-07-31",
                "exactAmtInd": true,
                "finId": "F411",
                "pan": {
                    "hash": "E2NRVZDCNsJ6zFHnXKpJLBvo3DMitRw053htyPJBg3c=",
                    "mask": "1498"
                },
                "pifTransactionId": "b47cb023-fd4d-54ab-9b13-931aee85f360",
                "processingType": "0000",
                "settlementExpDays": "20",
                "sid": "qualityAssuranceSidUnited",
                "useMethod": {
                    "cash": true,
                    "creditAdj": true,
                    "debitAdj": false,
                    "eCom": false,
                    "mailPhnOrder": false,
                    "purch": false,
                    "return": false
                },
                "validDays": "20"
            },
            "created": "2019-06-21T17:12:27.550Z",
            "createdFrom": "Single Payment",
            "creator": {
                "id": "0bf02ae2-490e-5b20-8d43-7bff481a7cc4",
                "username": "qa+networkadmin"
            },
            "emailNotes": "",
            "externalAccountId": "qualityAssuranceFidUnited-qual",
            "failed": "2019-06-21T17:15:08.985Z",
            "failedPaymentNotificationSent": "2019-10-17T18:06:43.629Z",
            "fileDate": "2019-06-21T00:00:00.000Z",
            "fileId": "17cb9727-58ac-5a53-8e42-790ca04f8189",
            "filePath": "qualityAssuranceNid.qualityAssuranceFidUnited.pif.______createVCN4_______20190621131226.csv",
            "hasInvoices": false,
            "id": "b47cb023-fd4d-54ab-9b13-931aee85f360",
            "importDate": "2019-06-21T17:12:27.096Z",
            "institution": {
                "id": "5914a690-00d0-5981-8d83-5c3b0c607c75",
                "name": "Quality Assurance Payment Institution United"
            },
            "isSingleUse": true,
            "modified": "2020-07-31T16:49:49.089Z",
            "modifier": {
                "id": "83ae5073-82e4-4644-b83d-ee5026ae1390",
                "username": "system.user"
            },
            "network": {
                "id": "b5027e31-b9d6-577c-b600-69c03c1f7c90",
                "name": "Quality Assurance Network"
            },
            "originalAmount": 0.01,
            "partialPaymentIndicator": "Y",
            "paymentAccountNumber": "",
            "paymentAuthMessage": "United Errors - Account Identifier Error",
            "paymentMethod": "Card",
            "paymentProcessDate": "2019-06-21T17:12:27.290Z",
            "paymentStatus": "Failed",
            "paymentStatusHistory": [
                "20190621171508 Failed United Errors - Account Identifier Error"
            ],
            "pending": "2019-06-21T17:12:27.097Z",
            "ready": "2019-06-21T17:12:27.835Z",
            "statusDate": "2019-06-21T17:12:27.096Z",
            "supplier": {
                "id": "aa39c8b1-78ea-505e-8a33-0d85e5c72276",
                "name": "Quality Assurance Payee United"
            },
            "tags": [
                "SIP"
            ],
            "transactionDate": "2019-06-21T17:12:27.096Z",
            "transactionId": "createVCN4-NEGATIVE-TEST-PAYMENT-B84D47AEA1"
        }
    ]
}




Priority Technology Holdings Logo