Payment Details

Endpoint: /pws/payment/transaction
HTTP Method: GET
Request Content-Type: application/json (optional)
Response Content-Type: application/json
Authorization: A valid AccessToken is required. (See: 2. Authentication – Obtaining AccessToken)

Description

Returns all details of a payment transaction. Compatible with ERP’s GetPayment output (field names & meanings).

Query can be made via transactionId, referenceNumber, or clientReferenceNumber.
Applicable for all transactions, 3D/Non-3D, single or installment payments.

Header Information

Header Name	Required	Description
Authorization	Yes	Valid token in `Bearer {AccessToken}` format.
Content-Type	No	`application/json`

Query Parameters (GET)

At least one of the following identifiers is required

Parameter	Type	Required	Description
`transactionId`	string (GUID)	Yes*	Unique system ID of the transaction.
`referenceNumber`	string	Yes*	System reference (e.g., `NTH2P00000002250`).
`clientReferenceNumber`	string	Yes*	Merchant/order reference.

Send at least one. Sending multiple will result in 404 error.

Sample Requests (GET)

/pws/payment/transaction?transactionId=99248acb-3dbe-4654-9f3f-49f02111ee3e
/pws/payment/transaction?referenceNumber=NTH2P00000002249
/pws/payment/transaction?clientOrderReferenceCode=11001122011

Response Structure

data (Transaction) Fields

Top-Level Fields

Field	Type	Example	Description
`clientReferenceNumber`	string	null	`"ORDER-2025-0001"`	Merchant/order reference.
`referenceNumber`	string	`"NTH2P00000002250"`	System reference number.
`tenantId`	string (GUID)	`"670683c1-2fe0-4846-87b2-6cba9b793ab2"`	Tenant the transaction belongs to.
`tenantPosId`	string (GUID)	`"384badef-11ec-ee11-98f2-005056b0d2e5"`	Used POS record.
`commRate`	number	`1.0000`	Applied commission rate (%).
`currencyType`	string	`"TRY"`	Transaction currency (e.g., TRY).
`transactionDate`	string (ISO datetime)	`"2025-10-24T17:23:51.5461093"`	Transaction date/time.
`transactionDetailId`	string (GUID)	`"99624afe-b2ee-4483-2f6c-08de12f76968"`	Detail record ID.
`installment`	integer	`1`	Number of installments.
`lastAmount`	number	`54.00`	Final (gross) amount.
`lastNetAmount`	number	`53.46`	Net amount after commission.
`id`	string (GUID)	`"49acb76f-d4ea-427b-a1b3-46532fb87653"`	Unique system ID of the transaction (transactionId).
`vposCommRate`	number	`1.0000`	Bank/VPos commission rate.
`bankPaymentDays`	integer	null	`null`	Bank payment term (days).
`paymentSetErpCode`	string	`"Kobi"`	Payment set ERP code.
`vPosERPCode`	string	`"29072025"`	VPos ERP code/ID.
`impersonated`	boolean	`true`	Indicates if transaction was made on behalf of someone.
`paidTenantId`	string (GUID)	null	`null`	If payment is made on behalf of another tenant.
`rePayPlanCode`	string	null	`null`	Repayment plan code (if any).
`currencyId`	string (GUID)	`"8e6cc739-83e0-4af5-accf-a55476e758c6"`	Internal currency ID.
`erpTransactionCode`	string	null	`null`	ERP transaction/voucher code.
`erpTransactionCodeUpdateDate`	string (ISO)	null	`null`	ERP code update timestamp.
`errorMessage`	string	null	`null`	Error message (if any).
`errorCode`	string	null	`null`	Error code (if any).
`transactionStatusId`	integer	`1`	Transaction status (see Status Note).
`reversal`	object	null	`null`	Cancellation/Refund info (if available as object).

agent

Field	Type	Example	Description
`agentId`	string (GUID)	`"1f9c9e65-1bf3-48fc-887a-42c325d21cd2"`	Customer/merchant unique ID.
`name`	string	`"example user"`	Name/Title.
`email`	string	`"[email protected]"`	Email.
`agentCode`	string	`"NT53240185"`	Code.
`erpCode`	string	`""`	ERP code.
`workplaceCode`… `businessCode`	string	null	`null`	ERP fields (optional).
`isCompany`	boolean	`false`	Is it a company?
`isCustomer`	boolean	`true`	Customer flag.
`taxNumber`	string	null	`null`	Tax number.
`customerRepresentativeIds`	array	`[]`	Representative IDs.
`dynamicFields`	array	`[]`	Custom fields.

paymentAccountTransactions

Field	Type	Example	Description
`amount`	number	`0.0`	Related accounting/account transaction amount.
`erpCode`	string	null	`null`	Account ERP code.
`transactionErpCode`	string	null	`null`	Transaction ERP code.

paymentGeneral

