Getnet

https://docs.globalgetnet.com/en/
Admin
Getnet is a global payment solutions provider offering APIs and tools for e-commerce, in-store...
Tokens:178,165
Snippets:961
Trust Score:6.9
Update:21 hours ago
Show doc for...
Tokens:
Raw
### Verify Payment with Get Transaction Endpoint

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=quickstart-guide

Use the Get Transaction endpoint with the payment_id from the response to check the transaction status. Replace <PAYMENT_ID> and <ACCESS_TOKEN> with actual values. The endpoint returns the payment status.

```bash
curl --request GET \
--url https://api-sbx.globalgetnet.com/dpm/hub-payment-info/v1/payments/info/<PAYMENT_ID> \
--header 'authorization: Bearer <ACCESS_TOKEN>'
```

--------------------------------

### Successful Card Present payment response with status APPROVED

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-quickstart-create-your-first-payment

Example JSON response returned after a successful payment. Contains payment_id, status APPROVED, amount, currency, authorization_code, and reason_message 'captured'.

```json
{ "payment_id": "6137278d-28a6-4293-9343-c73fbb2d9bda", "status": "APPROVED", "amount": 10000, "currency": "CLP", "authorization_code": "204050", "reason_message": "captured" }
```

--------------------------------

### Create a Payment with curl (POST /dpm/payments-gwproxy/v2/payments)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=quickstart-guide

Sends a single-step payment request that authorizes and captures funds. Replace <ACCESS_TOKEN> with the token from Step 1 and <UUID> with a unique idempotency key. The example uses a test card number; in Sandbox you can use various test cards to simulate different scenarios.

```bash
curl --request POST \
--url https://api-sbx.globalgetnet.com/dpm/payments-gwproxy/v2/payments \
--header 'authorization: Bearer <ACCESS_TOKEN>' \
--header 'content-type: application/json' \
--header 'x-transaction-channel-entry: XX' \
--data '{
  "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb9",
  "order_id": "ORDER-QUICKSTART-001",
  "data": {
    "amount": 10000,
    "currency": "BRL",
    "payment": {
      "payment_method": "CREDIT",
      "transaction_type": "FULL",
      "number_installments": 1,
      "card": {
        "number": "5155901222260000",
        "expiration_month": "12",
        "expiration_year": "30",
        "cardholder_name": "JOHN TEST",
        "security_code": "123"
      }
    },
    "customer": {
      "email": "customer@example.com"
    }
  }
}'
```

--------------------------------

### Complete React integration with loader script and config

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=quickstart-create-a-payment-wbc

Final React code that dynamically creates the loader script, sets the paymentIntentId and checkoutType, and initializes the loader. This is the full example for React integration.

```javascript
useEffect(() => {
  const script = document.createElement("script");
  script.src = "${host_getnet_web}/digital-checkout/loader.js";
  script.async = true;
  script.setAttribute("data-testid", "digital-checkout");
  script.setAttribute("id", "digital-checkout");
  document.body.appendChild(script);
  const config = {
    paymentIntentId: ${payment_intent_id},
    checkoutType: "lightbox"
  };
  window.loader.init(config);
}, []);
```

--------------------------------

### Get Access Token with cURL

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-quickstart-create-your-first-payment

Authenticate with the Sandbox API by sending a POST request to the /authentication/oauth2/access_token endpoint. Use Basic authentication with a Base64-encoded client_id:client_secret and the client_credentials grant type. The response includes an access_token that expires in approximately one hour.

```bash
curl --request POST \
--url https://api-sbx.pre.globalgetnet.com/authentication/oauth2/access_token \
--header 'authorization: Basic <BASE64(client_id:client_secret)>' \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=client_credentials
```

--------------------------------

### PUT business-configurations request with payment methods and installments

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=configuration-by-api-wbc

Configures Web Checkout payment methods and installment options via a PUT request to the business-configurations endpoint. Requires a valid business configuration ID and a secret token. The example enables instant payment, bankslip, QR Code (Argentina only), and other methods, with credit card brands and installment plans.

