---
name: payments-gateway-api
description: "Payments Gateway API skill. Use when working with Payments Gateway for api. Covers 25 endpoints."
version: 1.0.0
generator: lapsh
---

# Payments Gateway API
API version: 1.0

## Auth
ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header

## Base URL
https://apiexamples.vtexpayments.com.br

## Setup
1. Set your API key in the appropriate header
2. GET /api/pvt/installments -- verify access
3. POST /api/pvt/affiliations -- create first affiliations

## Endpoints

25 endpoints across 1 groups. See references/api-spec.lap for full details.

### api
| Method | Path | Description |
|--------|------|-------------|
| GET | /api/pvt/installments | Get installments options |
| GET | /api/pvt/affiliations | List all affiliations |
| POST | /api/pvt/affiliations | Insert new affiliation |
| PUT | /api/pvt/affiliations/{affiliationId} | Update affiliation by ID |
| GET | /api/pvt/affiliations/{affiliationId} | Get affiliation by ID |
| GET | /api/pvt/rules | List all payment rules |
| POST | /api/pvt/rules | Insert a new payment rule |
| GET | /api/pvt/rules/{ruleId} | Get payment rule by ID |
| PUT | /api/pvt/rules/{ruleId} | Update payment rule by ID |
| DELETE | /api/pvt/rules/{ruleId} | Delete payment rule by ID |
| GET | /api/pvt/merchants/payment-systems | List all available payment methods |
| GET | /api/payments/pvt/account/{cardId} | Get card data |
| POST | /api/pvt/transactions | Start a new transaction |
| POST | /api/payments/transactions/{transactionId}/payments | Send payments information |
| POST | /api/pvt/transactions/{transactionId}/additional-data | Send additional data |
| PATCH | /api/pvt/transactions/{transactionId}/additional-data | Update additional data |
| POST | /api/pvt/transactions/{transactionId}/authorization-request | Authorize new transaction |
| GET | /api/pvt/transactions/{transactionId} | Get transaction details |
| GET | /api/pvt/transactions/{transactionId}/payments/{paymentId} | Get payment details |
| GET | /api/pvt/transactions/{transactionId}/settlements | Get transaction settlement details |
| POST | /api/pvt/transactions/{transactionId}/settlement-request | Settle the transaction |
| POST | /api/pvt/transactions/{transactionId}/refunding-request | Refund the transaction |
| POST | /api/pvt/transactions/{transactionId}/cancellation-request | Cancel the transaction |
| GET | /api/payments/pvt/payments/{paymentId}/payment-notification | Send payment notification with payment ID |
| POST | /api/payments/pvt/payments/{paymentId}/payment-notification | Send payment notification with payment ID, date, and value paid |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all installments?" -> GET /api/pvt/installments
- "List all affiliations?" -> GET /api/pvt/affiliations
- "Create a affiliation?" -> POST /api/pvt/affiliations
- "Update a affiliation?" -> PUT /api/pvt/affiliations/{affiliationId}
- "Get affiliation details?" -> GET /api/pvt/affiliations/{affiliationId}
- "List all rules?" -> GET /api/pvt/rules
- "Create a rule?" -> POST /api/pvt/rules
- "Get rule details?" -> GET /api/pvt/rules/{ruleId}
- "Update a rule?" -> PUT /api/pvt/rules/{ruleId}
- "Delete a rule?" -> DELETE /api/pvt/rules/{ruleId}
- "List all payment-systems?" -> GET /api/pvt/merchants/payment-systems
- "Get account details?" -> GET /api/payments/pvt/account/{cardId}
- "Create a transaction?" -> POST /api/pvt/transactions
- "Create a payment?" -> POST /api/payments/transactions/{transactionId}/payments
- "Create a additional-data?" -> POST /api/pvt/transactions/{transactionId}/additional-data
- "Create a authorization-request?" -> POST /api/pvt/transactions/{transactionId}/authorization-request
- "Get transaction details?" -> GET /api/pvt/transactions/{transactionId}
- "Get payment details?" -> GET /api/pvt/transactions/{transactionId}/payments/{paymentId}
- "List all settlements?" -> GET /api/pvt/transactions/{transactionId}/settlements
- "Create a settlement-request?" -> POST /api/pvt/transactions/{transactionId}/settlement-request
- "Create a refunding-request?" -> POST /api/pvt/transactions/{transactionId}/refunding-request
- "Create a cancellation-request?" -> POST /api/pvt/transactions/{transactionId}/cancellation-request
- "List all payment-notification?" -> GET /api/payments/pvt/payments/{paymentId}/payment-notification
- "Create a payment-notification?" -> POST /api/payments/pvt/payments/{paymentId}/payment-notification
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get payments-gateway-api -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search payments-gateway-api
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)