Payment log reports provide each individual transaction processed by EasyPost, such as recharges from your payment method or fees spent on postage. Payment Log reports can be created via API or created from the EasyPost dashboard in just a few quick clicks.
What's in the Payment Log report?
You can access the Payment Log report in a .csv
format through our Reports Object, which you can learn more about here. The .csv
file contains the fields listed below with their definitions.
Field | Definition or Sample Data |
---|---|
created_at | 2021-07-13T14:16:44Z |
id | paylog_…. |
status |
pending - the transaction is pending complete - the transaction is completed failure - the transaction is rejected, please double-check your balance or banking information to ensure everything is okay before contacting support creditable - the transaction is credited to your account, despite the bank not completing the transaction |
source_type |
easypost_bank, user, payment_refund, refund, insurance, manual_debit, bank_account, credit_card, subscription, ach_credit_source, post_pay_shipment |
target_type |
easypost_bank, user, manual_credit, bank_account, ach_credit_source, credit_card |
charge_type | service_fee, recharge, manual_credit, manual_debit, payment_failure_deduction, payment_refund, partial_refund, refund, insurance, subscription |
amount | $xx.xx, the amount of the payment log |
balance | $xx.xx, your EasyPost balance at the time the payment log occurred |
description | a human-readable description of the credit/debit, if provided |
Additional columns such as shipment_id
You can specify "additional_columns" to output extra columns in addition to the default columns
curl -X POST 'https://api.easypost.com/v2/reports/payment_log' \
-u <YOUR PRODUCTION API KEY>: \
-d '{"start_date":"2021-06-01","end_date":"2021-06-30",additional_columns":["shipment_id","tracker_id","insurance_id","other","amount_label_fee","amount_postage_fee","amount_tracker_fee","amount_insurance_fee","amount_delta_fee","amount_convenience_fee"]}' \
-H "Content-Type:Application/json"
or, you can specify "columns" to output the exact columns you need
curl -X POST 'https://api.easypost.com/v2/reports/payment_log' \
-u <YOUR PRODUCTION API KEY>: \
-d '{"start_date":"2021-06-01","end_date":"2021-06-30",columns":["created_at","id","status","amount","balance","shipment_id","tracker_id","insurance_id","other","amount_label_fee","amount_postage_fee","amount_tracker_fee","amount_insurance_fee","amount_delta_fee","amount_convenience_fee"]}' \
-H "Content-Type:Application/json"
Additional columns:
Field | Definition or Sample Data |
---|---|
shipment_id | shp_..., the shipment_id associated with the payment log, if any |
tracker_id | trk_..., the tracker_id associated with the payment log, if any |
insurance_id | ins_..., the insurance_id associated with the payment log, if any |
other | "manual" if the payment log was a manual credit or charge, or "delta" if the payment log was an adjustment such as APV, if any |
amount_label_fee | portion of the payment log amount that was charged for a label fee, if any |
amount_postage_fee | portion of the payment log amount that was charged for a postage label, if any |
amount_tracker_fee | portion of the payment log amount that was charged for a tracker fee, if any |
amount_insurance_fee | portion of the payment log amount that was charged for insurance, if any |
amount_delta_fee | portion of the payment log amount that was charged for a label adjustment, if any |
amount_convenience_fee | portion of the payment log amount that was charged for a convenience fee, if any |