# Get All Charges

**GET** `/rpy/adapter-charge/v1/charges`

Base URL: `https://api.pre.globalgetnet.com`

__List All Charges__<br> <br>This endpoint retrieves a list of all registered charges in the system. You can apply various filters to narrow down the results, such as filtering by subscription, customer, charge status, and dates.<br> <br>**Usage Scenarios:**<br>_- Viewing all charges within a certain time period.<br>- Filtering charges by subscription, customer, or plan.<br>- Monitoring charge statuses (e.g., pending, paid, failed).<br>- Exporting charge data for analysis or reporting._

## Authorization

- PROD (oauth2)
- PRE (oauth2)
- SBX (oauth2)

## Query parameters

- `page` (integer)
- `limit` (integer)
- `retries` (integer)
- `plan_id` (string)
- `subscription_id` (string)
- `start_date` (string)
- `end_date` (string)
- `sort` (string)
- `sort_type` (string)
- `status` (string)
- `scheduled_date` (string)
- `charge_id` (string)
- `customer_id` (string)
- `seller_id` (string)
- `payment_type` (string)
  Type of payment. Comma delimited.

## Responses

### 200

Request executed successfully

- `seller_id` (string<uuid>)
- `order_id` (string)
- `payment_id` (string<uuid>)
- `amount` (integer<int32>)
- `currency` (string)
- `status` ("pending" | "canceled" | "approved" | "denied" | "authorized" | "confirmed" | "expired" | "unprocessed")
- `payment_received_timestamp` (string<date-time>)
- `credit` (object)
  - `delayed` (boolean)
  - `authorization_code` (string, required)
  - `authorization_timestamp` (string<date-time>)
  - `reason_code` (string, required)
  - `reason_message` (string, required)
  - `acquirer` (string)
  - `soft_descriptor` (string)
  - `brand` ("Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro")
  - `terminal_nsu` (string)
  - `acquirer_transaction_id` (string, required)
  - `transaction_id` (string, required)
- `debit` (object)
  - `delayed` (boolean)
  - `authorization_code` (string, required)
  - `authorization_timestamp` (string<date-time>)
  - `reason_code` (string, required)
  - `reason_message` (string, required)
  - `acquirer` (string)
  - `soft_descriptor` (string)
  - `brand` ("Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro")
  - `terminal_nsu` (string)
  - `acquirer_transaction_id` (string, required)
  - `transaction_id` (string, required)
- `error` (object)
  - `status_code` (integer<int32>)
  - `name` (string)
  - `message` (string)
  - `details` (object[])
    - `acquirer_transaction_id` (string)
    - `description` (string)
    - `description_detail` (string)
    - `error_code` (string)
    - `payment_id` (string)
    - `status` (string)
    - `terminal_nsu` (string)

Example:

```json
{
  "seller_id": "00000000-0000-0000-0000-000000000000",
  "order_id": "string",
  "payment_id": "00000000-0000-0000-0000-000000000000",
  "amount": 0,
  "currency": "string",
  "status": "pending",
  "payment_received_timestamp": "1970-01-01T00:00:00.000Z",
  "credit": {
    "delayed": true,
    "authorization_code": "string",
    "authorization_timestamp": "1970-01-01T00:00:00.000Z",
    "reason_code": "string",
    "reason_message": "string",
    "acquirer": "string",
    "soft_descriptor": "string",
    "brand": "Mastercard",
    "terminal_nsu": "string",
    "acquirer_transaction_id": "string",
    "transaction_id": "string"
  },
  "debit": {
    "delayed": true,
    "authorization_code": "string",
    "authorization_timestamp": "1970-01-01T00:00:00.000Z",
    "reason_code": "string",
    "reason_message": "string",
    "acquirer": "string",
    "soft_descriptor": "string",
    "brand": "Mastercard",
    "terminal_nsu": "string",
    "acquirer_transaction_id": "string",
    "transaction_id": "string"
  },
  "error": {
    "status_code": 0,
    "name": "string",
    "message": "string",
    "details": [
      {
        "acquirer_transaction_id": "string",
        "description": "string",
        "description_detail": "string",
        "error_code": "string",
        "payment_id": "string",
        "status": "string",
        "terminal_nsu": "string"
      }
    ]
  }
}
```

### 400

Invalid request.

- `status` (string)
  Error situation.
- `error_code` (string)
  Error code.
- `description` (string)
  Description of the error.
- `description_detail` (string)
  Detailed description of the error.
- `brand` (string)
  Brand.
- `payment_id` (string)
  payment_id.
- `seller_id` (string)
  seller_id.
- `amount` (string)
  amount.
- `currency` (string)
  currency.
