canonical: https://jentic.com/apis/globalgetnet.com/globalgetnet

# Globalgetnet Regional API GetNet

GetNet's Regional API is a Latin America-focused payment processing platform that lets merchants accept credit, debit, and bank-card transactions in their virtual stores. Beyond simple authorisations, it covers the full transaction lifecycle - capture, adjustment, cancellation, refund, query, tokenisation, recurring subscriptions, installments, boleto and PIX (Brazilian instant payment), QR codes, cross-border quotes, and 3D Secure authentication. Three environments (production, pre-production, and sandbox) are exposed under different OAuth scopes so integrations can be tested before going live.

## For AI agents

Authorise, capture, refund, and tokenise card payments, generate boleto and PIX, and run 3D Secure flows for Latin American merchants on GetNet.

## Scope

Does not handle accounting, payroll, or KYC onboarding - use for card, PIX, boleto, tokenisation, and 3D Secure payment processing only.

## Capabilities

- Authorise a card payment via POST `/dpm/payments-gwproxy/v2/payments` and capture it later
- Generate a Brazilian boleto invoice or PIX QR code for asynchronous bank payment
- Run a 3D Secure authentication flow via the enrolments and validations endpoints
- Tokenise a card with POST `/dpm/cofre-gw-proxy/v1/tokens/card` so subsequent charges avoid raw PAN handling
- Quote and validate cross-border transactions before authorising them
- Cancel or refund an authorised transaction and adjust amounts post-authorisation

## Use cases

### Brazilian E-Commerce Checkout

Brazilian merchants need to accept card, boleto, and PIX in a single checkout. The Regional API exposes one authorise endpoint for cards (`/dpm/payments-gwproxy/v2/payments`), a boleto endpoint (`/dpm/payments-gwproxy/v2/payments/boleto`), and a PIX endpoint (`/dpm/payments-gwproxy/v2/payments/qrcode/pix`), so a checkout page can offer all three with a few hours of integration work plus 3D Secure for cards over a risk threshold.

Example prompt: POST `/dpm/payments-gwproxy/v2/payments/qrcode/pix` with amount=R$199.90 and the buyer's CPF, then return the QR code payload to the checkout UI.

### Subscription Billing With Tokenised Cards

SaaS and content businesses can run recurring billing without storing card numbers by tokenising the card once via `/dpm/cofre-gw-proxy/v1/tokens/card` and then charging the token on a schedule via the standard authorise+capture flow. Combined with the cancel and refund endpoints, this covers the full dunning and chargeback path. Implementation typically takes a few days end-to-end.

Example prompt: POST `/dpm/cofre-gw-proxy/v1/tokens/card` with the card number, store the returned token, then POST `/dpm/payments-gwproxy/v2/payments` referencing that token at each billing cycle.

### High-Value Card Transaction with 3D Secure

Merchants reducing chargeback risk on high-value card transactions can run a 3D Secure flow before authorising: initialise via `/dpm/security-gwproxy/v2/enrolments-initial`, complete the bank login challenge via `/dpm/security-gwproxy/v2/enrolments-continue`, validate via `/dpm/security-gwproxy/v2/validations`, then authorise with the resulting authentication payload. The API supports a frictionless or challenged path depending on the issuer's risk decision.

Example prompt: Run the three `/dpm/security-gwproxy/v2` calls in order to obtain the 3DS payload, then POST `/dpm/payments-gwproxy/v2/payments` including it for liability shift.

### AI Agent Refund Handling

An AI assistant given GetNet through Jentic can resolve simple support tickets by looking up a transaction with `/dpm/hub-payment-info/v1/payments/info/{payment_id}` and issuing a cancel or refund through the corresponding endpoint, all with bounded scope and audit logging supplied by Jentic.