```bash
curl https://api.globalgetnet.com/dpy/web-checkout/v1/business-configurations/672c0dd1-28b1-4136-b230-de68c1b92ae0 \
 --request PUT \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
 --data '{ "instant_payment": { "enable": true }, "bankslip": { "enable": true }, "qr_code_checkout": { "enabled": true }, "mbway": { "enabled": true }, "multibanco": { "enabled": true }, "daviplata": { "enabled": true }, "efecty": { "enabled": true }, "pse": { "enabled": true }, "nequi": { "enabled": true }, "credit": { "enable": true, "brands": [ { "enable": true, "brand": "VISA", "currencies": [ "BRL" ], "threeds": true, "suported_installments": [ { "schema_name": "with_interest", "installments": [ 1, 2, 3 ], "installments_with_interest": [ 2, 3 ] } ] } ] }, "debit": { "enable": true, "brands": [ { "enable": true, "brand": "VISA", "currencies": [ "BRL" ], "threeds": true }, { "enable": true, "brand": "MASTER", "currencies": [ "BRL" ], "threeds": true } ] } }'
```

--------------------------------

### Quote Response Example (Chile)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-regional-requirements-for-card-present

Example response from the quotes endpoint for Chile. Shows a `plan_emisor` schema with `no_interest` type, 2 installments, and installment amount of 5000.

```json
{ "amount": 10000, "options": [ { "quote_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e", "schema": "plan_emisor", "type": "no_interest", "number": 2, "installment_amount": "5000", "total_amount": "10000" } ] }
```

--------------------------------

### Quote Response Example (Argentina)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-regional-requirements-for-card-present

Example response from the quotes endpoint for Argentina. Shows a `plan_ahora` schema with `no_interest` type, 2 installments, and installment amount of 5000.

```json
{ "amount": 10000, "options": [ { "quote_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e", "schema": "plan_ahora", "type": "no_interest", "number": 2, "installment_amount": "5000", "total_amount": "10000" } ] }
```

--------------------------------

### POST /payment-links/business-configurations with credit, debit, bankslip, and instant payment

Source: https://docs.globalgetnet.com/en/products/online-payments/payment-link-api?doc=plk-configure-the-payment-link

Configures payment methods and installment plans for a payment link. The request enables credit (VISA with installment plan 'plan_lojista'), debit (VISA), bankslip, and instant payment, while disabling Google Pay and Apple Pay. The 'supported_installments' field defines installment counts and interest-bearing installments; if null or absent, the buyer pays in full.

```bash
curl https://api-sbx.pre.globalgetnet.com/dpy/payment-link/v1/payment-links/business-configurations \
 --request POST \
 --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \
 --header 'Content-Type: application/json' \
 --data '{ "expiration": "2026-12-31T23:59:59", "max_orders": 100, "request_delivery_address": false, "payment": { "credit": { "enabled": true, "brands": [ { "enabled": true, "brand": "VISA", "currencies": [ "BRL" ], "threeds": true, "supported_installments": [ { "schema": "plan_lojista", "schema_name": "Plan Lojista", "installments": [2,3,4,5,6,7,8,9,10,11,12], "installments_with_interest": [6,9,12] } ] } ] }, "debit": { "enabled": true, "brands": [ { "enabled": true, "brand": "VISA", "currencies": [ "BRL" ], "threeds": true } ] }, "bankslip": { "enabled": true }, "instant_payment": { "enabled": true }, "google_pay": { "enabled": false }, "apple_pay": { "enabled": false }, "currency": "BRL" }'
```

--------------------------------

### Authorization Response Example

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=create-pre-authorized-payment

Example JSON response from the authorization step, showing status AUTHORIZED and fields like payment_id, idempotency_key, and authorization_code.

```json
{ "idempotency_key": "13c7f8ee-51a6-470d-bb76-ef762b62bfb7", "seller_id": "54f88e68-7764-4e87-8830-756b1e2c02f8", "payment_id": "d36887d0-53ec-4c36-b731-9bbeca18fcd2", "order_id": "123order2", "amount": 118708, "currency": "CLP", "status": "AUTHORIZED", "payment_method": "CREDIT_PRE_AUTHORIZATION", "received_at": "2025-08-12T20:46:26.713Z", "transaction_id": "MCC30105G5020", "original_transaction_id": "MCC30105G5020", "authorized_at": "2025-08-12T20:46:26.713Z", "reason_code": "00", "reason_message": "authorized", "acquirer": "GETNET", "soft_descriptor": "LOJA*TESTE*COMPRA-123", "brand": "MASTERCARD", "authorization_code": "604020", "acquirer_transaction_id": "204050301040206020503010" }
```

--------------------------------

### Basic Auth Header Example

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=webhooks-reference

Example of the Authorization header Getnet includes when using user credentials authentication.

```text
Authorization: Basic {base64_encoded_user:password}
```

--------------------------------

### Bearer Token Header Example

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=webhooks-reference

