Skip to main content

Dealer & Customer Payment Set Listing

Description​

Used to view payment sets defined for dealers and customers.

  • URL:/api/erp/paymentSet
  • Method: GET
  • Header: Do not forget the AccessToken!
  • Filters: You can search using Dealer or Sub-Dealer ID or Code, Customer or Sub-Customer ID or Code parameters. Pagination is also available.
  • Response: Payment set information is returned in three layers: the default set, all defined sets, and the sets that the user can select.

Query Parameters (Filtering)​

ParameterTypeDescription
dealerCodestringDealer & Sub-Dealer code/erpCode value
customerCodestringCustomer & Sub-Customer code/erpCode value

Pagination​

You can organize the results using page (which page) and pageSize (how many records per page).

ParameterTypeDefaultDescription
pageint1Page to be retrieved
pageSizeint10Records per page

Response Structure​

For dealer members, the response returns payment sets in three layers:

  • defaultPaymentSetDefinition → The member’s default payment set information
  • paymentSetDefinition → All defined payment sets
  • usablePaymentSetDefinitionIds → Payment sets that the relevant user can select

For customer members, the response returns payment sets in three layers:

  • defaultPaymentSetDefinition → The member’s default payment set information
  • paymentSetDefinition → All defined payment sets
  • Since only one payment set can be defined for customer-type members, you will see that a single value is returned.
{  
    "id": "4cda620c-b041-4fa9-b256-78c8606be486",  
    "name": "Deneme ",  
    "isDefault": false,  
    "description": "",  
    "isActive": true,  
    "isShowNetAmount": false,  
    "canUserChangeCommApplyType": false,  
    "transactionType": 40,  
    "erpCode": "",  
    "usablePaymentSetDefinitions": []  
}