Website logo

Get your ping balance ledger

Gets the ping balance ledger for the logged in member

URL: https://api.trademe.co.nz/v1/Ping/Transactions.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

date_from DateTime (optional)

Exclude transactions before this date. Specify dates in the UTC time zone.
date_to DateTime (optional)

Exclude transactions after this date. Specify dates in the UTC time zone.
page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.
rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50 and supports a maximum of 50

Returns

<BalanceLedgerResponse>

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <Transaction> or null InnerList
TransactionId Integer or null TransactionId
TransactionType Enumeration TransactionType
Purchase 0 Purchase
PurchaseReverse 1 PurchaseReverse
Sale 2 Sale
SaleReverse 3 SaleReverse
RefundToAccount 4 RefundToAccount
RefundFromAccount 5 RefundFromAccount
Withdrawal 6 Withdrawal
WithdrawalReverse 7 WithdrawalReverse
PurchaseRelease 8 PurchaseRelease
SaleRelease 9 SaleRelease
CartPurchase 10 CartPurchase
CartSale 11 CartSale
Peer 12 Peer
CartPurchaseReverse 13 CartPurchaseReverse
RefundToAccountReverse 14 RefundToAccountReverse
RefundFromAccountReverse 15 RefundFromAccountReverse
AdminCredit 16 AdminCredit
TopUp 18 TopUp
PurchaseAndTopup 19 PurchaseAndTopup
RefundFromAccountRelease 20 RefundFromAccountRelease
WithdrawalRelease 21 WithdrawalRelease
PurchaseReverseRelease 22 PurchaseReverseRelease
SettlementReverse 23 SettlementReverse
Dishonour 24 Dishonour
PurchaseCancelledUnclaimed 25 PurchaseCancelledUnclaimed
RefundRetry 26 RefundRetry
RefundUnclaimed 27 RefundUnclaimed
PurchaseCancelledRetry 28 PurchaseCancelledRetry
TopUpRelease 29 TopUpRelease
PurchaseAndTopupRelease 30 PurchaseAndTopupRelease
TopUpReverse 31 TopUpReverse
PurchaseAndTopupReverse 32 PurchaseAndTopupReverse
TopUpCancelledRetry 33 TopUpCancelledRetry
PurchaseAndTopUpCancelledRetry 34 PurchaseAndTopUpCancelledRetry
TopUpReverseRelease 35 TopUpReverseRelease
PurchaseAndTopupReverseRelease 36 PurchaseAndTopupReverseRelease
TopUpReverseUnclaimed 37 TopUpReverseUnclaimed
PurchaseAndTopupReverseUnclaimed 38 PurchaseAndTopupReverseUnclaimed
CartSaleRelease 39 CartSaleRelease
Chargeback 40 Chargeback
PurchaseHold 41 PurchaseHold
TopUpHold 42 TopUpHold
PurchaseAndTopUpHold 43 PurchaseAndTopUpHold
TradeMeAccountTopUp 44 TradeMeAccountTopUp
FeeRefund 45 FeeRefund
BuyerProtectionRefund 49 BuyerProtectionRefund
CartPurchaseAndTopUp 50 CartPurchaseAndTopUp
CartPurchaseReverseRelease 51 CartPurchaseReverseRelease
CartPurchaseAndTopUpReverse 52 CartPurchaseAndTopUpReverse
CartPurchaseAndTopUpReverseRelease 53 CartPurchaseAndTopUpReverseRelease
AdminDebit 17 AdminDebit
TransactionDate DateTime TransactionDate
TransactionParts Collection of <TransactionPart> or null TransactionParts
TransactionPartType Enumeration TransactionPartType
RefundToBalance 0 RefundToBalance
RefundToCard 1 RefundToCard
RefundToBankAccount 2 RefundToBankAccount
PingBalanceTopUp 3 PingBalanceTopUp
PaymentFromBalance 4 PaymentFromBalance
PaymentFromCard 5 PaymentFromCard
PaymentFromBankAccount 6 PaymentFromBankAccount
Purchase 7 Purchase
LoyaltySubscriptionPurchase 8 LoyaltySubscriptionPurchase
PaymentFromLoyalty 9 PaymentFromLoyalty
RefundToLoyalty 10 RefundToLoyalty
PaymentFromOpenBank 11 PaymentFromOpenBank
Title String or null Title
Amount Number Amount
GstCollected Number or null GstCollected
ReferenceNumber String or null ReferenceNumber
Sku String or null Sku
FundSources <FundSources> or null FundSources

