{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Interchange fee API", "version": "2.41.1" }, "items": [ { "info": { "name": "Interchange fee", "type": "folder" }, "items": [ { "info": { "name": "Based on TransactionID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/transactions/:transactionId", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "transactionId", "value": "TDS17133017774902264", "type": "path", "description": "The Transaction ID identifies a presentment" }, { "name": "transactionDate", "value": "2017-05-01", "type": "query", "description": "Transaction Date (yyyy-mm-dd), known as transaction posting date" } ] }, "docs": "This API call will retrieve the interchange fee for a single transaction. \n" }, { "info": { "name": "Based on a Payment Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/payments", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "paymentId", "value": "SO-000000017036619028", "type": "query", "description": "Unique identification of the payment in which this transaction has been paid out" }, { "name": "paymentDate", "value": "2017-05-01", "type": "query", "description": "Payment Date (yyyy-mm-dd)" }, { "name": "sortField", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Use this operation to retrieve the interchange fees for a Payment\n\n- The result of this operation is a list of interchange fees that belongs to a payment\n- If there is a previous and/or next page the http response header will have a link (url) to this data \n" }, { "info": { "name": "holding level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/holdings/:holdingId", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "holdingId", "value": "200", "type": "path", "description": "Unique identification of the holdingId, determined by equensWorldline" }, { "name": "startDateTime", "value": "2019-03-01 12:30:00", "type": "query", "description": "Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value)" }, { "name": "endDateTime", "value": "2019-03-01 13:30:00", "type": "query", "description": "End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded)" }, { "name": "sortField", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "This operation retrieves all interchange fees on merchant hierarchy (for example holding) level\n\n- The result of this operation is a list of interchange fees that belongs to a contract level.\n- If there is a previous and/or next page the http response header will have a link (url) to this data \n" }, { "info": { "name": "Merchant level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/merchants/:merchantId", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "merchantId", "value": "1280300", "type": "path", "description": "Unique identification of the merchant, determined by equensWorldline" }, { "name": "startDateTime", "value": "2019-03-01 12:30:00", "type": "query", "description": "Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value)" }, { "name": "endDateTime", "value": "2019-03-01 13:30:00", "type": "query", "description": "End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded)" }, { "name": "sortField", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "This operation retrieves all interchange fees on merchant level\n\n- The result of this operation is a list of interchange fees that belongs to a contract level.\n- If there is a previous and/or next page the http response header will have a link (url) to this data \n" }, { "info": { "name": "Contract level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/contracts/:contractId", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "contractId", "value": "12872", "type": "path", "description": "Unique identification of the contract, determined by the acquirer" }, { "name": "startDateTime", "value": "2019-03-01 12:30:00", "type": "query", "description": "Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value)" }, { "name": "endDateTime", "value": "2019-03-01 13:30:00", "type": "query", "description": "End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded)" }, { "name": "sortField", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "This operation retrieves all interchange fees on contract level\n\n- The result of this operation is a list of interchange fees that belongs to a contract level.\n- If there is a previous and/or next page the http response header will have a link (url) to this data \n" }, { "info": { "name": "Site level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/contracts/:contractId/sites/:siteId", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "contractId", "value": "12872", "type": "path", "description": "Unique identification of the contract, determined by the acquirer" }, { "name": "siteId", "value": "30010", "type": "path", "description": "Unique identification of the site within the contract" }, { "name": "startDateTime", "value": "2019-03-01 12:30:00", "type": "query", "description": "Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value)" }, { "name": "endDateTime", "value": "2019-03-01 13:30:00", "type": "query", "description": "End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded)" }, { "name": "sortField", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "This operation retrieves all interchange fees on site level\n\n- The result of this operation is a list of interchange fees that belongs to a contract level.\n- If there is a previous and/or next page the http response header will have a link (url) to this data \n" }, { "info": { "name": "Terminal level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/acquiring/interchangefees/v2.0/acquirers/:acquirerId/contracts/:contractId/sites/:siteId/terminals/:terminalId", "params": [ { "name": "acquirerId", "value": "671234567", "type": "path", "description": "Unique identification of the acquirer, determined by equensWorldline" }, { "name": "contractId", "value": "12872", "type": "path", "description": "Unique identification of the contract, determined by the acquirer" }, { "name": "siteId", "value": "30010", "type": "path", "description": "Unique identification of the site within the contract" }, { "name": "terminalId", "value": "20YT45", "type": "path", "description": "Unique code identifying the terminal at the Card acceptor location" }, { "name": "startDateTime", "value": "2019-03-01 12:30:00", "type": "query", "description": "Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value)" }, { "name": "endDateTime", "value": "2019-03-01 13:30:00", "type": "query", "description": "End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded)" }, { "name": "sortField", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "This operation retrieves all interchange fees on terminal level\n\n- The result of this operation is a list of interchange fees that belongs to a contract level.\n- If there is a previous and/or next page the http response header will have a link (url) to this data \n" } ] } ], "bundled": true }