- `order_id` (string)
  order_id.
- `credit_cancel` (object)
  credit_cancel.
  - `canceled_at` (string)
    canceledAt.
  - `message` (string)
    message.
- `payment_tag` (string)
  payment_tag.
- `status_code` (string)
  statusCode.
- `message` (string)
  message.
- `name` (string)
  name.
- `acquirer_transaction_id` (string)
  acquirer_transaction_id.
- `authorization_code` (string)
  authorization_code.
- `transaction_id` (string)
  transaction_id.
- `reason_code` (string)
  reason_code.
- `reason_message` (string)
  reason_message.
- `merchant_advice_code` (string)
  merchant_advice_code.

Example:

```json
{
  "status": "string",
  "error_code": "string",
  "description": "string",
  "description_detail": "string",
  "brand": "string",
  "payment_id": "string",
  "seller_id": "string",
  "amount": "string",
  "currency": "string",
  "order_id": "string",
  "credit_cancel": {
    "canceled_at": "string",
    "message": "string"
  },
  "payment_tag": "string",
  "status_code": "string",
  "message": "string",
  "name": "string",
  "acquirer_transaction_id": "string",
  "authorization_code": "string",
  "transaction_id": "string",
  "reason_code": "string",
  "reason_message": "string",
  "merchant_advice_code": "string"
}
```

### 401

Invalid authentication. Check your credentials or contact the Getnet Relationship Center.

- `status` (string)
  Error situation.
- `error_code` (string)
  Error code.
- `description` (string)
  Description of the error.
- `description_detail` (string)
  Detailed description of the error.
- `brand` (string)
  Brand.
- `payment_id` (string)
  payment_id.
- `seller_id` (string)
  seller_id.
- `amount` (string)
  amount.
- `currency` (string)
  currency.
- `order_id` (string)
  order_id.
- `credit_cancel` (object)
  credit_cancel.
  - `canceled_at` (string)
    canceledAt.
  - `message` (string)
    message.
- `payment_tag` (string)
  payment_tag.
- `status_code` (string)
  statusCode.
- `message` (string)
  message.
- `name` (string)
  name.
- `acquirer_transaction_id` (string)
  acquirer_transaction_id.
- `authorization_code` (string)
  authorization_code.
- `transaction_id` (string)
  transaction_id.
- `reason_code` (string)
  reason_code.
- `reason_message` (string)
  reason_message.
- `merchant_advice_code` (string)
  merchant_advice_code.

Example:

```json
{
  "status": "string",
  "error_code": "string",
  "description": "string",
  "description_detail": "string",
  "brand": "string",
  "payment_id": "string",
  "seller_id": "string",
  "amount": "string",
  "currency": "string",
  "order_id": "string",
  "credit_cancel": {
    "canceled_at": "string",
    "message": "string"
  },
  "payment_tag": "string",
  "status_code": "string",
  "message": "string",
  "name": "string",
  "acquirer_transaction_id": "string",
  "authorization_code": "string",
  "transaction_id": "string",
  "reason_code": "string",
  "reason_message": "string",
  "merchant_advice_code": "string"
}
```

### 404

Not found

- `status` (string)
  Error situation.
- `error_code` (string)
  Error code.
- `description` (string)
  Description of the error.
- `description_detail` (string)
  Detailed description of the error.
- `brand` (string)
  Brand.
- `payment_id` (string)
  payment_id.
- `seller_id` (string)
  seller_id.
- `amount` (string)
  amount.
- `currency` (string)
  currency.
- `order_id` (string)
  order_id.
- `credit_cancel` (object)
  credit_cancel.
  - `canceled_at` (string)
    canceledAt.
  - `message` (string)
    message.
- `payment_tag` (string)
  payment_tag.
- `status_code` (string)
  statusCode.
- `message` (string)
  message.
- `name` (string)
  name.
- `acquirer_transaction_id` (string)
  acquirer_transaction_id.
- `authorization_code` (string)
  authorization_code.
- `transaction_id` (string)
  transaction_id.
- `reason_code` (string)
  reason_code.
- `reason_message` (string)
  reason_message.
- `merchant_advice_code` (string)
  merchant_advice_code.

Example:

```json
{
  "status": "string",
  "error_code": "string",
  "description": "string",
  "description_detail": "string",
  "brand": "string",
  "payment_id": "string",
  "seller_id": "string",
  "amount": "string",
  "currency": "string",
  "order_id": "string",
  "credit_cancel": {
    "canceled_at": "string",
    "message": "string"
  },
  "payment_tag": "string",
  "status_code": "string",
  "message": "string",
  "name": "string",
  "acquirer_transaction_id": "string",
  "authorization_code": "string",
  "transaction_id": "string",
  "reason_code": "string",
  "reason_message": "string",
  "merchant_advice_code": "string"
}
```

