DocsRecipesAPI Rest
DocsAPI RestRecipesTutorialsHelpLog In
Docs
DocsAPI RestRecipesTutorialsHelp

Method: GET /api/v1/application/transaction-charges/all

Caribbean
Colombia
Mexico

This endpoint is used to retrieve information about a list of all Transaction Charges parameters available for the institution.

  1. Parameters. No parameters are needed.
  2. Responses
    a. “200” – OK. Indicates success in the inquiry, and provides information about the available transaction charges, which can be set to the merchant.

The list provided should be filtered according to the parameters such as: Merchant Tarif, Charge Type, Service Id, Transaction Type, Capture Method, Area of Event, Fee Type, Service Type. This filter will point to a specific recordId field value, which should be informed in the boarding / maintenance payload.
Example:

{  
        "chargeModel": "DEFAULT",  
        "recordIdNumber": "9200000001",  
        "merchantTariff": {  
            "tariffIndex": "000770",  
            "tariffDescription": "Refund Pricing"  
        },  
        "chargeType": {  
            "chargeTypeIndex": "002",  
            "chargeTypeIndexDescription": "Commission"  
        },  
        "serviceId": {  
            "serviceIndex": "101",  
            "serviceDescription": "Acquire - ECMC."  
        },  
        "transactionType": {  
            "transactionType": "005",  
            "transactionTypeDescription": "Purchase"  
        },  
        "captureMethod": {  
            "captureMethodIndex": "999",  
            "captureMethodDescription": "ALL"  
        },  
        "areaOfEvent": {  
            "areaOfEventIndex": "001",  
            "areaOfEventDescription": "Foreign"  
        },  
        "feeCategory": {  
            "feeCategoryIndex": "109",  
            "feeCategoryIndexDescription": "Pricing Plus Fees EX"  
        },  
        "feeType": {  
            "feeTypeIndex": "005",  
            "feeTypeDescription": "Purchase"  
        },  
        "transactionCurrency": "999",  
        "serviceType": {  
            "cardServiceTypeIndex": "001",  
            "cardServiceTypeDescription": "Credit Card"  
        }  
    },

b. “204” - No register found.
c. “400” - Bad request
d. “401” - Unauthorized request
e. “403” - Forbidden request
f. “500” - Internal Error
g. “502” - API Error

More information is available in the API.