# Get Subscriptions

**GET** `/rpy/be-subscription/v1/subscriptions`

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

__List Subscriptions__<br> <br>This endpoint retrieves a paginated list of all subscriptions created by the seller, including their current status, customer details, and plan associations.<br> <br>**Usage Scenarios:**<br>_- Monitoring active or scheduled subscriptions tied to specific customers or plans.<br>- Building dashboards or reports with current subscription statuses.<br>- Auditing or debugging subscription activity based on filters (e.g., customer, date, or plan)._<br> <br>**Notes:**<br>_- You must include the_ `x-seller-id` _header to identify the seller.<br>- Supports pagination via_ `page` _and_ `limit` query parameters.<br>- The result will contain metadata about each subscription, such as ID, plan reference, creation and billing dates, and current status (e.g.,_ `active`, `scheduled`, `canceled`_)._

## Authorization

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

## Path parameters

- `plan_id` (string, required)
  Plan identifier.

## Query parameters

- `page` (integer, required)
  Page number where pagination begins.
- `limit` (integer, required)
  Limit results per page.
- `customer_id` (string, required)
  Buyer identifier. Application-defined information that consumes the Digital Platform API.
- `order_id` (string)
  Purchase identification code used by the ecommerce store.
- `subscription_id` (string)
  Recurring subscription identifier.
- `id` (string)
  Recurrence signature identifier.
- `next_scheduled_date[start]` (string)
  Start date of the next appointment.
- `next_scheduled_date[end]` (string)
  End date of the next appointment.
- `installment_start_date[start]` (string)
  Search start date by payment start date.
- `installment_start_date[end]` (string)
  Search end date by payment start date.
- `create_date[start]` (string)
  Subscription creation start date.
- `create_date[end]` (string)
  Subscription creation end date.
- `end_date[start]` (string)
  Subscription start date.
- `end_date[end]` (string)
  Subscription end date.
- `sort` (string)
  Field to perform the sorting.
- `sort_type` (string)
  Sorting type. Ascending or Descending.
- `status` (string)
  Subscription status.
- `expand` (array)
  Date and value fluctuations

## Responses

### 200

Request made successfully

- `subscriptions` (object[])
  - `seller_id` (string<uuid>, required)
  - `order_id` (string, required)
  - `installment_start_date` (string<date>)
  - `create_date` (string<date-time>, required)
  - `end_date` (string<date-time>)
  - `payment_date` (integer<int32>, required)
  - `next_scheduled_date` (string<date-time>)
  - `subscription` (object)
    - `subscription_id` (string<uuid>, required)
    - `payment_type` (object)
      - `credit` (object)
        - `number_installments` (integer<int32>)
        - `billing_address` (any)
          Set of data referring to the buyer's address
        - `soft_descriptor` (string)
        - `transaction_type` ("FULL" | "INSTALL_WITH_INTEREST" | "INSTALL_NO_INTEREST")
        - `tokenization` (object)
          - `type` ("UCAF" | "TAVV" | "ELO", required)
          - `cryptogram` (string)
          - `eci` (string)
          - `requestor_id` (string)
        - `card` (object)
          - `brand` ("Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro")
          - `bin` (string, required)
          - `expiration_month` (string, required)
          - `expiration_year` (string, required)
          - `cardholder_name` (string, required)
          - `card_id` (string)
        - `wallet` (object)
          - `type` (string, required)
          - `id` (string, required)
      - `debit` (object)
        - `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)
    - `shippings` (object[])
      - `first_name` (string)
      - `last_name` (string)
      - `email` (string)
      - `phone_number` (string)
      - `shipping_amount` (integer<int32>)
      - `address` (any)
        Set of data referring to the buyer's address
  - `customer` (object)
    - `customer_id` (string)
    - `first_name` (string)
    - `last_name` (string)
    - `document_type` ("CPF" | "CNPJ" | "PASSPORT_BR" | "DNI_AR" | "CUIL" | "CUIT" | "PASSPORT_AR" | "RUT" | "CI_CL")
    - `document_type_name` (string)
    - `document_number` (string)
    - `document_country` (string)
    - `phone_number` (string)
    - `celphone_number` (string)
    - `email` (string)
    - `status` ("active" | "inactive")
  - `plan` (object)
    - `seller_id` (string<uuidv4>)
      E-commerce identification code.
    - `plan_id` (string<uuidv4>)
      Plan identifier.
    - `name` (string)
      Plan name.
    - `description` (string)
      Description of the plan.
    - `amount` (integer)
      Plan value.
    - `currency` (string)
      Currency identification (See code in <a href="https://docs.globalgetnet.com/es/articles/currency-codes">this</a> section).
    - `payment_types` ("credit_card" | "debit_card")
      Types of payments accepted.
    - `sales_tax` (integer)
      Tax value.
    - `product_type` ("cash_carry" | "digital_content" | "digital_goods" | "gift_card" | "physical_goods" | "renew_subs" | "shareware" | "service")
      Identifier of the type of product sold among the options.
    - `create_date` (string<YYYY-MM-DDTHH:MM:SSZ>)
      Plan creation date.
    - `status` ("active" | "inactive")
      Plan status.
    - `period` (object)
      Plan period.
      - `type` ("yearly" | "monthly" | "bimonthly" | "quarterly" | "semesterly" | "specific", required)
        Type of periodicity.
      - `billing_cycle` (integer, required)
        Plan duration based on frequency type. For example, for a 12-month plan, where billing will be done monthly (type = monthly) the value to be assigned is 12.
      - `specific_cycle_in_days` (number)
        Specific billing cycle in days. When the type of periodicity is specific (type = specific) the number of days must be assigned in which the billing cycle will be carried out. For example, if the durationthe one in the plan is 12 (billing_cycle = 12) and the specific cycle is 10 (specific_cycle_in_days = 10), This means that the charge will occur every 10 days in total of 12 charges.
    - `floating_data` (object[])
      Preconfigured list of installments that will have a different value when the Subscription is created. This functionality can be used to create tasting installments with zero value, one input value or discounted installments. The use of this functionality and its purpose expected will depend on the enablement of a specific product at Getnet.
      - `installment` (integer<int32>, required)
        Number of the installment to which the change will be applied.
      - `amount` (integer)
        New charge amount for a given portion of the plan. When a Subscription is created with this Plan it will have this characterstatic, for example for installment 2 apply the amount of R$ 10.00. That value can be zero, greater or less than the original value of the Plan.
  - `device` (object)
    - `ip_address` (string)
    - `device_id` (string)
  - `floating_data` (object[])
    - `installment` (integer<int32>, required)
      Number of the installment to which the change will be applied.
    - `new_amount` (integer)
      New charge amount.
    - `new_scheduled_date` (string<YYYY-MM-DD>)
      New billing date
    - `original_scheduled_date` (string<YYYY-MM-DD>)
      Date the billing was originally scheduled, before it was changed, according to the plan associated with the subscription.
    - `original_amount` (integer)
      Original billing amount, before it was changed, according to the plan associated with the subscription.
  - `status` ("processing" | "success" | "expired" | "canceled" | "delayed" | "failed" | "suspended" | "created", required)
  - `status_details` (string)
  - `payment` (object)
    - `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)
