Contents x
    Split Remittance Payments
    • 15 Dec 2023
    • 6 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Split Remittance Payments

    • Updated on 15 Dec 2023
    • 6 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    In order to make a payment using split remittances you need to Create Payment with a purchases (line items) section.  This takes an array of purchase objects, and you should have one purchase object for each part of the payment.   Each purchase object should have a remittance section that contains the bank account id for the account where you want that part of the payment to go.

    Creating a payment with split remittances  and shared transaction fees

    By default, the Merchant and Platform both pay an equal transaction fee split as shown in the example below.

    ​

    In the below example the merchant line item is £90 and ISV/platform line item is £10

        "purchases": [
        {
            "category": "Cate",
            "description": "Services",
            "remittance": {
                "bankAccountId": "aba03d7e-86fa-475b-82f7-ab80848b3000",
                "merchantId": "11013253"
            },
            "totalAmount": 90
        },
        {
            "category": "Cate",
            "description": "Platform Fee",
            "remittance": {
                "bankAccountId": "80ed32e3-c51f-47e4-9861-a96b5df702f6",
                "merchantId": "11013253"
            },
            "totalAmount": 10
        }
    ],
    "transaction": {
        "amount": "100.00",
        "capture": true,
        "currency": "GBP",
        "description": "Trans description",
        "merchantReference": "Trans Merchant Ref",
        "submit": false,
        "uniqueMerchantReference": "Trans Unique Ref"
    }
} 

    Creating a payment with split remittances  and merchant pays all transaction fees

    Note: To use this model your account must be configured, please contact us to request this is enabled.

    The attribute ‘feeExempt’ is used to control where the Access Paysuite transaction fees are subtracted from. In the below example the merchant line item with £90 is liable for the total fee and ISV/platform line item with £10 is exempted from fee. 

    Note: The fees are calculated on the total transaction amount, and the fees are subtracted from the purchases (line items) which is/are liable for the fees i.e. feeExempt = false.   

        "purchases": [
        {
            "category": "Cate",
            "description": "Services",
            "feeExempt": "false",
            "remittance": {
                "bankAccountId": "aba03d7e-86fa-475b-82f7-ab80848b3000",
                "merchantId": "11013253"
            },
            "totalAmount": 90
        },
        {
            "category": "Cate",
            "description": "Platform Fee",
            "feeExempt": "true",
            "remittance": {
                "bankAccountId": "80ed32e3-c51f-47e4-9861-a96b5df702f6",
                "merchantId": "11013253"
            },
            "totalAmount": 10
        }
    ],
    "transaction": {
        "amount": "100.00",
        "capture": true,
        "currency": "GBP",
        "description": "Trans description",
        "merchantReference": "Trans Merchant Ref",
        "submit": false,
        "uniqueMerchantReference": "Trans Unique Ref"
    }
} 

    Creating a payment with split remittance and ISV pays all transaction fees

    Note: To use this model your account must be configured, please contact us to request this is enabled.

    In the below example the merchant line item with £90 is exempted from the fee and ISV/platform line item with £10 is liable for the total fee.

    Note: The fees are calculated on the total transaction amount, and the fees are subtracted from the purchases (line items) which is/are liable for the fees i.e. feeExempt = false.   

        "purchases": [
        {
            "category": "Cate",
            "description": "Services",
            "feeExempt": "true",
            "remittance": {
                "bankAccountId": "aba03d7e-86fa-475b-82f7-ab80848b3000",
                "merchantId": "11013253"
            },
            "totalAmount": 90
        },
        {
            "category": "Cate",
            "description": "Platform Fee",
            "feeExempt": "false",
            "remittance": {
                "bankAccountId": "80ed32e3-c51f-47e4-9861-a96b5df702f6",
                "merchantId": "11013253"
            },
            "totalAmount": 10
        }
    ],
    "transaction": {
        "amount": "100.00",
        "capture": true,
        "currency": "GBP",
        "description": "Trans description",
        "merchantReference": "Trans Merchant Ref",
        "submit": false,
        "uniqueMerchantReference": "Trans Unique Ref"
    }
} 

    Example of the ISV paying the transaction fees

    Using the above request example, we’ll use the percentage and fixed fee calculations below to show the calculations in the table below.

    • Fixed = £0.20  

    • Percentage = 1.4 % 

    ISV Liability Model 

      

    Item Amount  

    Percentage Fee  

    Fixed Fee  

    Total Fee  

    Fee Exempt  

    Apportioned fee  

    Services 

    90.00  

    1.26  

    0.10  

    1.36  

    TRUE  

    0.00  

    Platform fee 

    10.00  

    0.14  

    0.10  

    0.24  

    FALSE  

    1.60  

      

      

     

     

     

     

     

    Total  

    100.00  

    1.40  

    0.20  

    1.60  

     

    1.60  

      

    1. With ISV liability, for every line item the “feeExempt” field indicates whether the line item is liable for fees or not. 

    1. If the “feeExempt” value was not provided, then the line item is liable for fees. 

    1. If all the sent line items indicate that they are not liable for fees, then it is treated as erroneous. 

    1. The line items that are liable for fees need to cover the transaction fee.   

    1. In the above example the merchant bank account is remitted with £90 with no fees charged.   

    1. In the above example, the ISV / Supplier bank account is remitted with £8.40 after the subtraction of the total £1.60 (£1.36 + £0.24) fees, from their £10 transaction split.     

    Example of the Merchant paying the transaction fees

    Using the above request example, we’ll use the percentage and fixed fee calculations below to show the calculations in the Merchant Liability Model table. 

    • Fixed = £0.20  

    • Percentage = 1.4 % 

    Merchant Liability Model 

      

    Item Amount  

    Percentage Fee  

    Fixed Fee  

    Total Fee  

    Fee Exempt  

    Apportioned fee  

    Services 

    90.00  

    1.26  

    0.10  

    1.36  

    FALSE  

    1.60  

    Platform fee 

    10.00  

    0.14  

    0.10  

    0.24  

    TRUE  

    0.00  

      

      

     

     

     

     

     

    Total  

    100.00  

    1.40  

    0.20  

    1.60  

     

    1.60  

      

    Fee Exempt   

    1. With merchant liability, for every line item the “feeExempt” field indicates whether the line item is liable for fees or not. 

    1. If the “feeExempt” value was not provided, then the line item is liable for fees. 

    1. If all the sent line items indicate that they are not liable for fees, then it is treated as erroneous. 

    1. The line items that are liable for fees need to cover the transaction fee.   

    1. In the above example the merchant bank account is remitted with £88.40 (£90 - £1.60) after the subtraction of the total £1.60 (£1.36 + £0.24) fees, from their £90 transaction split.     

    1. In the above example, the ISV / Supplier bank account is remitted with £10 with no fees charged.  

    Was this article helpful?
    What's Next