Developer

Partner Docs

Merchant Docs

Data Format

Reports can be created as JSON or CSV format. Each report returns a default set of fields/columns.

Pay-in Payments Report

The Pay-in Payments Report provides details on all incoming payments into the merchants’ accounts from their customers.

The following example shows CSV file format for this report:

text
payment_id,mandate_id,payment_type,payment_scheme,created_timestamp,updated_timestamp,partner_id,business_name,business_id,business_application_name,business_application_id,merchant_bank_account_id,currency,amount,reference,external_reference,end_to_end_id,description,state,mode,provider_name,failure_reason,provider_id,business_tag
d9b332b0-5392-40ab-9f81-f919db1c814b,82698658-55e2-4783-bfa5-953dd32c86eb,PAY_IN,PAY_TO,2024-10-09T08:58:58Z,2024-10-09T08:58:58Z,6f2cee83-deae-4955-974b-c29c1f68e16d,Business Name,0b96ea7c-6202-41ac-b4b4-9b7b7af46bed,Test Application,f57d9099-3dc8-4814-9671-cb30317321f6,e88ac547-3e99-41e4-9340-3d323a58c5ab,AUD,30.00,oioiWI09,external-reference,B-sz3wzQGSgRfWh,NULL,failed,test,Mock Bank,Payment is Before the Mandate Validity Start Date,6cad4c25-b388-4d25-92cb-141979ae3c64,NULL

Pay-out Payments Report

The Pay-out Payments Report contains details on pay-outs from merchants’ accounts to their customers.

The following example shows CSV file format for this report:

text
payment_id,mandate_id,payment_type,payment_scheme,created_timestamp,updated_timestamp,partner_id,business_name,business_id,business_application_name,business_application_id,merchant_bank_account_id,currency,amount,reference,external_reference,end_to_end_id,description,state,mode,provider_name,failure_reason,provider_id,business_tag
ecd5708b-8b1c-4a83-9aba-84be3ef49142,NULL,PAY_OUT,NULL,2024-10-25T08:19:18Z,2024-11-08T00:00:03Z,96d2f909-bfbe-4e57-8dcf-2939933d983e,Business Name,a240706c-4790-46eb-b7ef-b5009d382321,Test Application,f1e4c61f-7301-4e9c-8835-a43392664a30,d41d8cd98f00b204e9800998ecf8427e,USD,1.00,reference1234,ext-ref-1234,NULL,payout description,cancelled,test,NULL,NULL,NULL,NULL

Refund Report

The Refunds Report contains details to help track refunds issued against payments.

The following example shows CSV file format for this report:

text
refund_id,original_payment_id,payment_type,payment_scheme,created_timestamp,updated_timestamp,partner_id,business_name,business_id,business_application_name,business_application_id,merchant_bank_account_id,currency,amount,refund_reference,state,mode,provider_name,failure_reason,provider_id,business_tag
bbc2c701-df62-4bc0-addf-c7676770bd81,50ea9283-ada5-4715-a0fc-4227e5010865,REFUND,FPS,2024-11-06T06:46:20Z,2024-11-06T06:46:29Z,ec25b518-32ca-4a1e-953c-ffc09e874cb6,Business Name,0dbd08ec-1149-497e-9b16-978bb85c2924,Test Application,d2f0812e-4463-49f3-a6c1-7546eddb2562,d41d8cd98f00b204e9800998ecf8427e,GBP,0.10,reference123,sent,test,Mock Bank,NULL,4ff5b295-391d-4e41-a4b8-d85db4d91c28,NULL

Mandates Report

The Mandates Report provides information on mandates created between the merchants and their customers, including validity start/end date, authorized amount, and status.

The following example shows CSV file format for this report:

text
mandate_id,validity_start_date,validity_end_date,currency,variable_frequency,variable_max_amount,variable_max_period,fixed_amount,fixed_frequency,max_fixed_count_per_period,split_terms_amount,split_terms_frequency,split_terms_count_per_period,split_terms_first_payment_amount,split_terms_last_payment_amount,split_terms_first_payment_date,split_terms_last_payment_date,usage_terms_max_payment_amount,usage_terms_frequency,usage_terms_count_per_period,state,mode,created_timestamp,updated_timestamp,partner_id,business_name,business_id,reference,description,merchant_bank_account_id,failure_reason,provider_id,business_tag
26121326-14c6-4eb0-8882-135b0dc74b5a,2024-12-02,2025-12-09,AUD,NULL,,NULL,20000000.00,DAILY,NULL,,NULL,NULL,,,NULL,NULL,,NULL,NULL,declined,test,2024-11-04T10:06:54Z,2024-11-04T10:07:30Z,6f2cee83-deae-4955-974b-c29c1f68e16d,Business Name,0b96ea7c-6202-41ac-b4b4-9b7b7af46bed,NULL,mandate description,e88ac547-3e99-41e4-9340-3d323a58c5ab,NULL,ea291566-989e-468e-bcb3-e83c51acb980,NULL
support@banked.com
Dark Theme
© 2024