Example of the Authorization header Getnet includes when using token authentication.

```text
Authorization: Bearer {token}
```

--------------------------------

### Capture Payment Response Example

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=create-pre-authorized-payment

Example JSON response from the capture endpoint. A successful capture returns HTTP 200 OK and status CAPTURED.

```json
{ "seller_id": "54f88e68-7764-4e87-8830-756b1e2c02f8", "payment_id": "d36887d0-53ec-4c36-b731-9bbeca18fcd2", "idempotency_key": "13c7f8ee-51a6-470d-bb76-ef762b62bfb7", "order_id": "123order2", "amount": 118708, "currency": "CLP", "status": "CAPTURED", "reason_code": "00", "reason_message": "captured", "captured_at": "2025-08-12T20:47:52.166Z" }
```

--------------------------------

### List orders for a link - Example response (JSON)

Source: https://docs.globalgetnet.com/en/products/online-payments/payment-link-api?doc=plk-how-to-retrieve-and-list-payment-orders

Example response for listing orders. It returns an array of order objects with fields like order_id, link_id, currency, amount, reference_code, checkout_id, customer, shipping, status, created_at, and updated_at. The example shows two orders with statuses 'paid' and 'pending'.

```json
[
  {
    "order_id": "b1c2d3e4-5678-9abc-def0-111213141516",
    "link_id": "76c3caa9-4c5b-243b-8fc5-a73381fcdf9b",
    "currency": "BRL",
    "amount": 9990,
    "reference_code": "BF2026-001",
    "checkout_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "customer": {
      "first_name": "João",
      "last_name": "Silva",
      "email": "joao.silva@email.com"
    },
    "shipping": null,
    "status": "paid",
    "created_at": "2026-06-10T14:00:00.000Z",
    "updated_at": "2026-06-10T14:02:30.000Z"
  },
  {
    "order_id": "a2b3c4d5-6789-0abc-def1-212223242526",
    "link_id": "76c3caa9-4c5b-243b-8fc5-a73381fcdf9b",
    "currency": "BRL",
    "amount": 9990,
    "reference_code": "BF2026-002",
    "checkout_id": "e38bd20a-47bb-4361-b456-1d13a2b3c468",
    "customer": {
      "first_name": "Maria",
      "last_name": "Santos",
      "email": "maria.santos@email.com"
    },
    "shipping": null,
    "status": "pending",
    "created_at": "2026-06-10T15:30:00.000Z",
    "updated_at": "2026-06-10T15:30:00.000Z"
  }
]
```

--------------------------------

### List orders for a link - Example request (curl)

Source: https://docs.globalgetnet.com/en/products/online-payments/payment-link-api?doc=plk-how-to-retrieve-and-list-payment-orders

Use this curl command to list orders for a payment link. It requires an access token, the link_id, seller ID, country, and tenant. The example shows filtering by status ACTIVE and limiting to 10 items. Note: the endpoint in the command differs from the documented one; use as shown.

```bash
curl -X GET "${API_URL}/payment-links?status=ACTIVE&limit=10" \
 -H "Authorization: Bearer ${ACCESS_TOKEN}" \
 -H "x-seller-id: ${SELLER_ID}" \
 -H "country: BR" \
 -H "tenant: santander"
```

--------------------------------

### Installment Quote Request Example (Argentina)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-regional-requirements-for-card-present

Example request for installment quotes in Argentina. Uses `installment_type_filter` set to `no_interest` to filter for merchant-financed plans.

```json
{ "amount": 12000, "bin": "601070000", "installment_type_filter": "no_interest" }
```

--------------------------------

### Import Getnet loader script

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=quickstart-create-a-payment-wbc

Loads the Getnet Checkout application. Use the appropriate host for your environment: https://www.pre.globalgetnet.com for homologation or https://www.globalgetnet.com for production. Invoke after creating a payment intent.

```html
<script src="${host_getnet_web}/digital-checkout/loader.js" />
```

--------------------------------

### Configure checkout script with paymentIntentId and checkoutType

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=quickstart-create-a-payment-wbc

Connects the loader and user, selecting the integration option. Replace paymentIntentId with the payment_intent_id from the payment intent response and set checkoutType to 'lightbox' or 'iframe'.

```javascript
<script>
const config = {
  "paymentIntentId": ${payment_intent_id},
  "checkoutType": "lightbox"
};
const checkoutButton = () => {
  loader.init(config)
};
</script>
```

--------------------------------