Deprecated - use PaymentFrom instead of FundSources

AvailableBalance Number or null AvailableBalance
FundSources Collection of <FundSource> or null FundSourceCollection
Type Enumeration Type
CreditCard 1 CreditCard
BankAccount 2 BankAccount
PingBalance 3 PingBalance
TmLoyalty 4 TmLoyalty
OpenBank 5 OpenBank
FundSourceId Integer FundSourceId
MaskedAccountNumber String or null MaskedAccountNumber
Label String or null Label
Logo String or null Logo
DarkModeLogo String or null DarkModeLogo
VerificationStatus Enumeration or null VerificationStatus
Active 0 active
Disabled 1 disabled
Enabled 2 enabled
Verified 3 verified
Historical 4 historical
VerificationRequired 5 verification_required
Amount Number or null Amount
VerificationCodeCreationDate DateTime or null VerificationCodeCreationDate
PaymentFrom Collection of <FundSource> or null PaymentFrom
(This type has already been defined)
FundDestinations <FundDestinations> or null FundDestinations

Deprecated - use PaymentTo instead of FundDestinations

Amount Number or null Amount
FundDestinations Collection of <FundDestination> or null FundDestinationCollection
BankAccountId Integer BankAccountId
MaskedAccountNumber String or null MaskedAccountNumber
Status Enumeration Status
Active 0 active
Disabled 1 disabled
Enabled 2 enabled
Verified 3 verified
Historical 4 historical
VerificationRequired 5 verification_required
Label String or null Label
Logo String or null Logo
DarkModeLogo String or null DarkModeLogo
SortOrder Integer or null SortOrder
Amount Number or null Amount
VerificationCodeCreationDate DateTime or null VerificationCodeCreationDate
PaymentTo Collection of <FundSource> or null PaymentTo
(This type has already been defined)
Amount Number or null Amount
Balance Number Balance
Fees Number or null Fees
Gst Number or null Gst
Title String or null Title
ListingId String or null ListingId
ReferenceNumber String or null ReferenceNumber
Sku String or null Sku
Subtitle String or null Subtitle
IsCart Boolean IsCart

Example XML Response (switch to JSON) 

