Deletes a specific payment rule applied to the payment providers configured in your store.

Delete payment rule by ID

Sends a payment notification for an order based on the payment ID.

Send payment notification with payment ID

Returns all affiliations (payment and anti-fraud providers) that are already configured in your store.

List all affiliations

Returns data for a specific affiliation (payment or anti-fraud provider).

Get affiliation by ID

Returns the best installment options according to the parameters informed in the request.

Get installments options

Returns all payment methods (such as Visa, Master, among others) that can be used in your store.

List all available payment methods

Returns all payment rules applied to the payment providers configured in your store.

List all payment rules

Returns data for a specific payment rule applied to the payment providers configured in your store.

Get payment rule by ID

Returns data about a specific transaction made in your store.

Get transaction details

Returns data about a specific payment made in your store.

Get payment details

Returns settlement data associated with a specific transaction.

Get transaction settlement details

Use this request to update any information that has previously been sent on endpoint [3. Send additional data](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/additional-data).

3.1 Update additional data (optional)

Sends a payment notification for an order using the payment ID, including the payment date and the value paid.

Send payment notification with payment ID, date, and value paid

The second step to create a new transaction. This request is used to send the payment data through a public request.

2.1 Send payments information public

Registers a new affiliation (payment or anti-fraud provider) in your store.

Insert new affiliation

Creates a new payment rule to be applied to the payment providers configured in your store.

Insert a new payment rule

This request is the first step to create a new transaction.

1. Start a new transaction

The third step to create a new transaction. This request sends additional data related to the transaction, such as profile information, shopping cart, shipping data, among others.

3. Send additional data

The fourth and last step to create a new transaction. It will authorized the new transaction creation according to the data previously informed in the latests requests.

4. Authorize new transaction

Cancels a transaction that was previously approved, but not settled. It is possible to cancel partially or complete value of the transaction.

Cancel the transaction

The second step to create a new transaction. This request is used to send the payment data through a private request.

2.2 Send payments with saved credit card

Refunds the amount of the transaction that was previously settled.

Refund the transaction

Settles the transaction amount. A payment settled means that the seller will receive the value of the purchase value after bank conciliation.

Settle the transaction

Updates information about an affiliation (payment or anti-fraud provider) configured in your store.

Update affiliation by ID

Updates information about a specific payment rule applied to the payment providers configured in your store.

Update payment rule by ID

The Payments Gateway API allows you to get payment data and process your store's transactions.