Payments Report

Use Payments Report to fetch all Merchant Payments

Running a Payments Report

Payments Report can be used to fetch past and pending payments from PayBright to the merchant. Payments report provide details like Customer Name, Agreement Number, Purchase Amount, Purchase Status within a time period specified in the Response Body of the Payments Report API.

📘

Tip: Payments Report can also be run from the PayBright portal optionally.

To run a payments 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": "payments"
}'

PayBright will send a response of Payments 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_name":"Jamie
Testhet","x_agreement_number":"49620","x_purchase_amount":"533.90","x_merchant_amount":"523.49","x_fee_to_merchant":"10.41","x_status":"Pending","x_payment_date":"07-15-2020","x_reference":"6800014048"},{"x_customer_name":"Jamie
Smith","x_agreement_number":"50015","x_purchase_amount":"281.90","x_merchant_amount":"248.35","x_fee_to_merchant":"33.55","x_status":"Processed","x_payment_date":"07-10-2020","x_reference":"6800132547"}]

The following data will be returned for the Payments Reports:

KEY

DESCRIPTION

CustomerEmail

Email address of the customer

CustomerName

Full name of the customer

AgreementNo

Unique number identifying the loan agreement between the customer and PayBright

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)

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

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

DealId

Unique number provided for FX when non-CAD currency is used for a transaction

CaptureAmount

Total amount of payment captured by the merchant; this value may be less than the PurchaseAmount when the payment for different items in the order are captured at different points in time

SettlementAmountInCAD

If a transaction is settled between PayBright and the merchant in USD then the equivalent CAD amount will be displayed

SettlementAmountInUSD

If a transaction is settled between PayBright and the merchant in USD then the USD amount will be displayed

ConversionRateOnSettlement

Exchange rate between USD and CAD dollars in the case of a purchase made in US dollars

RefundFee

Fee charged to merchant to process a customer refund

AdminFee

Fee charged to merchant to process a transaction

CreditCardFee

Fee charged to merchant for credit card purchases

Funder

Identified entity providing the loan to the customer (e.g. PayBright or GoEasy)

Please check the API Reference for more Payments Report API details.


What's Next