<BalanceLedgerResponse xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <Transaction>
      <TransactionId>123</TransactionId>
      <TransactionType>Purchase</TransactionType>
      <TransactionDate>2018-01-01T00:00:00Z</TransactionDate>
      <TransactionParts>
        <TransactionPart>
          <TransactionPartType>RefundToBalance</TransactionPartType>
          <Title>ABC</Title>
          <Amount>123.0</Amount>
          <GstCollected>123.0</GstCollected>
          <ReferenceNumber>ABC</ReferenceNumber>
          <Sku>ABC</Sku>
        </TransactionPart>
        <TransactionPart>
          <TransactionPartType>RefundToBalance</TransactionPartType>
          <Title>ABC</Title>
          <Amount>123.0</Amount>
          <GstCollected>123.0</GstCollected>
          <ReferenceNumber>ABC</ReferenceNumber>
          <Sku>ABC</Sku>
        </TransactionPart>
      </TransactionParts>
      <FundSources>
        <AvailableBalance>123.0</AvailableBalance>
        <FundSources>
          <FundSource>
            <Type>CreditCard</Type>
            <FundSourceId>123</FundSourceId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <VerificationStatus>Active</VerificationStatus>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundSource>
          <FundSource>
            <Type>CreditCard</Type>
            <FundSourceId>123</FundSourceId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <VerificationStatus>Active</VerificationStatus>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundSource>
        </FundSources>
      </FundSources>
      <PaymentFrom>
        <FundSource />
        <FundSource />
      </PaymentFrom>
      <FundDestinations>
        <Amount>123.0</Amount>
        <FundDestinations>
          <FundDestination>
            <BankAccountId>123</BankAccountId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Status>Active</Status>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <SortOrder>123</SortOrder>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundDestination>
          <FundDestination>
            <BankAccountId>123</BankAccountId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Status>Active</Status>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <SortOrder>123</SortOrder>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundDestination>
        </FundDestinations>
      </FundDestinations>
      <PaymentTo>
        <FundSource />
        <FundSource />
      </PaymentTo>
      <Amount>123.0</Amount>
      <Balance>123.0</Balance>
      <Fees>123.0</Fees>
      <Gst>123.0</Gst>
      <Title>ABC</Title>
      <ListingId>ABC</ListingId>
      <ReferenceNumber>ABC</ReferenceNumber>
      <Sku>ABC</Sku>
      <Subtitle>ABC</Subtitle>
      <IsCart>false</IsCart>
    </Transaction>
    <Transaction>
      <TransactionId>123</TransactionId>
      <TransactionType>Purchase</TransactionType>
      <TransactionDate>2018-01-01T00:00:00Z</TransactionDate>
      <TransactionParts>
        <TransactionPart>
          <TransactionPartType>RefundToBalance</TransactionPartType>
          <Title>ABC</Title>
          <Amount>123.0</Amount>
          <GstCollected>123.0</GstCollected>
          <ReferenceNumber>ABC</ReferenceNumber>
          <Sku>ABC</Sku>
        </TransactionPart>
        <TransactionPart>
          <TransactionPartType>RefundToBalance</TransactionPartType>
          <Title>ABC</Title>
          <Amount>123.0</Amount>
          <GstCollected>123.0</GstCollected>
          <ReferenceNumber>ABC</ReferenceNumber>
          <Sku>ABC</Sku>
        </TransactionPart>
      </TransactionParts>
      <FundSources>
        <AvailableBalance>123.0</AvailableBalance>
        <FundSources>
          <FundSource>
            <Type>CreditCard</Type>
            <FundSourceId>123</FundSourceId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <VerificationStatus>Active</VerificationStatus>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundSource>
          <FundSource>
            <Type>CreditCard</Type>
            <FundSourceId>123</FundSourceId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <VerificationStatus>Active</VerificationStatus>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundSource>
        </FundSources>
      </FundSources>
      <PaymentFrom>
        <FundSource />
        <FundSource />
      </PaymentFrom>
      <FundDestinations>
        <Amount>123.0</Amount>
        <FundDestinations>
          <FundDestination>
            <BankAccountId>123</BankAccountId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Status>Active</Status>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <SortOrder>123</SortOrder>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundDestination>
          <FundDestination>
            <BankAccountId>123</BankAccountId>
            <MaskedAccountNumber>ABC</MaskedAccountNumber>
            <Status>Active</Status>
            <Label>ABC</Label>
            <Logo>ABC</Logo>
            <DarkModeLogo>ABC</DarkModeLogo>
            <SortOrder>123</SortOrder>
            <Amount>123.0</Amount>
            <VerificationCodeCreationDate>2018-01-01T00:00:00Z</VerificationCodeCreationDate>
          </FundDestination>
        </FundDestinations>
      </FundDestinations>
      <PaymentTo>
        <FundSource />
        <FundSource />
      </PaymentTo>
      <Amount>123.0</Amount>
      <Balance>123.0</Balance>
      <Fees>123.0</Fees>
      <Gst>123.0</Gst>
      <Title>ABC</Title>
      <ListingId>ABC</ListingId>
      <ReferenceNumber>ABC</ReferenceNumber>
      <Sku>ABC</Sku>
      <Subtitle>ABC</Subtitle>
      <IsCart>false</IsCart>
    </Transaction>
  </List>
