Accounting

Retrieve payouts

get

Retrieve list of payouts for your merchant account and their status.

Query parameters

ReferencestringOptional

InvoicePrefix (PREFIX) + InvoiceNo (00000) will search for transfers containing an invoice with prefix + number

Example: CR130222

Statusstring · enumOptional

Payout status. Array of strings. Possible values: PAID,PARTIALLY_PAID,CANCELED

Example: ["PAID","PARTIALLY_PAID","CANCELED"]Possible values:

CurrencystringOptional

3 letter ISO currency code

Example: USD

StartDatestringOptional

Start payment date. Format: yyyy-mm-dd

Example: 2019-02-14

EndDatestringOptional

End payment date. Format: yyyy-mm-dd

Example: 2019-11-14

PaymentTypestring · enumOptional

Payment type. Can be one of "WIRE", "PAYPAL", "CHECK", "PAYONEER", "WEBMONEY" or "INTERNATIONAL_WIRE"

Example: WIREPossible values:

OrderBystring · enumOptional

This parameter orders payouts. The only parameter allowed is "TransferCompletionDate". The preceding "-" sign means order by DESC, ommit it for searching ASC

Example: -TransferCompletionDatePossible values:

PageintegerOptional

Page number

Example: 3

LimitintegerOptional

Number of results on a page

Example: 25

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

Search payouts object

application/json

400

Bad request

application/json

get

/payouts

HTTPcURLJavaScriptPython

GET /rest/6.0/payouts HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "Items": [
    {
      "TransferCompletionDate": "2019-02-27",
      "PaymentType": "WIRE",
      "Amount": 13,
      "TotalSales": 1,
      "TotalFees": 1,
      "TotalRefunds": 0,
      "Currency": "USD",
      "Status": "PAID",
      "Invoices": [
        {
          "Reference": "BV27877349",
          "Amount": 2.5,
          "Description": "some description",
          "Type": "Services",
          "Code": "123CV13",
          "Date": "2018-08-20",
          "PaidAmount": 2.5,
          "PaidDate": "2019-02-28",
          "PaidCurrency": "USD",
          "RetainedAmount": 1,
          "ReleasedAmount": 1
        }
      ],
      "Summary": {
        "ServicesAmount": 0,
        "PurchaseOrdersAmount": 0,
        "ChargeBacksAmount": 0,
        "RollingReserveAmount": 0,
        "PeriodNetSales": 0,
        "VendorToVendor": 0,
        "ChargeBackFund": 0
      }
    }
  ],
  "Pagination": {
    "Page": 1,
    "Limit": 10,
    "Count": 12
  }
}

Retrieve account balance

get

Retrieve the account balance situation for your merchant account.

Query parameters

CurrencystringOptional

Use this parameter to show the balance only for a single order currency. If not sent, or sent as NULL, 2Checkout sends the balance for all order currencies

Example: USD

TotalCurrencystringOptional

Use this parameter to show the total account balance in the preferred currency. If not sent, or sent as NULL, 2Checkout sends the total balance in the default account currency

Example: EUR

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

Pending payout object

application/json

400

Bad request

application/json

get

/payouts/pending

HTTPcURLJavaScriptPython

GET /rest/6.0/payouts/pending HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "Currencies": [
    {
      "Currency": "USD",
      "OrdersTotal": {
        "estore": 12,
        "affilietes": 10,
        "partner": 7,
        "total": 29
      },
      "RetainedToDisputesBalance": 0,
      "ReleasedFromDisputesBalance": 0,
      "RetainedToRollingReserveBalance": 5.18,
      "ReleasedFromRollingReserveBalance": 0,
      "ChargebackFees": 0,
      "ProcessingFees": 0,
      "AffiliatesCommission": 0,
      "TaxCollected": 0,
      "EstimatedTotalRevenue": -5.18
    }
  ],
  "Total": {
    "Currency": "AUD",
    "OrdersTotal": {
      "estore": 258.12,
      "affilietes": 13.1,
      "partner": 7.7,
      "total": 278.92
    },
    "RetainedToDisputesBalance": 0,
    "ReleasedFromDisputesBalance": 0,
    "RetainedToRollingReserveBalance": 27.39,
    "ReleasedFromRollingReserveBalance": 0,
    "ChargebackFees": 0,
    "ProcessingFees": -20.97,
    "AffiliatesCommission": 0,
    "TaxCollected": -18.83,
    "EstimatedTotalRevenue": 190.93
  }
}