Amendment

# Amendment Requests Structure Amendment request follows the same structure for onboarding request, but only the data within the scope of amendment is required. Scope of amendment is identified as "amendmentType". > Note that one or more amendment type can be applied on the merchant in the same request. ```json { "requestId":"{{requestId}}", "payload":{ "applications":[...] } } ``` The following list shows the types of supported amendments: ["MERCHANT_NAME","LINKED_CHAIN","MCC","SCHEMES_OVERRIDING","ADDRESS","ACCEPTED_CARDS" ,"FEES","SERVICES","HOLD","RELEASE","CLOSURE","ADDING_TERMINALS"] ### MERCHANT_NAME - merchantId: Mandatory - merchantName: Mandatory - merchantType: Mandatory ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["MERCHANT_NAME"], "merchantId":"MER_ID", "merchantType":"POS", "merchantName":"MER_NAME" } ] } ] } } ``` ### LINKED_CHAIN - merchantId: Mandatory - chainId: Mandatory ```json { "payload":{ "applications":[ { "chain" : { "chainId": "chain_id" }, "merchants":[ { "amendmentList":["LINKED_CHAIN"], "merchantId":"merchant_id" } ] } ] } } ``` ### MCC - merchantId: Mandatory - mcc: Mandatory ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["MCC"], "merchantId":"MER_ID", "mcc":"new_MCC" } ] } ] } } ``` ### ACCEPTED_CARDS ##### Complex pricing structure - merchantId: Mandatory - merchantCurrency: Mandatory - acceptedCardSchemes: Mandatory - cardScheme: Mandatory - acceptedCardModes: Mandatory - terminals: Optional ```json { "payload" : { "applications": [ { "merchants": [ { "amendmentList": ["ACCEPTED_CARDS"], "merchantId": "merchant_id", "merchantCurrency": "merchant_currency", "configurations" : { "acceptedCardSchemes": [ { "cardScheme": "VISA", "acceptedCardModes": [ { "modeName": "ELECTRONIC", "rate" : 1.75 }, { "modeName": "MANUAL", "rate" : 1.75 }, { "modeName": "PREMIUM", "rate" : 1.75 }, { "modeName": "INTERNATIONAL", "rate" : 1.75 } ] } ] }, "terminals":[ { "terminalId":"1814834893248" } ] } ] } ] } } ``` ##### Simple pricing structure - merchantId: Mandatory - merchantCurrency: Mandatory - legalName: Mandatory - acceptedCardSchemes: Mandatory - cardScheme: Mandatory - tariffRate: Mandatory - terminals: Optional ```json { "payload" : { "applications": [ { "merchants": [ { "amendmentList": ["ACCEPTED_CARDS"], "merchantId": "merchant_id", "legalName" : "legalName", "merchantCurrency": "merchant_currency", "configurations" : { "acceptedCardSchemes": [ { "cardScheme": "VISA", "tariffRate" : 1.025 } ] }, "terminals":[ { "terminalId":"1814834893248" } ] } ] } ] } } ``` ### SCHEMES_OVERRIDING - merchantId: Mandatory - merchantName: Mandatory - acceptedCardSchemes: Mandatory - cardScheme; Mandatory - schemeOverrideValue: Mandatory - mcc: Mandatory ```json { "payload" : { "applications": [ { "merchants": [ { "amendmentList": ["SCHEMES_OVERRIDING"], "merchantId": "merchant_id", "merchantName": "merchant_name", "configurations" : { "acceptedCardSchemes": [ { "cardScheme": "VISA", "schemeOverrideValue" : { "dbaName" : "Merchant_Scheme_Name| Merchant_Scheme_ID", "mcc" : 1234 } } ] } } ] } ] } } ``` ### ADDRESS - merchantId: Mandatory - merchantType: Mandatory - merchantName: Mandatory - addresses: Mandatory - addressType; Mandatory - name: Mandatory - countryCode: Mandatory - state: Mandatory - city: Mandatory - phone: Mandatory - postalCode : Mandatory - pobox : Mandatory - fax: Optional - email: Mandatory - addressLines : Optional ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["ADDRESS"], "merchantId":"MER_ID", "merchantType": "POS", "merchantName":"merchant_Name", "addresses": [ { "addressType": "STMT_ADDR | PAYM_ADDR", "name" : "AABC", "countryCode": "ARE", "state": "DXB", "city": "Dubai", "phone" : "12345678900", "postalCode": "0000000784", "pobox": "644973", "fax": "", "email": "farah@4maat.com", "addressLines" : ["addressLine1", "addressLine2"] } ], "terminals":[ { "terminalId":"1814834893248" } ] } ] } ] } } ``` ### FEES - merchantId: Mandatory - merchantCurrency: Mandatory - fees: Mandatory - feeTypeName: Mandatory - reOccurrenceFrequency: Mandatory - feeValue: Mandatory ```json { "payload" : { "applications": [ { "merchants": [ { "amendmentList": ["FEES"], "merchantId": "merchant_id", "merchantCurrency": "merchant_currency", "configurations" : { "fees": [ { "feeTypeName": "MIS | ACQ_MMBR_FEE | MFEE_STRT | MFEE_FRD_HND | TRANS_FEE | REFUND_FEE", "reOccurrenceFrequency": "DAILY | WEEKLY | MONTHLY", "feeValue": 0 } ] } } ] } ] } } ``` ### SERVICES - merchantId: Mandatory - merchantCurrency: Mandatory - services; Mandatory - serviceType: Mandatory - dccProvider: Mandatory - dccSettlementFrequency: Mandatory - dccAcquirerRate: Mandatory - dccMerchantMarkupRate: Mandatory - dccMarkupRate: Mandatory ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["SERVICES"], "merchantId":"MER_ID", "merchantCurrency": "merchant_currency", "services": [ { "serviceType": "DCC", "dccProvider": "FX | PP", "dccSettlementFrequency": "MONTHLY | WEEKLY | DAILY", "dccAcquirerRate": 99999, "dccMerchantMarkupRate": 0.25, "dccMarkupRate": 5.99 } ] } ] } ] } } ``` ### HOLD - merchantId: Mandatory ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["HOLD"], "merchantId":"MER_ID" } ] } ] } } ``` ### RELEASE - merchantId: Mandatory ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["RELEASE"], "merchantId":"MER_ID" } ] } ] } } ``` ### CLOSURE - merchantId: Mandatory - merchantName: Mandatory - merchantType: Mandatory - terminals: Optional ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["CLOSURE"], "merchantId":"MER_ID", "merchantName": "MER_NAME", "merchantType": "POS", "terminals":[ { "terminalId":"terminal_id" } ] } ] } ] } } ``` ### ADDING_TERMINALS - merchantId: Mandatory - terminals: Mandatory - terminalId: Mandatory - terminalName: Optional - terminalType: Mandatory - maker: Mandatory - terminalModel: Mandatory - communicationMethod: Mandatory - dccEnabled: Optional - fees: Mandatory - feeType: Mandatory - feeValue: Mandatory ```json { "payload":{ "applications":[ { "merchants":[ { "amendmentList":["ADDING_TERMINALS"], "merchantId":"MER_ID", "terminals": [ { "terminalId": "terminal_ID", "terminalName": "terminal_NAME", "terminalType" : "terminal_type", "maker" : "Maker", "terminalModel": "Model", "communicationMethod": "SG | GPRS_SIM", "dccEnabled": false, "fees": [ { "feeType" : "SIM_FEE | GPRS_FEE | RENTAL_FEE | INSURANCE_FEE", "feeValue" : 1.5 } ] } ] } ] } ] } } ``` ### IBAN - merchantId: Mandatory - bankname: Mandatory - creditAccountNumOrIban: Mandatory - debitAccountNumOrIban: Mandatory - paymentMode: Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "amendmentList" : [ "IBAN" ], "merchantId" : "200444444004", "bankname": "ENBD", "creditAccountNumOrIban" : "##############", "debitAccountNumOrIban" : "##############", "paymentMode" : "EFT" } ] } ] } } ``` ### TERMINAL_CLOSURE - merchantId: Mandatory - terminals: Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444008", "amendmentList" : [ "TERMINAL_CLOSURE"], "terminals" : [ { "terminalId" : "33333008" } ] } ] } ] } } ``` ### TERMINAL_REACTIVATING - merchantId: Mandatory - terminals: Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444008", "amendmentList" : [ "TERMINAL_REACTIVATING"], "terminals" : [ { "terminalId" : "33333008" } ] } ] } ] } } ``` ### MERCHANT_REACTIVATING - merchantId: Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444005", "amendmentList" : [ "MERCHANT_REACTIVATING"] } ] } ] } } ``` ### SETTLEMENT - merchantId: Mandatory, - merchantName: Mandatory, - settlement : Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444002", "merchantName" : "test name", "amendmentList" : [ "SETTLEMENT"], "configurations" : { "settlement" : { "statementFrequency" : "SEMI_WEEKLY", "statementDay" : 1, "statementSecondDay" : 6 } } } ] } ] } } ``` ### FLEXI_CUT_OFF - merchantId: Mandatory, - merchantName: Mandatory, - flexiCutoff : Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444002", "merchantName" : "test name", "amendmentList" : [ "FLEXI_CUT_OFF"], "configurations" : { "flexiCutoff" : { "enableFlexiCutoff" : true, "flexiCutoffTime" : "1130", "flexiCutoffDay" : "3" } } } ] } ] } } ``` ### LIABILITY - merchantId: Mandatory, - merchantName: Mandatory, - enableLiability : Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444002", "merchantName" : "test name", "amendmentList" : [ "LIABILITY"], "configurations" : { "enableLiability" : true } } ] } ] } } ``` ### DISABLE_SCHEME - merchantId: Mandatory, - cardScheme : Mandatory ```json { "payload":{ "applications" : [ { "merchants" : [ { "merchantId" : "200444444002", "amendmentList" : [ "DISABLE_SCHEME"], "configurations" : { "acceptedCardSchemes": [ { "cardScheme" : "CUP" } ] } } ] } ] } } ```