</BalanceLedgerResponse>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "TransactionId": 123,
      "TransactionType": 0,
      "TransactionDate": "\/Date(1514764800)\/",
      "TransactionParts": [
        {
          "TransactionPartType": 0,
          "Title": "ABC",
          "Amount": 123.0,
          "GstCollected": 123.0,
          "ReferenceNumber": "ABC",
          "Sku": "ABC"
        },
        {
          "TransactionPartType": 0,
          "Title": "ABC",
          "Amount": 123.0,
          "GstCollected": 123.0,
          "ReferenceNumber": "ABC",
          "Sku": "ABC"
        }
      ],
      "FundSources": {
        "AvailableBalance": 123.0,
        "FundSources": [
          {
            "Type": 1,
            "FundSourceId": 123,
            "MaskedAccountNumber": "ABC",
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "VerificationStatus": 0,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          },
          {
            "Type": 1,
            "FundSourceId": 123,
            "MaskedAccountNumber": "ABC",
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "VerificationStatus": 0,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          }
        ]
      },
      "PaymentFrom": [
        {
        },
        {
        }
      ],
      "FundDestinations": {
        "Amount": 123.0,
        "FundDestinations": [
          {
            "BankAccountId": 123,
            "MaskedAccountNumber": "ABC",
            "Status": 0,
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "SortOrder": 123,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          },
          {
            "BankAccountId": 123,
            "MaskedAccountNumber": "ABC",
            "Status": 0,
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "SortOrder": 123,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          }
        ]
      },
      "PaymentTo": [
        {
        },
        {
        }
      ],
      "Amount": 123.0,
      "Balance": 123.0,
      "Fees": 123.0,
      "Gst": 123.0,
      "Title": "ABC",
      "ListingId": "ABC",
      "ReferenceNumber": "ABC",
      "Sku": "ABC",
      "Subtitle": "ABC",
      "IsCart": false
    },
    {
      "TransactionId": 123,
      "TransactionType": 0,
      "TransactionDate": "\/Date(1514764800)\/",
      "TransactionParts": [
        {
          "TransactionPartType": 0,
          "Title": "ABC",
          "Amount": 123.0,
          "GstCollected": 123.0,
          "ReferenceNumber": "ABC",
          "Sku": "ABC"
        },
        {
          "TransactionPartType": 0,
          "Title": "ABC",
          "Amount": 123.0,
          "GstCollected": 123.0,
          "ReferenceNumber": "ABC",
          "Sku": "ABC"
        }
      ],
      "FundSources": {
        "AvailableBalance": 123.0,
        "FundSources": [
          {
            "Type": 1,
            "FundSourceId": 123,
            "MaskedAccountNumber": "ABC",
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "VerificationStatus": 0,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          },
          {
            "Type": 1,
            "FundSourceId": 123,
            "MaskedAccountNumber": "ABC",
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "VerificationStatus": 0,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          }
        ]
      },
      "PaymentFrom": [
        {
        },
        {
        }
      ],
      "FundDestinations": {
        "Amount": 123.0,
        "FundDestinations": [
          {
            "BankAccountId": 123,
            "MaskedAccountNumber": "ABC",
            "Status": 0,
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "SortOrder": 123,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          },
          {
            "BankAccountId": 123,
            "MaskedAccountNumber": "ABC",
            "Status": 0,
            "Label": "ABC",
            "Logo": "ABC",
            "DarkModeLogo": "ABC",
            "SortOrder": 123,
            "Amount": 123.0,
            "VerificationCodeCreationDate": "\/Date(1514764800)\/"
          }
        ]
      },
      "PaymentTo": [
        {
        },
        {
        }
      ],
      "Amount": 123.0,
      "Balance": 123.0,
      "Fees": 123.0,
      "Gst": 123.0,
      "Title": "ABC",
      "ListingId": "ABC",
      "ReferenceNumber": "ABC",
      "Sku": "ABC",
      "Subtitle": "ABC",
      "IsCart": false
    }
  ]
}