Skip to main content

Listing Payment Transactions

Description​

Used to query all payment transactions integrated into the ERP.

  • URL: /erp/payments?page=1\&pageSize=10
  • Method: GET
  • Header: Do not forget the AccessToken!
  • Filters: You can use the filters clientReferenceCode, referenceCode, transactionId, NonIntegrated, StartDate, EndDate, userCode, vendorErpCode. Pagination is also available.
  • Important Note: If the vposTransactionDetails.erpTransactionCode field is populated, it means the transaction has been successfully transferred to the ERP. You can also use date range filters (startDate, endDate).

Query Parameters (Filtering)​

ParameterTypeDescription
clientReferenceCodestringReference code defined by the customer
referenceCodestringNetahsilat transaction reference
transactionIdstringTransaction ID in the database
NonIntegratedbooleanIndicates whether it has been transferred or not
StartDatestring($date-time)Payment date start
EndDatestring($date-time)Payment date end
userCodestringCode of the user who performed the transaction
vendorErpCodestringERP code of the POS provider

Filtering can be performed using one or more of these fields in combination.

    {  
    "data": [  
        {  
            "clientReferenceNumber": null,  
            "referenceNumber": "NTH15P0000000092",  
            "tenantId": "2e64d939-d56f-4c78-a76f-84d0d445067b",  
            "tenantPosId": "a17b5b02-388e-f011-98fc-005056b0d2e5",  
            "commRate": 0.0000,  
            "currencyType": "TRY",  
            "transactionDate": "2025-09-11T14:37:39.3580599",  
            "transactionDetailId": "f12b4f75-590e-46c2-a6e7-08ddf12841c8",  
            "installment": 1,  
            "lastAmount": 52.00,  
            "lastNetAmount": 52.00,  
            "id": "5285c1d5-68c5-402d-8ac7-dce5191ac175",  
            "vposCommRate": 0.0000,  
            "bankPaymentDays": null,  
            "paymentSetErpCode": "Kobi",  
            "vPosERPCode": "",  
            "impersonated": true,  
            "paidTenantId": null,  
            "rePayPlanCode": null,  
            "agent": {  
                "agentId": "1f9c9e65-1bf3-48fc-887a-42c325d21cd2",  
                "name": "John",  
                "email": "[email protected]",  
                "agentCode": "NT53240185",  
                "erpCode": "",  
                "workplaceCode": null,  
                "departmentCode": null,  
                "speCode": null,  
                "authCode": null,  
                "projectCode": null,  
                "salesmanCode": null,  
                "busTranCode": null,  
                "branchCode": null,  
                "businessCode": null,  
                "isCompany": false,  
                "isCustomer": true,  
                "taxNumber": null,  
                "customerRepresentativeIds": [],  
                "dynamicFields": []  
            },  
            "currencyId": "8e6cc739-83e0-4af5-accf-a55476e758c6",  
            "paymentAccountTransactions": [  
                {  
                    "amount": 0.0,  
                    "erpCode": null,  
                    "transactionErpCode": null  
                }  
            ],  
            "paymentGeneral": {  
                "plusInstallment": 0,  
                "deferral": 0,  
                "commApplyType": "Dışında",  
                "provisionNumber": null,  
                "paymentSetName": null,  
                "paymentItemGroupName": null,  
                "paymentItemName": null,  
                "paymentItemErpCode": null,  
                "paymentItemCode": null,  
                "paymentItemStartDate": null,  
                "paymentItemEndDate": null,  
                "paymentItemAmount": null,  
                "dynamicFields": []  
            },  
            "paymentContact": {  
                "taxNumber": "00000000000",  
                "fullName": "John Doe",  
                "description": "test",  
                "phoneNumber": "5074458449",  
                "email": "[email protected]"  
            },  
            "paymentSet": {  
                "id": "2762130d-d34d-4ddf-b8c0-ca9c49b8c5e5",  
                "name": "Ödeme Seti Test",  
                "erpCode": "55555",  
                "transactionType": "Provizyon",  
                "commApplyType": "Dışında"  
            },  
            "creditCard": {  
                "cardHolderName": "John Doe",  
                "cardNumber": "415565******6111",  
                "cardType": "Visa",  
                "cardBank": "QNB Finansbank",  
                "cardClass": "Classic"  
            },  
            "erpTransactionCode": null,  
            "erpTransactionCodeUpdateDate": null,  
            "errorMessage": null,  
            "errorCode": null,  
            "transactionStatusId": 0  
        }  
    ]  
}