# Create Subscription
**POST** `/rpy/be-subscription/v1/subscriptions`
Base URL: `https://api.pre.globalgetnet.com`
__Register a New Subscription__
based on a predefined plan. It’s used to enroll a customer into a recurring payment schedule.
**Usage Scenarios:**
_- Starting a new subscription for digital services, memberships, etc.
- Associating a buyer to a specific plan with automated recurring billing.
- Setting a custom start date for the subscription to control billing cycles._
**Notes:**
_- Requires a valid_ `plan_id` _from an existing recurrence plan.
- The_ `installment_start_date` _determines when the subscription begins billing. Until then, it remains in a Scheduled state.
- The_ `subscription` _object must include the chosen_ `payment_type` _(e.g.,_ `credit`_), and optionally billing address and installment info.
-_ `debit` _is not allowed in Brazil._
## Authorization
- PROD (oauth2)
- PRE (oauth2)
- SBX (oauth2)
## Header parameters
- `username` (string)
User who is registering. This information can be used for audit purposes.
## Body
Content type: `application/json`
- `seller_id` (string, required)
ECommerce identification code
- `customer_id` (string, required)
Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification.
- `plan_id` (string, required)
Recurrence plan identifier.
- `order_id` (string)
Purchase identification code used by e-commerce (code or order number).
- `installment_start_date` (string)
Subscription billing start date. Until that date, the Subscription will remain Scheduled, that is, with the status created. The use of this field and its expected purpose will depend on enabling a specific product on Getnet.
- `subscription` (object)
- `payment_type` (object)
- `credit` (object)
- `transaction_type` ("FULL", required)
Transaction type. Recurrence plans support only full payment.
- `billing_address` (any)
Set of data referring to the buyer's address
- `soft_descriptor` (string)
- `card` (object, required)
- `brand` ("Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro")
- `number_token` (string, required)
- `bin` (string, required)
First 6 digits of the card.
- `expiration_month` (string)
Two-digit card expiry month.
Optional for Argentina (ARG).
- `expiration_year` (string)
Two-digit card expiry year.
Optional for Argentina (ARG).
- `cardholder_name` (string)
- `card_id` (string)
- `security_code` (string)
Card security code (CVV), with 3 or 4 digits.
Optional for Argentina (ARG).
- `last_four_digits` (string)
- `wallet` (object)
- `type` (string, required)
- `id` (string, required)
- `tokenization` (object)
- `type` ("UCAF" | "TAVV" | "ELO", required)
- `cryptogram` (string)
- `eci` (string)
- `requestor_id` (string)
- `number_installments` (integer, required)
- `debit` (object)
- `transaction_type` ("FULL", required)
Transaction type. Recurrence plans support only full payment.
- `billing_address` (any)
Set of data referring to the buyer's address
- `soft_descriptor` (string)
- `card` (object, required)
- `brand` ("Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro")
- `number_token` (string, required)
- `bin` (string, required)
First 6 digits of the card.
- `expiration_month` (string)
Two-digit card expiry month.
Optional for Argentina (ARG).
- `expiration_year` (string)
Two-digit card expiry year.
Optional for Argentina (ARG).
- `cardholder_name` (string)
- `card_id` (string)
- `security_code` (string)
Card security code (CVV), with 3 or 4 digits.
Optional for Argentina (ARG).
- `last_four_digits` (string)
- `wallet` (object)
- `type` (string, required)
- `id` (string, required)
- `tokenization` (object)
- `type` ("UCAF" | "TAVV" | "ELO", required)
- `cryptogram` (string)
- `eci` (string)
- `requestor_id` (string)
- `shippings` (object[])
- `first_name` (string)
- `last_name` (string)
- `email` (string)
- `phone_number` (string)
- `shipping_amount` (integer)
- `address` (any)
Set of data referring to the buyer's address
- `device` (object)
- `ip_address` (string)
- `device_id` (string)
Example:
```json
{
"seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
"customer_id": "string",
"plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd",
"order_id": "ORDER-10187383",
"installment_start_date": "2020-09-14",
"subscription": {
"payment_type": {
"credit": {
"transaction_type": "FULL",
"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",
"card": {
"brand": "Mastercard",
"number_token": "string",
"bin": "string",
"expiration_month": "string",
"expiration_year": "string",
"cardholder_name": "string",
"card_id": "string",
"security_code": "string",
"last_four_digits": "string"
},
"wallet": {
"type": "string",
"id": "string"
},
"tokenization": {
"type": "UCAF",
"cryptogram": "string",
"eci": "string",
"requestor_id": "string"
},
"number_installments": 0
},
"debit": {
"transaction_type": "FULL",
"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",
"card": {
"brand": "Mastercard",
"number_token": "string",
"bin": "string",
"expiration_month": "string",
"expiration_year": "string",
"cardholder_name": "string",
"card_id": "string",
"security_code": "string",
"last_four_digits": "string"
},
"wallet": {
"type": "string",
"id": "string"
},
"tokenization": {
"type": "UCAF",
"cryptogram": "string",
"eci": "string",
"requestor_id": "string"
}
}
},
"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"
}
}
]
},
"device": {
"ip_address": "string",
"device_id": "string"
}
}
```
## Responses
### 201
Request made successfully
- `seller_id` (string, required)
- `order_id` (string, required)
- `installment_start_date` (string)
- `create_date` (string, required)
- `end_date` (string)
- `payment_date` (integer, required)
- `next_scheduled_date` (string)
- `subscription` (object)
- `subscription_id` (string, required)
- `payment_type` (object)
- `credit` (object)
- `number_installments` (integer)
- `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)
- `order_id` (string)
- `payment_id` (string)
- `amount` (integer)
- `currency` (string)
- `status` ("pending" | "canceled" | "approved" | "denied" | "authorized" | "confirmed" | "expired" | "unprocessed")
- `payment_received_timestamp` (string)
- `credit` (object)
- `delayed` (boolean)
- `authorization_code` (string, required)
- `authorization_timestamp` (string)
- `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)
- `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)
- `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)
- `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)
E-commerce identification code.
- `plan_id` (string)
Plan identifier.
- `name` (string)
Plan name.
- `description` (string)
Description of the plan.
- `amount` (integer)
Plan value.
- `currency` (string)
Currency identification (See code in this 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)
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, 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, required)
Number of the installment to which the change will be applied.
- `new_amount` (integer)
New charge amount.
- `new_scheduled_date` (string)
New billing date
- `original_scheduled_date` (string)
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)
- `order_id` (string)
- `payment_id` (string)
- `amount` (integer)
- `currency` (string)
- `status` ("pending" | "canceled" | "approved" | "denied" | "authorized" | "confirmed" | "expired" | "unprocessed")
- `payment_received_timestamp` (string)
- `credit` (object)
- `delayed` (boolean)
- `authorization_code` (string, required)
- `authorization_timestamp` (string)
- `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)
- `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)
- `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",
"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": "string",
"eci": "string",
"requestor_id": "string"
},
"card": {
"brand": "Mastercard",
"bin": "string",
"expiration_month": "string",
"expiration_year": "string",
"cardholder_name": "string",
"card_id": "string"
},
"wallet": {
"type": "string",
"id": "string"
}
},
"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": 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
}
]
}
}
},
"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": "string",
"description": "string",
"description_detail": "string",
"error_code": "string",
"payment_id": "string",
"status": "string",
"terminal_nsu": "string"
}
]
}
}
}
```
### 400
Invalid Requisition
- `message` (string)
Detailed error message.
- `name` (string)
Name of the module or system in which the error occurred.
- `status_code` (integer)
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)
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)
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)
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"
}
```