Language

2Checkout Documentation

List Payments

The list_payments call is used to get a list of past payments.

URL: https://www.2checkout.com/api/acct/list_payments

HTTP Method: GET


Input Parameters

No input parameters required.


Data Returned

Parameter Description
payment_id Identifier of payment
payment_identifier Identifier of payment batch
date_paid Date of payment (YYYY-MM-DD MM:HH:SS format)
amount Amount of payment
reserve_held Reserve held
total_reserve_released Reserve released
date_reserve_released Date reserve released
payment_type Method of money transfer
total_sales Total amount of sales included in payment
total_fees Total amount of fees included in payment
total_refunds Total amount of refunds included in payment
total_chargeback_fees Total amount of chargebacks included in payment
total_adjustments Total amount of adjustments included in payment
total_commissions Total amount of commissions earned included in payment
total_outgoing_commissions Total amount of commissions paid included in payment
total_balance_forward Total amount of forwarded balance included in payment
void Wheter or not the payment was voided. (0=not voided, 1=voided)
date_voided Date the payment was voided.

Example API calls using cURL

curl -G https://www.2checkout.com/api/acct/list_payments \
    -H 'Accept: application/json' -u 'username:password'

Example Successful Response

    {
       "payments" : [
          {
             "amount" : "50240.51",
             "date_paid" : null,
             "date_reserve_released" : null,
             "date_voided" : null,
             "payment_id" : "4681565342",
             "payment_identifier" : "wire_999042012",
             "payment_type" : "wire",
             "reserve_held" : "1646.07",
             "total_adjustments" : "0.00",
             "total_balance_forward" : "0.00",
             "total_chargeback_fees" : "0.00",
             "total_commissions" : "0.00",
             "total_fees" : "1941.34",
             "total_outgoing_commissions" : "0.00",
             "total_refunds" : "2418.46",
             "total_reserve_released" : "1397.38",
             "total_sales" : "54869.00",
             "void" : null
          },
          {
             "amount" : "45616.52",
             "date_paid" : null,
             "date_reserve_released" : null,
             "date_voided" : null,
             "payment_id" : "4676285423",
             "payment_identifier" : "wire_992042012",
             "payment_type" : "wire",
             "reserve_held" : "1499.83",
             "total_adjustments" : "0.00",
             "total_balance_forward" : "0.00",
             "total_chargeback_fees" : "0.00",
             "total_commissions" : "0.00",
             "total_fees" : "1768.57",
             "total_outgoing_commissions" : "0.00",
             "total_refunds" : "2553.00",
             "total_reserve_released" : "1463.62",
             "total_sales" : "49994.30",
             "void" : null
          }
       ],
       "response_code" : "OK",
       "response_message" : "payment info retrieved"
    }