Field	Type	Example	Description
`plusInstallment`	integer	`0`	Extra installment.
`deferral`	integer	`0`	Deferral (days/months—depends on setup).
`commApplyType`	string	`"Inside"`	Commission application type (`Inside`/`Excluded`).
`provisionNumber`	string	null	`null`	Authorization number.
`paymentSetName`	string	null	`null`	Payment set name.
`paymentItemGroupName`	string	null	`null`	Item group name.
`paymentItemName`	string	null	`null`	Item name.
`paymentItemErpCode`	string	null	`null`	Item ERP code.
`paymentItemCode`	string	null	`null`	Item code.
`paymentItemStartDate`	string	null	`null`	Start date.
`paymentItemEndDate`	string	null	`null`	End date.
`paymentItemAmount`	number	null	`null`	Item amount.
`dynamicFields`	array	`[]`	Custom fields.

paymentContact

Field	Type	Example	Description
`taxNumber`	string	`"26179246186"`	TCKN/VKN (example: TCKN).
`fullName`	string	`"john Doe"`	Full name.
`description`	string	`"test"`	Description.
`phoneNumber`	string	`"5888888888"`	Phone number.
`email`	string	`"[email protected]"`	Email.

paymentSet

Field	Type	Example	Description
`id`	string (GUID)	`"504978bf-bebd-40c5-89aa-b76f3a20341c"`	Set ID.
`name`	string	`"QNB Set"`	Set name.
`erpCode`	string	`"QNBSeti"`	Set ERP code.
`transactionType`	string	`"Authorization"`	Transaction type (depends on setup).
`commApplyType`	string	`"Inside"`	Commission application type.

creditCard

Field	Type	Example	Description
`cardHolderName`	string	`"Test Test"`	Name on card.
`cardNumber`	string (masked)	`"415565******6111"`	Masked PAN (first 6 + last 4).
`cardType`	string	`"Visa"`	Card scheme.
`cardBank`	string	`"QNB Finansbank"`	Card bank.
`cardClass`	string	`"Classic"`	Card class.

Sample Response
Sample cURL

{  
    "clientReferenceNumber": null,  
    "referenceNumber": "NTH2P00000002250",  
    "tenantId": "670683c1-2fe0-4846-87b2-6cba9b793ab2",  
    "tenantPosId": "384badef-11ec-ee11-98f2-005056b0d2e5",  
    "commRate": 1.0000,  
    "currencyType": "TRY",  
    "transactionDate": "2025-10-24T17:23:51.5461093",  
    "transactionDetailId": "99624afe-b2ee-4483-2f6c-08de12f76968",  
    "installment": 1,  
    "lastAmount": 54.00,  
    "lastNetAmount": 53.46,  
    "id": "49acb76f-d4ea-427b-a1b3-46532fb87653",  
    "vposCommRate": 1.0000,  
    "bankPaymentDays": null,  
    "paymentSetErpCode": "Kobi",  
    "vPosERPCode": "29072025",  
    "impersonated": true,  
    "paidTenantId": null,  
    "rePayPlanCode": null,  
    "agent": {  
        "agentId": "1f9c9e65-1bf3-48fc-887a-42c325d21cd2",  
        "name": "0210 Deneme 0210 Deneme",  
        "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": "Inside",  
        "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": "504978bf-bebd-40c5-89aa-b76f3a20341c",  
        "name": "QNB Set",  
        "erpCode": "QNBSeti",  
        "transactionType": "Authorization",  
        "commApplyType": "Inside"  
    },  
    "creditCard": {  
        "cardHolderName": "Test Test",  
        "cardNumber": "415565******6111",  
        "cardType": "Visa",  
        "cardBank": "QNB Finansbank",  
        "cardClass": "Classic"  
    },  
    "erpTransactionCode": null,  
    "erpTransactionCodeUpdateDate": null,  
    "errorMessage": null,  
    "errorCode": null,  
    "transactionStatusId": 1,  
    "reversal": null  
}

curl --location 'https://pgw.netahsilatdemo.com/pws/transaction?transactionId=49acb76f-d4ea-427b-a1b3-46532fb87653' \  
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJwd3N2MS5hcGkiLCJlcnB2MS5hcGkiLCJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiOGE2NjQxZGYtMGU4Ny00OWVkLWEyOTgtNjNjN2M3Y2JjNTk1IiwiVGVuYW50SWQiOiI2NzA2ODNjMS0yZmUwLTQ4NDYtODdiMi02Y2JhOWI3OTNhYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5NzA3MjQxNDMzMzI2OTUiLCJuYmYiOjE3NjEzMDI4MTQsImV4cCI6MTc2MTQ3NTYxNCwiaWF0IjoxNzYxMzAyODE0LCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.IbmVm9oVxUvDXhzYnCncNMYPBFqqJTXFQLkFYfhSbUA'

Notes & Best Practices

Direct ID: Use transactionId whenever possible for the most accurate match.
In 3D flows, call this endpoint after OTP confirmation to verify the result.
Card PAN is returned masked; full PAN is never returned.
After cancellation/refund, check the updated status again via this endpoint.

Description​

Header Information​

Query Parameters (GET)​

Top-Level Fields​

agent​

paymentAccountTransactions​

paymentGeneral​

paymentContact​

paymentSet​

creditCard​

Notes & Best Practices​