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
Code | Name | type | Description |
---|---|---|---|
1000 | Invoice | credit | once an invoice reaches the "complete" status, the corresponding amount is credited to the merchant account in the selected settlement currency |
1004 | Fee Refund | credit | |
1006 | Exchange | debit & credit | This 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 |
1007 | Exchange Fee | debit | |
1008 | Plan Charge | debit | For merchants on a legacy SaaS plan, this entry is used to debit the merchant account with the monthly fee |
1009 | Plan Prorated Credit | credit | For merchants on a legacy SaaS plan, this entry is used to adjust the amount charged. |
1010 | Plan Underutilization Credit | credit | For merchants on a legacy SaaS plan, this entry is used to adjust the amount debited (account not used) |
1011 | Payoff Negative Balance | debit & credit | This 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) |
1012 | Donation | credit | |
1016 | Custom | debit & credit | Code used by BitPay for general purpose custom entries. It may be use to correct an invalid entry on your ledger |
1017 | Account Settlement | debit | This entry is written to debit the merchant balance for a given account settlement |
1020 | Invoice Refund | debit | This entry is written once a refund request made on an invoice is executed. The merchant balance is debited with the refund amount requested. |
1022 | Corrective for Failed Account Settlement | credit | Indicates 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. |
1023 | Invoice Fee | debit | Once an invoice reaches the "complete" status, the corresponding fee is credited using this ledger code |
1024 | Bitcoin Deposit | credit | |
1025 | Fiat Deposit for Payout | credit | When 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 |
1026 | Donation Fee | debit | |
1027 | Custom Fee | debit | |
1030 | Affiliate Commission | credit | For merchants who onboarded business under their referral link, the commissions are credited to the account using this ledger code |
1031 | Manual Affiliate Commission | credit | |
1032 | Merchant Card Deposit | debit | |
1033 | Custom Plan Charge | debit | |
1034 | Funding Payout | debit | This 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. |
1035 | Manually Funding Payout | debit | |
1036 | Custom Fee Reimbursement | credit | |
1037 | Custom Plan Charge Reimbursement | credit | |
1038 | Testnet Bitcoin Settlement | debit | Testnet BTC/BCH settlements (test.bitpay.com) are recorded using this ledger code |
1039 | Refund Fee | debit | This 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 |
1040 | Payout Fee | debit | This entry is written once BitPay sets a payout to the status funded. This is the fee charged for each payout executed |
1041 | Wire Fee | debit | |
1048 | Fiat Deposit for Refund | credit | When a merchant makes a bank transfer to BitPay in order to cover pending refund requests. |
1050 | Immediate Invoice Refund | debit | This entry is written once an immediate refund request made on an invoice is created. The merchant balance is debited with the refund amount requested. |