Example prompt: Search Jentic for 'getnet refund', load the schema, fetch the payment with `/dpm/hub-payment-info/v1/payments/info/{payment_id}`, then POST `/dpm/payments-gwproxy/v2/payments/cancel.`

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/dpm/payments-gwproxy/v2/payments` | Authorise a card payment |
| POST | `/dpm/payments-gwproxy/v2/payments/capture` | Capture an authorised payment |
| POST | `/dpm/payments-gwproxy/v2/payments/cancel` | Cancel or refund a payment |
| POST | `/dpm/payments-gwproxy/v2/payments/qrcode/pix` | Generate a PIX QR code |
| POST | `/dpm/payments-gwproxy/v2/payments/boleto` | Generate a boleto invoice |
| POST | `/dpm/cofre-gw-proxy/v1/tokens/card` | Tokenise a card |
| GET | `/dpm/hub-payment-info/v1/payments/info/{payment_id}` | Get a transaction by ID |

## Key resources

- **Payments** — Authorise, capture, adjust, cancel, and refund card payments.
- **Alternative Methods** — PIX QR codes and boleto invoices for Brazilian bank-rail payments.
- **3D Secure** — Three-step enrolment and validation flow for card authentication.
- **Tokenisation** — Generate and use card tokens to avoid handling raw PANs.
- **Cross-Border** — Quote and validate multi-currency transactions before authorising.
- **Authentication** — OAuth 2.0 client-credential token issuance for prod, pre, and sandbox.

## Why Jentic

- **Setup:** Wiring the Regional API GetNet by hand means running its OAuth2 client-credentials flow alongside basic auth, choosing the right sandbox, pre-production, or production host, and mapping its 57-endpoint surface yourself. Through Jentic you install once, import the Regional API GetNet from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** GetNet takes the payment target in the request body and returns a payment id in the path, so scope the agent to the operations it needs, such as creating a PIX or boleto payment and reading its info. You choose that operation set, so sensitive ones like capture, cancel, or card tokenisation are not included unless you add them.
- **Credential handling:** Your GetNet OAuth client id, secret, and basic-auth credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'process a PIX payment' or 'read a GetNet transaction', and Jentic returns the matching GetNet operation with its input schema so the agent calls the right endpoint without parsing the full spec.

## Related APIs

- **Stripe API** — Global card processor versus GetNet's Latin America-first PIX and boleto coverage.
- **Adyen Checkout API** — Global gateway with strong LATAM coverage and unified checkout.
- **Cielo API** — Major Brazilian acquirer with similar card, boleto, and PIX coverage.

## FAQ

### What authentication does the GetNet Regional API use?

GetNet uses OAuth 2.0 client credentials with separate scopes for production, pre-production, and sandbox, plus HTTP basic auth for the token endpoint. Exchange your client ID and secret at `/authentication/oauth2/access_token` and use the returned bearer token. Through Jentic the credentials sit in the vault and are injected per call.

### Can the GetNet API process PIX payments?

Yes. POST `/dpm/payments-gwproxy/v2/payments/qrcode/pix` returns the PIX QR code and copy-paste payload. The transaction settles via the Brazilian instant payment rail and can be queried by payment_id once the buyer scans.

### What are the rate limits for the GetNet Regional API?

GetNet does not publish a fixed per-endpoint limit in this OpenAPI spec; limits are negotiated as part of merchant onboarding. Implement idempotency keys (the API exposes `/payments/info/{payment_id}/{idempotency_key}`) and exponential backoff on 429 responses.

### How do I tokenise a card through Jentic so my agent never sees the PAN?

Search Jentic for 'tokenise card getnet', load the schema for POST `/dpm/cofre-gw-proxy/v1/tokens/card`, and submit the card details once. Subsequent charges through Jentic reference the returned token, so the raw PAN never re-enters agent context.

### Can I run cross-border transactions on GetNet?

Yes. POST `/dpm/payments-gwproxy/v1/crossborder/quote` returns an FX quote and POST `/dpm/payments-gwproxy/v2/crossborder/validate-customer` validates the buyer before you authorise the cross-border payment via the standard /payments endpoint.

### How do I refund or cancel a GetNet transaction?

POST `/dpm/payments-gwproxy/v2/payments/cancel` for a single cancellation, or POST `/dpm/payments-gwproxy/v2/payments/combined/cancel` for a combined transaction. The same lookup endpoint `/dpm/hub-payment-info/v1/payments/info/{payment_id}` confirms the resulting status.

### Can I limit what my agent is allowed to do with the GetNet Regional API?

Yes. Because you run Jentic One yourself, you decide which GetNet operations your agent may call, and your own rules govern the set. You can allow only the operations the agent needs, such as creating a PIX or boleto payment and reading its info by payment_id, while excluding sensitive ones like capture, cancel, refund, or card tokenisation unless you explicitly add them. The OAuth client and basic-auth credentials are injected at execution time and never enter the agent's prompt or context.