### 422

Unprocessable Entity

- `message` (string)
  Detailed error message.
- `name` (string)
  Name of the module or system in which the error occurred.
- `status_code` (integer<int32>)
  HTTP status code of the error.
- `details` (object[])
  Error details.
  - `status` (string)
    Error situation.
  - `error_code` (string)
    Error code.
  - `description` (string)
    Description of the error.
  - `description_detail` (string)
    Detailed description of the error.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `payments` (object[])
  Error details.
  - `status` (string)
    Error situation.
  - `error_code` (string)
    Error code.
  - `description` (string)
    Description of the error.
  - `description_detail` (string)
    Detailed description of the error.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `combined_id` (string)
  combinedId.
- `order_id` (string)
  orderId.
- `seller_id` (string)
  sellerId.

Example:

```json
{
  "message": "string",
  "name": "string",
  "status_code": 0,
  "details": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "payments": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "combined_id": "string",
  "order_id": "string",
  "seller_id": "string"
}
```

### 500

Internal server error. Please try again later.

- `status` (string)
  Error situation.
- `error_code` (string)
  Error code.
- `description` (string)
  Description of the error.
- `description_detail` (string)
  Detailed description of the error.
- `brand` (string)
  Brand.
- `payment_id` (string)
  payment_id.
- `seller_id` (string)
  seller_id.
- `amount` (string)
  amount.
- `currency` (string)
  currency.
- `order_id` (string)
  order_id.
- `credit_cancel` (object)
  credit_cancel.
  - `canceled_at` (string)
    canceledAt.
  - `message` (string)
    message.
- `payment_tag` (string)
  payment_tag.
- `status_code` (string)
  statusCode.
- `message` (string)
  message.
- `name` (string)
  name.
- `acquirer_transaction_id` (string)
  acquirer_transaction_id.
- `authorization_code` (string)
  authorization_code.
- `transaction_id` (string)
  transaction_id.
- `reason_code` (string)
  reason_code.
- `reason_message` (string)
  reason_message.
- `merchant_advice_code` (string)
  merchant_advice_code.

Example:

```json
{
  "status": "string",
  "error_code": "string",
  "description": "string",
  "description_detail": "string",
  "brand": "string",
  "payment_id": "string",
  "seller_id": "string",
  "amount": "string",
  "currency": "string",
  "order_id": "string",
  "credit_cancel": {
    "canceled_at": "string",
    "message": "string"
  },
  "payment_tag": "string",
  "status_code": "string",
  "message": "string",
  "name": "string",
  "acquirer_transaction_id": "string",
  "authorization_code": "string",
  "transaction_id": "string",
  "reason_code": "string",
  "reason_message": "string",
  "merchant_advice_code": "string"
}
```

### 504

The server encountered a temporary error and did not complete the request. Please try again later.

- `status` (string)
  Error situation.
- `error_code` (string)
  Error code.
- `description` (string)
  Description of the error.
- `description_detail` (string)
  Detailed description of the error.
- `brand` (string)
  Brand.
- `payment_id` (string)
  payment_id.
- `seller_id` (string)
  seller_id.
- `amount` (string)
  amount.
- `currency` (string)
  currency.
- `order_id` (string)
  order_id.
- `credit_cancel` (object)
  credit_cancel.
  - `canceled_at` (string)
    canceledAt.
  - `message` (string)
    message.
- `payment_tag` (string)
  payment_tag.
- `status_code` (string)
  statusCode.
- `message` (string)
  message.
- `name` (string)
  name.
- `acquirer_transaction_id` (string)
  acquirer_transaction_id.
- `authorization_code` (string)
  authorization_code.
- `transaction_id` (string)
  transaction_id.
- `reason_code` (string)
  reason_code.
- `reason_message` (string)
  reason_message.
- `merchant_advice_code` (string)
  merchant_advice_code.

Example:

```json
{
  "status": "string",
  "error_code": "string",
  "description": "string",
  "description_detail": "string",
  "brand": "string",
  "payment_id": "string",
  "seller_id": "string",
  "amount": "string",
  "currency": "string",
  "order_id": "string",
  "credit_cancel": {
    "canceled_at": "string",
    "message": "string"
  },
  "payment_tag": "string",
  "status_code": "string",
  "message": "string",
  "name": "string",
  "acquirer_transaction_id": "string",
  "authorization_code": "string",
  "transaction_id": "string",
  "reason_code": "string",
  "reason_message": "string",
  "merchant_advice_code": "string"
}
```