GetPayoutStatus

Definition

Use this call to get the payout status for a specified period.

Request URI: https://api.sellercenter.lazada.sg?Action=GetPayoutStatus

Parameters

Field	Type	Description
Action	string	GetPayoutStatus Name of the API that is to be called. Mandatory.
Format	string	The response format, with XML as the default. Can be XML or JSON. Optional.
Timestamp	datetime	The current time in ISO8601 format (e.g., Timestamp=2016-04-01T10:00:00+02:00 for Berlin). Mandatory.
UserID	string	The ID of the user making the call. Mandatory.
Version	string	The API version against which this call is to be executed. The current version is "1.0". Mandatory.
Signature	string	The cryptographic signature, authenticating the request. You must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory.
CreatedAfter	datetime	Filter statements created after the provided date. Mandatory.

Code sample

# GetPayoutStatus cURL example
# to run, update Timestamp and recompute Signature
#
url = "https://api.sg.ali-lazada.com/"
get
data-urlencode Action=GetPayoutStatus
data-urlencode CreatedAfter=2015-01-01T11:11+0200
data-urlencode Timestamp=2015-07-01T11:11+0000
data-urlencode [email protected]
data-urlencode Version=1.0
data-urlencode Signature=d4ff93cccb165295ed8357fe42082208b781a3b576bbb7d3fe7a624270b047b9

GetPayoutStatus request = new GetPayoutStatus();
try {
  GetPayoutStatusResponse response = request.execute();
  for(PayoutStatus payoutStatus: response.getBody()) {
    System.out.println(payoutStatus);
  }
} catch (LazadaException e) {
  System.out.println(e.getResponseStr());
}

Response

The response contains the following fields.

Name	Type	Description
StatementNumber	string	Statement identifier
CreatedAt	datetime	When the statement was created
UpdatedAt	datetime	When the statement was last updated
OpeningBalance	decimal	The opening balance
ItemRevenue	decimal	The revenue generated by the item
ShipmentFee	decimal	Costs of shipping
ShipmentFeeCredit	decimal	Shipping fee credit, if any
OtherRevenueTotal	decimal	Other total revenue
FeesTotal	decimal	Sum of payment fee and return to seller fee
Subtotal1	decimal	Sum of item revenue and other revenue
Refunds	decimal	Sum of all refunds, if any
FeesOnRefundsTotal	decimal	Accumulated fees on refunds issued
Subtotal2	decimal	(Sum of Subtotal1) - Refunds
ClosingBalance	decimal	Closing balance
GuaranteeDeposit	decimal	Guarantee deposit
Payout	decimal	Amount to be paid out to seller for statement
Paid	boolean	Payout status of statement. 1 is paid, and 0 is not paid

Result sample

<?xml version="1.0" encoding="UTF-8"?>
<SuccessResponse>
  <Head>
    <RequestId/>
    <RequestAction>GetPayoutStatus</RequestAction>
    <ResponseType>Statement</ResponseType>
    <Timestamp>2015-06-16T13:57:59+0000</Timestamp>
  </Head>
  <Body>
    <PayoutStatus>
      <Statement>
        <StatementNumber>EG100RT-20141228</StatementNumber>
        <CreatedAt>2014-01-04 00:23:04</CreatedAt>
        <UpdatedAt>2014-01-04 00:23:04</UpdatedAt>
        <OpeningBalance>0.00</OpeningBalance>
        <ItemRevenue>0</ItemRevenue>
        <ShipmentFee>51.20</ShipmentFee>
        <ShipmentFeeCredit>51.20</ShipmentFeeCredit>
        <OtherRevenueTotal>0</OtherRevenueTotal>
        <FeesTotal>51.20</FeesTotal>
        <Subtotal1>-51.20</Subtotal1>
        <Refunds>0</Refunds>
        <FeesOnRefundsTotal>0</FeesOnRefundsTotal>
        <Subtotal2>-51.20</Subtotal2>
        <ClosingBalance>3962.41</ClosingBalance>
        <GuaranteeDeposit>0</GuaranteeDeposit>
        <Payout>3962.41 EUR</Payout>
        <Paid>0</Paid>
      </Statement>
      <Statement>
        <StatementNumber>EG100RT-20141229</StatementNumber>
        <CreatedAt>2015-01-04 00:23:04</CreatedAt>
        <UpdatedAt>2015-01-04 00:23:04</UpdatedAt>
        <OpeningBalance>10.00</OpeningBalance>
        <ItemRevenue>0</ItemRevenue>
        <ShipmentFee>1.50</ShipmentFee>
        <ShipmentFeeCredit>1.50</ShipmentFeeCredit>
        <OtherRevenueTotal>0</OtherRevenueTotal>
        <FeesTotal>1.50</FeesTotal>
        <Subtotal1>-1.50</Subtotal1>
        <Refunds>0</Refunds>
        <FeesOnRefundsTotal>0</FeesOnRefundsTotal>
        <Subtotal2>-1.50</Subtotal2>
        <ClosingBalance>777.77</ClosingBalance>
        <GuaranteeDeposit>0</GuaranteeDeposit>
        <Payout>666.66 EUR</Payout>
        <Paid>0</Paid>
      </Statement>
    </PayoutStatus>
  </Body>
</SuccessResponse>

Error messages

Error code	Message
4	E004: Invalid Timestamp format
62	E062 No seller was found by e-mail %s