Ledgers

Ledgers are records of money movement. The Ledgers endpoint can be used to retrieve account balances by Currency, and also to retrieve information about Ledger entries by Entry Code.

Resource

Ledger Entry Codes

CodeNametypeDescription
1000Invoicecreditonce an invoice reaches the "complete" status, the corresponding amount is credited to the merchant account in the selected settlement currency
1004Fee Refundcredit
1006Exchangedebit & creditThis entry indicates that BitPay transfered your balance from one ledger currency (recorded as a debit) to another ledger currency (recorded as a credit). This typically happens if a merchant needs to change settlement currency and exchange the pending balance from one currency to another
1007Exchange Feedebit
1008Plan ChargedebitFor merchants on a legacy SaaS plan, this entry is used to debit the merchant account with the monthly fee
1009Plan Prorated CreditcreditFor merchants on a legacy SaaS plan, this entry is used to adjust the amount charged.
1010Plan Underutilization CreditcreditFor merchants on a legacy SaaS plan, this entry is used to adjust the amount debited (account not used)
1011Payoff Negative Balancedebit & creditThis entry does not have any additional fields. It corresponds to an automatic transfer made by BitPay from one ledger currency to another. Typically to cover refund or payouts. For instance, if you execute a refund request where EUR is the base currency but your active ledger (linked to the settlement currency) is in USD, you will see such "Payoff Negative Balance" entry appear on both ledger (a debit on the USD ledger and a credit)
1012Donationcredit
1016Customdebit & creditCode used by BitPay for general purpose custom entries. It may be use to correct an invalid entry on your ledger
1017Account SettlementdebitThis entry is written to debit the merchant balance for a given account settlement
1020Invoice RefunddebitThis entry is written once a refund request made on an invoice is executed. The merchant balance is debited with the refund amount requested.
1022Corrective for Failed Account SettlementcreditIndicates a previous settlement failed (for instance invalid settlement info). In such scenario BitPay credits the amount back to the merchant account using this ledger code.
1023Invoice FeedebitOnce an invoice reaches the "complete" status, the corresponding fee is credited using this ledger code
1024Bitcoin Depositcredit
1025Fiat Deposit for PayoutcreditWhen a merchant makes a bank transfer to BitPay in order to fund the consumer payout/withdrawal activity, the deposited amount is credited to the merchant account using this ledger code
1026Donation Feedebit
1027Custom Feedebit
1030Affiliate CommissioncreditFor merchants who onboarded business under their referral link, the commissions are credited to the account using this ledger code
1031Manual Affiliate Commissioncredit
1032Merchant Card Depositdebit
1033Custom Plan Chargedebit
1034Funding PayoutdebitThis entry is written once BitPay sets a payout to the status funded. This means that part of the merchant balance has been allocated to execute a payout.
1035Manually Funding Payoutdebit
1036Custom Fee Reimbursementcredit
1037Custom Plan Charge Reimbursementcredit
1038Testnet Bitcoin SettlementdebitTestnet BTC/BCH settlements (test.bitpay.com) are recorded using this ledger code
1039Refund FeedebitThis entry will be immediately written next to the "Invoice Refund". The refund fee is the actual cost of broadcasting the refund transaction on the selected blockchain
1040Payout FeedebitThis entry is written once BitPay sets a payout to the status funded. This is the fee charged for each payout executed
1041Wire Feedebit
1048Fiat Deposit for RefundcreditWhen a merchant makes a bank transfer to BitPay in order to cover pending refund requests.
1050Immediate Invoice RefunddebitThis entry is written once an immediate refund request made on an invoice is created. The merchant balance is debited with the refund amount requested.