Skip to main content

Custom Settlement Report

Ease up your operational effort by setting customized parameters that suited your operation use case. Custom settlement report allows you to send your own parameters that will be shown in the settlement report.

Case Study#

"Toko Toserba" has many branches that span across multiple provinces in Indonesia. They recently launched an online store and wanted to ensure that they settle the funds from the online store to the right branches.

Therefore, they use Custom settlement report to know which transactions to settle to a branch. Their operation team can now see each transactions that will be settled for each branches from the settlement report.


Implementation#

To create custom settlement report, please add this additional_info.report object into your payment request:

{...    "additional_info": {        "report": [           {               "key": "Branch",               "value": "Toserba Kebon Jeruk"           },           {               "key": "city",               "value": "Jakarta Barat"           }           {               "key": "Province",               "value": "DKI Jakarta"           }       ]    }...}
ParameterTypeMandatoryDescription
additional_info.report[].keystringOptionalThe filter key that will be used to map the filter. This will be the column name in the settlement report file
Possible value: alphabetic, numeric, special characters
Maximum length: 64
additional_info.report[].valuestringOptionalThe value of the filter that will attached to the transaction. This will be the value of the particular column in the settlement report file
Possible value: alphabetic, numeric, special characters
Maximum length: 128

Sample usage#

Let's assume you are using the Jokul Checkout integration. You can simply add these parameters into your API Initiate Payment:

{    "order": {        "invoice_number": "INV-20210231-0001",        "amount": 90000,        "line_items": [            {                "name": "T-Shirt Red",                "price": 30000,                "quantity": 2            },            {                "name": "Polo Navy",                "price": 30000,                "quantity": 1            }        ],        "currency": "IDR",        "callback_url": "https://merchant.com/return-url"         },    "payment": {        "payment_due_date": 60,        "payment_method_types": [            "VIRTUAL_ACCOUNT_BCA",            "VIRTUAL_ACCOUNT_BANK_MANDIRI",            "VIRTUAL_ACCOUNT_BANK_SYARIAH_MANDIRI",            "VIRTUAL_ACCOUNT_DOKU",            "ONLINE_TO_OFFLINE_ALFA",            "CREDIT_CARD",            "DIRECT_DEBIT_BRI"        ]    },    "customer": {        "id": "CUST-0001",        "name": "Anton Budiman",        "email": "anton@example.com",        "phone": "6285694566147",        "address": "Menara Mulia Lantai 8",        "country": "ID"    },    "additional_info": {        "report": [           {               "key": "Branch",               "value": "Toserba Kebon Jeruk"           },           {               "key": "city",               "value": "Jakarta Barat"           }           {               "key": "Province",               "value": "DKI Jakarta"           }       ]    }}

Settlement report example#

Here is the example of settlement report that already added with custom parameter you will received:

Settlement report example

Download the sample here


FAQs#

Can I name the key and value by myself?#

Yes, you are freely name the key and value based on your operation case.

Can I use this feature with hold & release settlement or split settlement?#

Of course, you can!