Listar Pagamentos

Obtenha uma lista de todos os pagamentos associados à sua conta.

GET /payments

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const paymentListResponse of client.payments.list()) {
  console.log(paymentListResponse.brand_id);
}

200

{
  "items": [
    {
      "brand_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer": {
        "customer_id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "metadata": {},
        "phone_number": "<string>"
      },
      "digital_products_delivered": true,
      "has_license_key": true,
      "metadata": {},
      "payment_id": "<string>",
      "total_amount": 123,
      "invoice_id": "<string>",
      "invoice_url": "<string>",
      "payment_method": "<string>",
      "payment_method_type": "<string>",
      "subscription_id": "<string>"
    }
  ]
}

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

created_at_gte · string<date-time>

Get events after this created time

created_at_lte · string<date-time>

Get events created before this time

page_size · integer<int32>

Page size default is 10 max is 100

Intervalo obrigatório: x >= 0

page_number · integer<int32>

Page number default is 0

Intervalo obrigatório: x >= 0

customer_id · string

Filter by customer id

subscription_id · string

Filter by subscription id

status · enum<string>

Filter by status

Opções disponíveis: succeeded, failed, cancelled, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable

brand_id · string

filter by Brand id

product_id · string

Filter by product id

Resposta

200

application/json

items · object[] · obrigatório

Show child attributes