Master Report

Running a Master Report

Master Report can be used to fetch all applications, transactions, and payments for a specified date range. Master report provide details like Customer Name, Agreement Number, Purchase Amount, Payment Status, Payment Date, Transaction date within a time period specified in the Response Body of the Master Report API.

📘
Tip: Master Report can also be downloaded from the PayBright portal as xlsx or csv file.

To run a master report, you will need to create the signature using the API Key and API Token shared with you by the PayBright team.

📘
curl --location --request POST 'https://sandbox.paybright.com/checkout/reports.aspx'
--header 'Content-Type: application/json'
--data-raw '{
"x_account_id": "Z9s7Yt0Txsqbbx",
"x_test": "true",
"x_transaction_type": "reports",
"x_url_callback": "https://mystore.io/orders/1/done",
"x_signature": "3a59e201a9b8692702b8c41dcba476d4a46e5f5c",
"x_datefrom": "07/01/2020",
"x_dateto":"07/16/2020",
"x_reportname": "master"
}'

PayBright will send a response of Master Report API call as a POST request to x_url_callback and also to the initial request. You should receive a response that looks like this:

[{"x_customer_Key":"33272","x_application_key":"33831","x_agreement_number":"2033272-106-48481","x_customer_name":"Jamie
Testhet","x_customer_address":"22, Viewcrest, Etobicoke, ON,
H2L3A9","x_available_credit_limit":"2700.18","x_credit_limit_expiry":"06-12-2021","x_transaction_date":"06-12-2020","x_purchase_amount":"3390.00","x_merchant_amount":"3054.38","x_adminFee":"269.51","x_creditCardFee":"66.11","x_refundFee":"0.00","x_fee_to_merchant":"269.51","x_fee_to_merchant_percentage":"7.95","x_customer_interest_rate":"0.00","x_original_term":"6","x_term_remaining":"0","x_outstanding_balance":"3390.00","x_payment_status":"Pending","x_payment_date":"07-01-2020","x_payment_description":"","x_total_dollars_financed":"12299.82","x_total_dollars_paid_by_customer":"0.00","x_reference":"6800014049","x_invoice":"","x_description":""},
{"x_customer_Key":"33923","x_application_key":"34498","x_agreement_number":"2033923-124-49620","x_customer_name":"Jamie
Testhet","x_customer_address":"22, Viewcrest Cir, , Etobicoke, ON,
M9W7G5","x_available_credit_limit":"14466.10","x_credit_limit_expiry":"07-01-2021","x_transaction_date":"07-01-2020","x_purchase_amount":"533.90","x_merchant_amount":"523.49","x_adminFee":"0.00","x_creditCardFee":"10.41","x_refundFee":"0.00","x_fee_to_merchant":"0.00","x_fee_to_merchant_percentage":"0.00","x_customer_interest_rate":"9.95","x_original_term":"24","x_term_remaining":"0","x_outstanding_balance":"533.90","x_payment_status":"Pending","x_payment_date":"07-15-2020","x_payment_description":"","x_total_dollars_financed":"533.90","x_total_dollars_paid_by_customer":"0.00","x_reference":"6800014048","x_invoice":"","x_description":""}]

The following data will be returned for the Master Reports:

KEY	DESCRIPTION
CustomerKey	Unique number identifying the customer within a given merchant
ApplicationKey	Unique number identifying the customer's loan application
AgreementNo	Unique number identifying the loan agreement between the customer and PayBright
CustomerName	Full name of the customer
CustomerAddress	Full address of the customer
CustomerEmail	Email address of the customer
AvailableCreditLimit	Total amount approved to loan a given customer
CreditLimitExpiry	Expiry date for the approved loan amount
TransactionDate	Date of customer transaction
PurchaseAmount	Amount of the purchased products/services by the customer
MerchantAmount	Amount that will be paid to the merchant, this is the PurcahseAmount minus any fees (admin, refund, or credit card)
AdminFee	Fee charged to merchant to process a transaction
RefundFee	Fee charged to merchant to process a customer refund
FeeToMerchant	Sum of any Admin and Refund fees charges to the merchant (excludes credit card fees)
FeeToMerchantPer	Fee charged to merchant to process a transaction expressed as a percentage of the customer's purchase (PurchaseAmount)
CreditCardFeeToMerchant	Fee charged to merchant for credit card purchases
CreditCardFeeToMerchantPer	Fee charged to merchant for credit card purchases expressed as a percentage of the customer's purchase (PurchaseAmount)
InterestRate	Interest rate to be charged to the customer
Months	Original duration of the customer loan
MonthsRemaining	Number of months remaining in the customer's loan agreement
OutstandingBalance	Amount of the loan that the customer still needs to pay
Status	State of a given payment, can be either Complete or Pending
PaymentDate	Expected or actual date of the settlement of payment between PayBright and the merchant
Descrip	System generated messaged describing payment transaction
TotalDollarsFinanced	Total amount of loan provided to customer from PayBright (Note: this value will be the same to PurchaseAmount for purchase entries but will reflect the original purchase amount for refund and fee entries)
TotalDollarsPaidbyCustomer	Amount of PayBright loan already paid by the customer
Reference	Unique number identifying an order assigned by the merchant
Invoice	Unique number identifying the invoice of purchased products/service the customer receives from the merchant system
Description	Free text field where merchant users can include a message
Funder	Identified entity providing the loan to the customer (e.g. PayBright or GoEasy)

Please check the API Reference for more Master API details.