get https://test.bitpay.com/ledgers/
Facades: merchant
Response
Some ledger entries have additional specific fields. The table indicates which fields are returned for the main ledger entries.
| Name | Type | Ledger Codes | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1000 | 1006 | 1011 | 1017 | 1020 | 1022 | 1023 | 1025 | 1030 | 1034 | 1039 | 1040 | 1048 | ||
type
Contains the Ledger entry name. See the list of Ledger Entry Codes.
|
string
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
amount
Ledger entry amount, relative to the scale. The decimal amount can be obtained by dividing the
amount field by the scale parameter. |
number
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
code
Contains the Ledger entry code. See the list of Ledger Entry Codes.
|
number
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
timestamp
Date and time of the ledger entry (UTC). ISO-8601 format
yyyy-mm-ddThh:mm:ssZ |
string
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
currency
Ledger entry currency for the corresponding amount
|
string
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||
txType
[DEPRECRATED] see
type |
string
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
scale
Power of 10 used for conversion
|
integer
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
id
Ledger resource Id
|
string
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
supportRequest
The refund
requestId |
string
|
✓ | ||||||||||||
description
Ledger entry description. Also contains an
id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...) |
string
|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
invoiceId
BitPay invoice Id
|
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerFields
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerName
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerAddress1
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerAddress2
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerCity
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerState
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerZip
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerCountry
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerPhone
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerNotify
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
buyerEmail
If provided by the merchant in the
buyer object during invoice creation |
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
invoiceAmount
Invoice price in the invoice original currency
|
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
invoiceCurrency
Currency used for invoice creation
|
string
|
✓ | ✓ | ✓ | ✓ | |||||||||
transactionCurrency
Cryptocurrency selected by the consumer when paying an invoice.
|
string
|
✓ | ✓ | ✓ | ✓ | |||||||||