Get Payments with Card Token

Overview

You can get a list of Payments associated with a card token GET method.

Resource Access

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

Example Request

🚧

GET https://<hostname>/payment/v1/cardEntity/9185deb392466f9c45cfd159446f3440fada17fead7d95bfec

Example Response


{
    "records": [
        {
            "id": "0d3601ce-1de1-4856-93be-08fc4f7cbaf0",
            "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:0d3601ce-1de1-4856-93be-08fc4f7cbaf0",
                "pif:d93e888ad2dd9c29875024aaba61dacf14fed9c3-cd8207b46e39e342e4ea7db3ceb47d49ca4e713a"
            ],
            "tags": [
                "SIP"
            ],
            "xmid": null,
            "buyer": {
                "id": "dee8bae1-4c0a-5c80-b919-8d773a485289",
                "name": "Aryan_Falcon_Buyer"
            },
            "ready": "2024-01-08T08:09:21.541Z",
            "amount": 0.01,
            "fileId": "d93e888ad2dd9c29875024aaba61dacf14fed9c3-cd8207b46e39e342e4ea7db3ceb47d49ca4e713a",
            "created": "2024-01-08T08:09:00Z",
            "creator": {
                "id": "0d3601ce-1de1-4856-93be-08fc4f7cbaf0",
                "username": "aryan.sharma+aws+critical"
            },
            "expired": "2024-01-08T13:32:53.107Z",
            "network": {
                "id": "725e5656-cf83-5b00-848b-0bfa884fc7e7",
                "name": "Cherrynet"
            },
            "pending": "2024-01-08T08:09:00Z",
            "fileDate": "2024-01-08T08:08:46Z",
            "filePath": "/cpx/aws/authorization/pif/archive/2024/01/CHN001.AryanFalconInstitution.InvoiceValidation2.txt",
            "modified": "2024-01-08T13:32:53.161Z",
            "modifier": {
                "id": "e24bda88-d9ed-5730-a311-05488b7d65ed",
                "username": "aryan.sharma+critical"
            },
            "supplier": {
                "id": "d4c3a1fa-aa77-57bb-afc9-2dd8eb2fb58b",
                "name": "Aryan_Supplier"
            },
            "accountId": null,
            "vcnStatus": "Success",
            "achDebitId": "599baa22-d575-58b0-bd11-66a0a339965e",
            "emailNotes": null,
            "importDate": "2024-01-08T08:08:46Z",
            "isProxyPay": false,
            "merchantId": "",
            "reference1": null,
            "reference2": null,
            "reference3": null,
            "reference4": null,
            "reference5": null,
            "settlement": {
                "unsettledAmount": 0.01
            },
            "statusDate": "2024-01-08T13:32:53.107Z",
            "accountType": "VCN",
            "checkNumber": null,
            "createdFrom": "PIF Upload",
            "hasInvoices": false,
            "institution": {
                "id": "a9214d62-fe59-55f8-a2da-99b7b9c5cc95",
                "name": "Aryan_Falcon_Institution"
            },
            "isSingleUse": true,
            "cardEntityId": "a8837b796ee0305a1cfac4f8fe461ad9bc6419c7f4a4257329",
            "invoiceCount": 0,
            "scheduleDate": null,
            "securityCode": {
                "hash": "75FS9/rT+o+JqxHTkKFJ6CdRG5tv8TdqdYdswRA98Z0=",
                "mask": ""
            },
            "vcnGenerated": "2024-01-08T08:09:28.550Z",
            "vcnReference": "906126408119",
            "hasFailedOver": false,
            "paymentMethod": "Card",
            "paymentStatus": "Expired",
            "transactionId": "0c52c5c9-533b-4f15-8e23-e2f476d11afa",
            "expirationDate": "2022-02-07T17:00:00.000Z",
            "originalAmount": 0.01,
            "vcnTokenNumber": "906126408119",
            "hasPendingDebit": false,
            "paymentAuthCode": null,
            "paymentCardType": null,
            "transactionDate": "2024-01-08T08:08:46Z",
            "expirationString": "0224",
            "paymentReference": null,
            "terminatedAmount": 0.01,
            "totalDebitAmount": 0.01,
            "externalAccountId": "AryanFalconInstitution-AryanFa",
            "virtualCardNumber": {
                "hash": "buAwWhz6xPj+RhrZvGQZx/SkJXMpWXzRVza3lL8rVCM=",
                "mask": "2690"
            },
            "achTransactionType": null,
            "paymentAuthMessage": "",
            "paymentProcessDate": "2024-01-08T08:09:21.441Z",
            "buyerBillingProduct": "Card",
            "paymentAccountNumber": "2690",
            "paymentStatusHistory": [
                "20240108030927 VCN Generated"
            ],
            "partialPaymentIndicator": null,
            "vcnAccountExpirationDate": "2022-02-07T17:00:00.000Z",
            "authorizations": [],
            "settlements": []
        }
    ],
    "totalRecords": 1
}



Priority Technology Holdings Logo