### POST /dpm/payments-gwproxy/v2/payments

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-quickstart-create-your-first-payment

Creates a single-step Card Present payment that authorizes and captures funds in one operation. Requires Direct payment methods and includes terminal and card (Entry Mode/EMV) objects.

```APIDOC
## [POST] /dpm/payments-gwproxy/v2/payments

### Description
Creates a single-step Card Present payment that authorizes and captures funds in one operation. Requires Direct payment methods and includes terminal and card (Entry Mode/EMV) objects.

### Method
POST

### Endpoint
https://api-sbx.pre.globalgetnet.com/dpm/payments-gwproxy/v2/payments

### Parameters
#### Headers
- **authorization** (string) - Required - Bearer token for authentication.
- **content-type** (string) - Required - Must be application/json.
- **x-seller-id** (string) - Required - Your seller ID.
- **x-transaction-channel-entry** (string) - Required - Transaction channel entry code.

#### Request Body
- **idempotency_key** (string) - Required - Unique key for idempotency.
- **request_id** (string) - Required - Unique request identifier.
- **order_id** (string) - Required - Order identifier.
- **data** (object) - Required - Payment data object.
  - **amount** (integer) - Required - Amount in minor units.
  - **currency** (string) - Required - Currency code (e.g., CLP).
  - **payment** (object) - Required - Payment details.
    - **payment_id** (string) - Required - Unique payment identifier.
    - **payment_method** (string) - Required - Must be DIRECT_CREDIT.
    - **transaction_type** (string) - Required - Must be FULL.
    - **terminal** (object) - Required - Terminal information.
      - **terminal_number** (string) - Required - Terminal number.
      - **logical_code** (string) - Required - Logical code.
      - **serial_number** (string) - Required - Serial number.
    - **card** (object) - Required - Card information.
      - **entry_mode** (string) - Required - Entry mode (e.g., chip).
      - **cardholder_verification_method** (string) - Required - Verification method (e.g., online_pin).
      - **pin_block** (string) - Required - PIN block data.
      - **ksn** (string) - Required - Key serial number.
      - **emv** (string) - Required - EMV data.
      - **aid** (string) - Required - Application identifier.

### Request Example
```json
{
  "idempotency_key": "qs-cp-test-001",
  "request_id": "f0612285-9493-4c2c-a05a-00268a51ea3a",
  "order_id": "RETAIL-TEST-101",
  "data": {
    "amount": 10000,
    "currency": "CLP",
    "payment": {
      "payment_id": "your-unique-payment-id",
      "payment_method": "DIRECT_CREDIT",
      "transaction_type": "FULL",
      "terminal": {
        "terminal_number": "21000334",
        "logical_code": "21000334",
        "serial_number": "CS21000334A"
      },
      "card": {
        "entry_mode": "chip",
        "cardholder_verification_method": "online_pin",
        "pin_block": "A0B6BA8D53C8D3C3",
        "ksn": "BC756011020000400001",
        "emv": "9f2701809f3303e0f8c8950580000080009f37045d21705a9f100706010a03a0b8089f2608819ba36f3f7934149f360205b782021c009c01009f1a0204849a032002279f02060000000309605F2A0200325f3401019f34031e03009f120c56495341204352454449544f5f201a2f435249535449414E2047414C494E444F2043484156455A2020",
        "aid": "A0000000031010"
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **payment_id** (string) - Unique payment identifier.
- **status** (string) - Status of the payment (e.g., APPROVED).
- **amount** (integer) - Amount in minor units.
- **currency** (string) - Currency code.
- **authorization_code** (string) - Authorization code.
- **reason_message** (string) - Reason message (e.g., captured).

#### Response Example
```json
{
  "payment_id": "6137278d-28a6-4293-9343-c73fbb2d9bda",
  "status": "APPROVED",
  "amount": 10000,
  "currency": "CLP",
  "authorization_code": "204050",
  "reason_message": "captured"
}
```
```

--------------------------------

### 200 OK response for retrieving a specific order

Source: https://docs.globalgetnet.com/en/products/online-payments/payment-link-api?doc=plk-how-to-retrieve-and-list-payment-orders

Example JSON response returned by the GET /payment-links/{link_id}/orders/{order_id} endpoint. It includes order details such as amount, currency, customer, shipping, status, and history.

```json
{ "order_id": "b1c2d3e4-5678-9abc-def0-111213141516", "link_id": "76c3caa9-4c5b-243b-8fc5-a73381fcdf9b", "currency": "BRL", "amount": 9990, "reference_code": "BF2026-001", "checkout_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "customer": { "first_name": "João", "last_name": "Silva", "email": "joao.silva@email.com", "phone": "+5511999998888", "document_type": "CPF", "document_number": "12345678900" }, "shipping": { "first_name": "João", "last_name": "Silva", "email": "joao.silva@email.com", "phone": "+5511999998888", "address": { "street": "Rua Exemplo", "number": "100", "complement": "Apto 42", "district": "Centro", "city": "São Paulo", "state": "SP", "country": "BR", "postal_code": "01001000" } }, "status": "paid", "history": [ { "status": "pending", "created_at": "2026-06-10T14:00:00.000Z" }, { "status": "paid", "created_at": "2026-06-10T14:02:30.000Z" } ], "created_at": "2026-06-10T14:00:00.000Z", "updated_at": "2026-06-10T14:02:30.000Z" }
```

--------------------------------

### Curl request for Card Present payment with chip and online PIN

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-quickstart-create-your-first-payment

POST to /dpm/payments-gwproxy/v2/payments with DIRECT_CREDIT, FULL transaction type, terminal and card objects. Uses entry_mode 'chip' and cardholder_verification_method 'online_pin'. Requires access token, seller ID, and transaction channel entry header.

```bash
curl --request POST \
--url https://api-sbx.pre.globalgetnet.com/dpm/payments-gwproxy/v2/payments \
--header 'authorization: Bearer <ACCESS_TOKEN>' \
--header 'content-type: application/json' \
--header 'x-seller-id: <YOUR_SELLER_ID>' \
--header 'x-transaction-channel-entry: XX' \
--data '{ "idempotency_key": "qs-cp-test-001", "request_id": "f0612285-9493-4c2c-a05a-00268a51ea3a", "order_id": "RETAIL-TEST-101", "data": { "amount": 10000, "currency": "CLP", "payment": { "payment_id": "your-unique-payment-id", "payment_method": "DIRECT_CREDIT", "transaction_type": "FULL", "terminal": { "terminal_number": "21000334", "logical_code": "21000334", "serial_number": "CS21000334A" }, "card": { "entry_mode": "chip", "cardholder_verification_method": "online_pin", "pin_block": "A0B6BA8D53C8D3C3", "ksn": "BC756011020000400001", "emv": "9f2701809f3303e0f8c8950580000080009f37045d21705a9f100706010a03a0b8089f2608819ba36f3f7934149f360205b782021c009c01009f1a0204849a032002279f02060000000309605F2A0200325f3401019f34031e03009f120c56495341204352454449544f5f201a2f435249535449414E2047414C494E444F2043484156455A2020", "aid": "A0000000031010" } } } }'
```

--------------------------------

### POST /dpm/payments-gwproxy/v2/payments

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=quickstart-guide

Creates a single-step payment that authorizes and captures funds in one operation. This endpoint requires an access token and a unique idempotency key.

```APIDOC
## POST /dpm/payments-gwproxy/v2/payments

### Description
Creates a single-step payment that authorizes and captures the funds in one operation.

### Method
POST

### Endpoint
https://api-sbx.globalgetnet.com/dpm/payments-gwproxy/v2/payments

### Headers
- **authorization** (string) - Required - Bearer token obtained from Step 1
- **content-type** (string) - Required - application/json
- **x-transaction-channel-entry** (string) - Required - Transaction channel entry (e.g., 'XX')

### Request Body
- **idempotency_key** (string) - Required - Unique idempotency key (UUID)
- **order_id** (string) - Required - Order identifier
- **data** (object) - Required - Payment data
  - **amount** (integer) - Required - Amount in minor units
  - **currency** (string) - Required - Currency code (e.g., 'BRL')
  - **payment** (object) - Required - Payment details
    - **payment_method** (string) - Required - Payment method (e.g., 'CREDIT')
    - **transaction_type** (string) - Required - Transaction type (e.g., 'FULL')
    - **number_installments** (integer) - Required - Number of installments
    - **card** (object) - Required - Card details
      - **number** (string) - Required - Card number
      - **expiration_month** (string) - Required - Expiration month (MM)
      - **expiration_year** (string) - Required - Expiration year (YY)
      - **cardholder_name** (string) - Required - Cardholder name
      - **security_code** (string) - Required - Card security code
  - **customer** (object) - Required - Customer details
    - **email** (string) - Required - Customer email

### Request Example
```json
{
  "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb9",
  "order_id": "ORDER-QUICKSTART-001",
  "data": {
    "amount": 10000,
    "currency": "BRL",
    "payment": {
      "payment_method": "CREDIT",
      "transaction_type": "FULL",
      "number_installments": 1,
      "card": {
        "number": "5155901222260000",
        "expiration_month": "12",
        "expiration_year": "30",
        "cardholder_name": "JOHN TEST",
        "security_code": "123"
      }
    },
    "customer": {
      "email": "customer@example.com"
    }
  }
}
```

### Response
#### Success Response (200)
- **payment_id** (string) - Payment identifier
- **order_id** (string) - Order identifier
- **amount** (integer) - Amount in minor units
- **currency** (string) - Currency code
- **status** (string) - Payment status (e.g., 'APPROVED')
- **payment_method** (string) - Payment method used
- **received_at** (string) - Timestamp of payment receipt

#### Response Example
```json
{
  "payment_id": "053de7f9-3725-437b-bdfc-bbf3ed0acb75",
  "order_id": "ORDER-QUICKSTART-001",
  "amount": 10000,
  "currency": "BRL",
  "status": "APPROVED",
  "payment_method": "CREDIT",
  "received_at": "2025-01-15T10:30:00.000Z"
}
```
```

--------------------------------

### Access Token Response

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-quickstart-create-your-first-payment

Example JSON response from the access token request, containing the access_token, token_type, and expires_in fields. The token expires in 3599 seconds (approximately one hour).

```json
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJraWQiOiI1amhLMy9xK0ZpK0tTRkIrRUwwN3VhMFYwdGM9IiwiYWxnIjoiUlMyNTYifQ...",
  "token_type": "Bearer",
  "expires_in": 3599
}
```

--------------------------------

### POST /payment-intent

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=quickstart-create-a-payment-wbc

Creates a payment intent for a customer checkout. Requires an access token in the Authorization header and returns a payment intent ID and redirect URL.

```APIDOC
## [POST] /payment-intent

### Description
Creates a payment intent for a customer checkout. Requires an access token in the Authorization header and returns a payment intent ID and redirect URL.

### Method
POST

### Endpoint
/payment-intent

### Parameters
#### Request Body
- **payment.currency** (String) - Required - Currency code. Example: `BRL`
- **payment.amount** (Integer) - Required - Purchase amount in integer format, where the last 2 digits represent the cents. For countries where cents do not apply, fill in the amount with 2 zeros to the right. Example: `92500`
- **customer.customer_id** (String) - Required - Recommended to use the customer's document number. Use only letters and numbers, without special characters, separators, or spaces. Example: `12345678912`
- **customer.first_name** (String) - Required - Customer's first name. Example: `John`
- **customer.last_name** (String) - Required - Customer's last name. Example: `Doe Smith`
- **customer.name** (String) - Required - Customer's full name. Example: `John Doe Smith`
- **customer.email** (String) - Required - Customer's email address. Example: `customer@email.com.br`
- **customer.document_type** (String) - Required - Type of the document used to identify the customer. Check the Field Values table for accepted values. Example: `CPF`
- **customer.document_number** (String) - Required - Document number used to identify the customer. Example: `12345678912`
- **customer.billing_address.street** (String) - Required - Name of a street. Example: `Av. Brasil`
- **customer.billing_address.number** (String) - Required - Number that identifies the position of a building on a street. Example: `1000`
- **customer.billing_address.country** (String) - Required - Country code. Check the Field Values table for accepted values. Example: `BR`
- **customer.billing_address.postal_code** (String) - Required - Postal or ZIP code. Example: `90230060`
- **additional_data** (Object) - Optional - Additional data for regional regulations and tax requirements. Required for Uruguay.
- **additional_data.rates** (Array) - Optional - Tax rates applied to the transaction.
- **additional_data.rates.key** (String) - Optional - (Uruguay only) Type of tax or rate being applied. Example: `IVA`
- **additional_data.rates.value** (Number) - Optional - (Uruguay only) Tax amount in integer format (cents). Example: `123`
- **additional_data.regional_regulation_code** (String) - Optional - (Uruguay only) Regional fiscal or regulatory code required by local authorities. Used for SEP submissions in Uruguay. Example: `17934`
- **configurations** (Object) - Optional - Additional configurations for the payment intent.
- **configurations.3ds** (Boolean) - Optional - Controls 3D Secure authentication. Example: `true` or `false`
- **configurations.preauthorization** (Boolean) - Optional - Indicates if the payment is a pre-authorization. Example: `true` or `false`
- **configurations.card_verification** (Boolean) - Optional - Indicates if this is a card verification flow. Example: `true` or `false`
- **configurations.success_url** (String) - Optional - Redirect URL in case of successful payment. Example: `https://www.mystore.com/checkout/success`
- **configurations.error_url** (String) - Optional - Redirect URL in case of an error during payment. Example: `https://www.mystore.com/checkout/error`
- **expires_at** (String) - Optional - Payment intent expiration. Example: `3d4h15m`

### Response
#### Success Response (200)
- **payment_intent_id** (String) - The payment intent ID.
- **redirect_url** (String) - The redirect URL for the frontend.

#### Response Example
{
  "payment_intent_id": "string",
  "redirect_url": "string"
}
```

--------------------------------

### Add checkout button for JavaScript

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=quickstart-create-a-payment-wbc

HTML button that triggers the checkout script defined in the previous step. Place this in your web store's payment page.

```html
<button onclick="checkoutButton()"> Go to Payment </button>
```

--------------------------------

### Installment Quote Response (Chile)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-regional-requirements-for-card-present

Chile uses issuer-managed installment plans (plan_emisor). The quote response provides installment options with schema and type.

```APIDOC
## Installment Quote Response (Chile)

### Description
Chile uses issuer-managed installment plans (`plan_emisor`). The quote response provides installment options with schema and type.

### Response
#### Success Response
- **amount** (integer) - The amount.
- **options** (array) - List of installment options.
  - **quote_id** (string) - Unique identifier for the quote.
  - **schema** (string) - The installment schema, e.g., `plan_emisor`.
  - **type** (string) - The installment type, e.g., `no_interest` or `with_interest`.
  - **number** (integer) - Number of installments.
  - **installment_amount** (string) - Amount per installment.
  - **total_amount** (string) - Total amount to be paid.

#### Response Example
```json
{
  "amount": 10000,
  "options": [
    {
      "quote_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e",
      "schema": "plan_emisor",
      "type": "no_interest",
      "number": 2,
      "installment_amount": "5000",
      "total_amount": "10000"
    }
  ]
}
```
```

--------------------------------

### Create Plan Response JSON

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=recurring-payments-engine

Example response from the Create Plan endpoint. Contains the generated plan_id, seller_id, plan details, status 'active', and create_date. Save the plan_id for use when creating a subscription in Step 4.

```json
{ "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd", "seller_id": "54f88e68-7764-4e87-8830-756b1e2c02f8", "name": "Premium Monthly Plan", "description": "Monthly subscription for premium features", "amount": 9900, "currency": "BRL", "payment_types": "credit_card", "period": { "type": "monthly", "billing_cycle": 12 }, "product_type": "service", "status": "active", "create_date": "2025-11-06T10:35:00.000Z" }
```

--------------------------------

### Installment Quote Request (Argentina)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-regional-requirements-for-card-present

Request installment quotes for Argentina using the Plan Ahora program. The request includes amount, bin, and installment type filter.

```APIDOC
## Installment Quote Request (Argentina)

### Description
Request installment quotes for Argentina. The response provides installment options based on the Plan Ahora program.

### Request Body
- **amount** (integer) - Required - The amount to be financed.
- **bin** (string) - Required - The bank identification number (BIN) of the card.
- **installment_type_filter** (string) - Required - Filter for installment type, e.g., `no_interest`.

### Request Example
```json
{
  "amount": 12000,
  "bin": "601070000",
  "installment_type_filter": "no_interest"
}
```

### Response
#### Success Response
- **amount** (integer) - The amount.
- **options** (array) - List of installment options.
  - **quote_id** (string) - Unique identifier for the quote.
  - **schema** (string) - The installment schema, e.g., `plan_ahora`.
  - **type** (string) - The installment type, e.g., `no_interest`.
  - **number** (integer) - Number of installments.
  - **installment_amount** (string) - Amount per installment.
  - **total_amount** (string) - Total amount to be paid.

#### Response Example
```json
{
  "amount": 10000,
  "options": [
    {
      "quote_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e",
      "schema": "plan_ahora",
      "type": "no_interest",
      "number": 2,
      "installment_amount": "5000",
      "total_amount": "10000"
    }
  ]
}
```
```

--------------------------------

### Successful Payment Response (status APPROVED)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=quickstart-guide

Shows the JSON response returned after a successful payment, with status "APPROVED". The response includes payment_id, order_id, amount, currency, payment_method, and received_at.

```json
{
  "payment_id": "053de7f9-3725-437b-bdfc-bbf3ed0acb75",
  "order_id": "ORDER-QUICKSTART-001",
  "amount": 10000,
  "currency": "BRL",
  "status": "APPROVED",
  "payment_method": "CREDIT",
  "received_at": "2025-01-15T10:30:00.000Z"
}
```

--------------------------------

### Initialize Getnet loader in React with useEffect

Source: https://docs.globalgetnet.com/en/products/online-payments/web-checkout?doc=quickstart-create-a-payment-wbc

React hook that initializes the Getnet loader when the component mounts. Use this if you are integrating with React instead of plain JavaScript.

```javascript
useEffect(() => {
  ...
  window.loader.init(config);
}, []);
```

--------------------------------

### Create Subscription with curl (POST /rpy/be-subscription/v1/subscriptions)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=recurring-payments-engine

Sends a POST request to the Create Subscription endpoint with required fields: seller_id, customer_id, plan_id, installment_start_date, and subscription.payment_type.credit card details. The subscription remains in 'scheduled' status until installment_start_date. Use the sandbox URL https://api-sbx.globalgetnet.com/rpy/be-subscription/v1/subscriptions with a valid bearer token and x-seller-id header.

```bash
curl --request POST \
--url https://api-sbx.globalgetnet.com/rpy/be-subscription/v1/subscriptions \
--header 'authorization: Bearer <your-token>' \
--header 'content-type: application/json' \
--header 'x-seller-id: 54f88e68-7764-4e87-8830-756b1e2c02f8' \
--data '{
  "seller_id": "54f88e68-7764-4e87-8830-756b1e2c02f8",
  "customer_id": "customer-123",
  "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd",
  "installment_start_date": "2025-11-15",
  "subscription": {
    "payment_type": {
      "credit": {
        "transaction_type": "FULL",
        "card": {
          "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c",
          "cardholder_name": "John Doe",
          "security_code": "123",
          "brand": "MASTERCARD",
          "expiration_month": "12",
          "expiration_year": "30"
        },
        "number_installments": 1
      }
    }
  }
}'
```

--------------------------------

### Create Subscription Response (JSON)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=recurring-payments-engine

Example response from the Create Subscription endpoint. Shows the created subscription with order_id, status 'created', subscription_id, and plan details. The response includes the installment_start_date and next_scheduled_date.

```json
{
  "seller_id": "54f88e68-7764-4e87-8830-756b1e2c02f8",
  "order_id": "ORDER-10187383",
  "installment_start_date": "2025-11-15",
  "create_date": "2025-11-06T10:40:00.000Z",
  "payment_date": 15,
  "next_scheduled_date": "2025-11-15T00:00:00.000Z",
  "status": "created",
  "status_details": "Subscription Plan flex successfully created",
  "subscription": {
    "subscription_id": "5d740ea0-b7d1-42f5-ad64-5a5521e12345"
  },
  "customer": {
    "customer_id": "customer-123",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com"
  },
  "plan": {
    "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd",
    "name": "Premium Monthly Plan",
    "amount": 9900,
    "currency": "BRL"
  }
}
```

--------------------------------

### Mexico - Payment Request with transaction_type

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=cp-regional-requirements-for-card-present

Mexico does not support the dynamic installment quotes endpoint. Use the transaction_type field directly in the payment request to specify installment behavior.

```APIDOC
## Mexico - Payment Request with transaction_type

### Description
Mexico does not support the dynamic installment quotes endpoint. Use the `transaction_type` field directly in the payment request to specify installment behavior.

### Request Body
- **transaction_type** (string) - Required - Determines the installment behavior. Accepted values: `FULL`, `INSTALL_NO_INTEREST`, `INSTALL_WITH_INTEREST`.

### Accepted Values
- `FULL` - Single payment, no installments.
- `INSTALL_NO_INTEREST` - Merchant-financed installments (no interest for customer).
- `INSTALL_WITH_INTEREST` - Issuer-financed installments (customer pays interest).
```

--------------------------------

### Create Customer Response (JSON)

Source: https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=recurring-payments-engine

Example response from the Create Customer endpoint, showing the registered customer details including the generated created_at timestamp.

```json
{ "seller_id": "54f88e68-7764-4e87-8830-756b1e2c02f8", "customer_id": "customer-123", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "document_type": "CPF", "document_number": "12345678900", "phone_number": "+5511999999999", "created_at": "2025-11-06T10:30:00.000Z" }
```
Tokens:
Raw