Inherits from Trading_AbstractResponseType : NSObject
Declared in Trading_GetSellerPaymentsResponseType.h
Trading_GetSellerPaymentsResponseType.m

Overview

Returns a summary of pending or paid payments that Half.com created for the seller
identified by the authentication token in the request. Only returns payments that
occurred within a particular pay period. Each payment is for one transaction for
one item in one order. An order can contain transactions for multiple items from
multiple sellers, but this call only retrieves payments that are relevant to one
seller. Payments are only issued for items and transactions that the seller has
confirmed (see the Half.com online help for details). The financial value of a
payment is typically based on an amount that a buyer paid to Half.com for a
transaction, plus the shipping cost the buyer paid to Half.com for the item, minus
Half.com’s commission. For most sellers, each month contains two pay periods: One
from the 1st to the 15th of the month, and one from the 16th to the last day of
the month. Payments are submitted to the seller’s financial institution a certain
number of days after the current pay period ends (see the Half.com online help for
details).

@ingroup EBayAPIInterface

Tasks

  •   paginationResult

    Contains information regarding the pagination of data (if pagination is used),
    including total number of pages and total number of entries.

         property
  •   hasMorePayments

    If true, there are more payments yet to be retrieved. Additional
    GetSellerPayments calls with higher page numbers or more entries per page
    must be made to retrieve these payments. If false, no more payments are
    available or no payments match the request (based on the payment status
    and time filter).

         property
  •   sellerPayment

    Information about a single payment that matches the criteria in the
    request. A payment is between Half.com and a seller. Each payment is for
    one transaction for one item in one order. An order can contain
    transactions for multiple items from multiple sellers, but this call only
    retrieves payments that are relevant to one seller. The financial value of
    a payment is typically based on an amount that a buyer paid to Half.com
    for a transaction, plus the shipping cost the buyer paid for the item,
    minus Half.com’s commission. Payments can also describe refunds that the
    seller has issued. Multiple SellerPayment entries can be returned per page
    of results. Typically, they are returned in reverse chronological order
    (most recent PaidTime first). Only returned if payments exist that match
    the request.

         property
  •   paymentsPerPage

    Indicates the number of payments that can be returned per page of data
    (i.e., per call). This is the same as the value specified in the
    Pagination.EntriesPerPage input (or the default value, if EntriesPerPage
    was not specified). This is not necessarily the actual number of payments
    returned per page (see ReturnedPaymentCountActual).

         property
  •   pageNumber

    Indicates which page of data holds the current result set. Will be the
    same as the value specified in the Pagination.PageNumber input. (If the
    input is higher than the total number of pages, the call fails with an
    error.) If no payments are returned, the value is 0. If payments are
    returned, the first page number is 1.

         property
  •   returnedPaymentCountActual

    Indicates the total number of payments returned (i.e., the number of
    SellerPayment entries returned.

         property

Properties

hasMorePayments

If true, there are more payments yet to be retrieved. Additional
GetSellerPayments calls with higher page numbers or more entries per page
must be made to retrieve these payments. If false, no more payments are
available or no payments match the request (based on the payment status
and time filter).

@property (nonatomic, retain) NSNumber *hasMorePayments

Discussion

If true, there are more payments yet to be retrieved. Additional
GetSellerPayments calls with higher page numbers or more entries per page
must be made to retrieve these payments. If false, no more payments are
available or no payments match the request (based on the payment status
and time filter).

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetSellerPaymentsResponseType.h

pageNumber

Indicates which page of data holds the current result set. Will be the
same as the value specified in the Pagination.PageNumber input. (If the
input is higher than the total number of pages, the call fails with an
error.) If no payments are returned, the value is 0. If payments are
returned, the first page number is 1.

@property (nonatomic, retain) NSNumber *pageNumber

Discussion

Indicates which page of data holds the current result set. Will be the
same as the value specified in the Pagination.PageNumber input. (If the
input is higher than the total number of pages, the call fails with an
error.) If no payments are returned, the value is 0. If payments are
returned, the first page number is 1.

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetSellerPaymentsResponseType.h

paginationResult

Contains information regarding the pagination of data (if pagination is used),
including total number of pages and total number of entries.

@property (nonatomic, retain) Trading_PaginationResultType *paginationResult

Discussion

Contains information regarding the pagination of data (if pagination is used),
including total number of pages and total number of entries.

type : class Trading_PaginationResultType

Declared In

Trading_GetSellerPaymentsResponseType.h

paymentsPerPage

Indicates the number of payments that can be returned per page of data
(i.e., per call). This is the same as the value specified in the
Pagination.EntriesPerPage input (or the default value, if EntriesPerPage
was not specified). This is not necessarily the actual number of payments
returned per page (see ReturnedPaymentCountActual).

@property (nonatomic, retain) NSNumber *paymentsPerPage

Discussion

Indicates the number of payments that can be returned per page of data
(i.e., per call). This is the same as the value specified in the
Pagination.EntriesPerPage input (or the default value, if EntriesPerPage
was not specified). This is not necessarily the actual number of payments
returned per page (see ReturnedPaymentCountActual).

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetSellerPaymentsResponseType.h

returnedPaymentCountActual

Indicates the total number of payments returned (i.e., the number of
SellerPayment entries returned.

@property (nonatomic, retain) NSNumber *returnedPaymentCountActual

Discussion

Indicates the total number of payments returned (i.e., the number of
SellerPayment entries returned.

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetSellerPaymentsResponseType.h

sellerPayment

Information about a single payment that matches the criteria in the
request. A payment is between Half.com and a seller. Each payment is for
one transaction for one item in one order. An order can contain
transactions for multiple items from multiple sellers, but this call only
retrieves payments that are relevant to one seller. The financial value of
a payment is typically based on an amount that a buyer paid to Half.com
for a transaction, plus the shipping cost the buyer paid for the item,
minus Half.com’s commission. Payments can also describe refunds that the
seller has issued. Multiple SellerPayment entries can be returned per page
of results. Typically, they are returned in reverse chronological order
(most recent PaidTime first). Only returned if payments exist that match
the request.

@property (nonatomic, retain) NSMutableArray *sellerPayment

Discussion

Information about a single payment that matches the criteria in the
request. A payment is between Half.com and a seller. Each payment is for
one transaction for one item in one order. An order can contain
transactions for multiple items from multiple sellers, but this call only
retrieves payments that are relevant to one seller. The financial value of
a payment is typically based on an amount that a buyer paid to Half.com
for a transaction, plus the shipping cost the buyer paid for the item,
minus Half.com’s commission. Payments can also describe refunds that the
seller has issued. Multiple SellerPayment entries can be returned per page
of results. Typically, they are returned in reverse chronological order
(most recent PaidTime first). Only returned if payments exist that match
the request.

entry type : class Trading_SellerPaymentType

Declared In

Trading_GetSellerPaymentsResponseType.h