- `page` (integer<int32>, required)
- `limit` (integer<int32>, required)
- `total` (integer<int32>, required)

Example:

```json
{
  "subscriptions": [
    {
      "seller_id": "00000000-0000-0000-0000-000000000000",
      "order_id": "string",
      "installment_start_date": "2024-01-01",
      "create_date": "1970-01-01T00:00:00.000Z",
      "end_date": "1970-01-01T00:00:00.000Z",
      "payment_date": 0,
      "next_scheduled_date": "1970-01-01T00:00:00.000Z",
      "subscription": {
        "subscription_id": "00000000-0000-0000-0000-000000000000",
        "payment_type": {
          "credit": {
            "number_installments": 0,
            "billing_address": {
              "street": "Av. Brazil",
              "number": "1000",
              "complement": "Sala 1",
              "district": "Sao Geraldo",
              "city": "Porto Alegre",
              "state": "RS",
              "country": "Brazil",
              "postal_code": "90230060"
            },
            "soft_descriptor": "string",
            "transaction_type": "FULL",
            "tokenization": {
              "type": "UCAF",
              "cryptogram": null,
              "eci": null,
              "requestor_id": null
            },
            "card": {
              "brand": "Mastercard",
              "bin": null,
              "expiration_month": null,
              "expiration_year": null,
              "cardholder_name": null,
              "card_id": null
            },
            "wallet": {
              "type": null,
              "id": null
            }
          },
          "debit": {
            "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": null,
              "authorization_code": null,
              "authorization_timestamp": null,
              "reason_code": null,
              "reason_message": null,
              "acquirer": null,
              "soft_descriptor": null,
              "brand": "Mastercard",
              "terminal_nsu": null,
              "acquirer_transaction_id": null,
              "transaction_id": null
            },
            "debit": {
              "delayed": null,
              "authorization_code": null,
              "authorization_timestamp": null,
              "reason_code": null,
              "reason_message": null,
              "acquirer": null,
              "soft_descriptor": null,
              "brand": "Mastercard",
              "terminal_nsu": null,
              "acquirer_transaction_id": null,
              "transaction_id": null
            },
            "error": {
              "status_code": null,
              "name": null,
              "message": null,
              "details": null
            }
          }
        },
        "shippings": [
          {
            "first_name": "string",
            "last_name": "string",
            "email": "string",
            "phone_number": "string",
            "shipping_amount": 0,
            "address": {
              "street": "Av. Brazil",
              "number": "1000",
              "complement": "Sala 1",
              "district": "Sao Geraldo",
              "city": "Porto Alegre",
              "state": "RS",
              "country": "Brazil",
              "postal_code": "90230060"
            }
          }
        ]
      },
      "customer": {
        "customer_id": "string",
        "first_name": "string",
        "last_name": "string",
        "document_type": "CPF",
        "document_type_name": "string",
        "document_number": "string",
        "document_country": "string",
        "phone_number": "string",
        "celphone_number": "string",
        "email": "string",
        "status": "active"
      },
      "plan": {
        "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28",
        "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd",
        "name": "Plano flex",
        "description": "Flex plan",
        "amount": 19990,
        "currency": "BRL",
        "payment_types": "",
        "sales_tax": 0,
        "product_type": "service",
        "create_date": "2017-04-19T16:30:30Z",
        "status": "active",
        "period": {
          "type": "monthly",
          "billing_cycle": 12,
          "specific_cycle_in_days": 0
        },
        "floating_data": [
          {
            "installment": 2,
            "amount": 19990
          }
        ]
      },
      "device": {
        "ip_address": "string",
        "device_id": "string"
      },
      "floating_data": [
        {
          "installment": 2,
          "new_amount": 19990,
          "new_scheduled_date": "2020-06-10",
          "original_scheduled_date": "2020-06-10",
          "original_amount": 19990
        }
      ],
      "status": "processing",
      "status_details": "string",
      "payment": {
        "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": null,
              "description": null,
              "description_detail": null,
              "error_code": null,
              "payment_id": null,
              "status": null,
              "terminal_nsu": null
            }
          ]
        }
      }
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0
}
```

### 400

Invalid Requisition

- `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"
}
```

### 404

Not Found

- `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"
}
```

### 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 or service error

- `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"
}
```