List all payments

Returns a paginated list of your payments. The payments are sorted in order, with the most recent payments appearing first.

GET
/v1/payments/

Authorization

AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Query Parameters

limit?string

The number of results per page. Minimum value is 1 and maximum is 100. Defaults to 20.

starting_after?string

A cursor value specifying the id of a resource to start before. Retrieves items that appear after this cursor in the list. Cannot be used together with ending_before.

Match^[0-9a-fA-F]{24}$
ending_before?string

A cursor value specifying the id of a resource to end after. Retrieves items that appear before this cursor in the list. Cannot be used together with starting_after.

Match^[0-9a-fA-F]{24}$
search?string

Case-insensitive search matched against customerEmail and orderId. Returns coupons where either field contains the search term.

status?string
Value in"created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired"
pageId?string
Match^[0-9a-fA-F]{24}$

Response Body

application/json

curl -X GET "https://api.checkoutpage.com/v1/payments/?limit=20&starting_after=507f1f77bcf86cd799439011&ending_before=507f1f77bcf86cd799439012&search=string&status=created&pageId=string"
{
  "has_more": true,
  "total": 42,
  "data": [
    {
      "id": "string",
      "orderId": "string",
      "orderStatus": "string",
      "customerEmail": "string",
      "customerId": "string",
      "sellerId": "string",
      "pageId": "string",
      "currency": "string",
      "amount": 0,
      "amountPaid": 0,
      "amountDue": 0,
      "amountUsd": 0,
      "amountExcludingTax": 0,
      "taxAmount": 0,
      "taxBreakdown": [
        {
          "taxType": "string",
          "taxabilityReason": "string",
          "taxableAmount": 0,
          "taxAmount": 0,
          "taxRateDetails": {
            "country": "string",
            "percentageDecimal": 0,
            "state": "string",
            "taxType": "string"
          }
        }
      ],
      "stripeTaxCalculationId": "string",
      "stripeTaxTransactionId": "string",
      "dynamicPrice": 0,
      "fees": [
        {
          "name": "string",
          "amount": 0,
          "percentage": 0
        }
      ],
      "billing": {
        "name": "string",
        "companyName": "string",
        "email": "string",
        "billingEmail": "string",
        "phone": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "shipping": {
        "name": "string",
        "phone": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "fields": [
        {
          "fieldId": "string",
          "label": "string",
          "value": "string",
          "element": "checkbox",
          "type": "",
          "meta": "string",
          "reference": "string"
        }
      ],
      "coupon": {
        "id": "string",
        "label": "string",
        "code": "string",
        "amountOff": 0,
        "percentOff": 0,
        "discount": 0
      },
      "discount": {
        "minQuantity": 0,
        "maxQuantity": 0,
        "percentOff": 0,
        "amountOff": 0,
        "amount": 0
      },
      "livemode": true,
      "status": "created",
      "paymentError": "string",
      "paymentMethod": {
        "gateway": "stripe",
        "method": "string",
        "wallet": "string",
        "mode": "default",
        "brand": "string",
        "last4": "string",
        "country": "string",
        "exp_month": 0,
        "exp_year": 0,
        "funding": "string"
      },
      "paymentOption": {
        "type": "manual",
        "name": "string",
        "description": "string",
        "instructions": "string",
        "partialAmount": 0,
        "manualType": "invoice"
      },
      "locale": "string",
      "sessionId": "string",
      "userAgent": "string",
      "screenWidth": 0,
      "visitId": "string",
      "queryParameters": {
        "property1": "string",
        "property2": "string"
      },
      "stripePaymentIntentId": "string",
      "stripePaymentIntentClientSecret": "string",
      "stripeChargeId": "string",
      "upsell": true,
      "upsellPageId": "string",
      "upsellChargeId": "string",
      "upsellSubscriptionId": "string",
      "invoiceId": "string",
      "transactionIds": [
        "string"
      ],
      "canceledAt": "string",
      "canceledBy": "string",
      "canceledReason": "string",
      "isAbandoned": true,
      "recoveredAt": "2019-08-24T14:15:22Z",
      "abandonedCartEmailStatus": "pending",
      "abandonedCartEmailSentAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "productId": "string",
      "productPrice": 0,
      "payWhatYouWantPrice": 0,
      "discountedFromPrice": 0,
      "setupFee": 0,
      "quantity": 0,
      "sku": "string",
      "variants": [
        {
          "name": "string",
          "variantId": "string",
          "reference": "string",
          "selectionType": "single",
          "selectedOptions": [
            {
              "optionId": "string",
              "optionName": "string",
              "sku": "string",
              "quantity": 0,
              "additionalChargeAmount": 0,
              "originalAdditionalChargeAmount": 0,
              "discount": {
                "minQuantity": 0,
                "maxQuantity": 0,
                "percentOff": 0,
                "amountOff": 0,
                "amount": 0
              }
            }
          ]
        }
      ],
      "licenseKeyId": "string"
    }
  ]
}
Empty
Empty
Empty
Empty
Empty