vtex.local – Payments-Gateway-API

OpenAPI apis-guru

ℹ️ Onboarding guide

Check the new . We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.

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

Homepage: https://api.apis.guru/v2/specs/vtex.local:Payments-Gateway-API/1.0.json
Provider: vtex.local:Payments-Gateway-API / Payments-Gateway-API
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/openapi.yaml

Tools (24)

Extracted live via the executor SDK.

configuration.affiliationById

Returns associated data for the specified affiliation Id, like name and implementation, for example.
configuration.affiliations

Returns all affiliations that your provider can handle.
configuration.availablePaymentMethods

Returns enabled payment methods, like visa, master, bankissueinvoice that are shown for the final user and enabled to receive payment.
configuration.insertAffiliation

Creates a new affiliation and returns a successful response.
configuration.insertRule

Creates a new rule and returns a successful response.
configuration.putRuleById

Update Rule.
configuration.rule

Deletes rules by specified Id.
configuration.ruleById

Returns rule by specified RuleId.
configuration.rules

Returns all rules conditions your provider can handle.
configuration.updateAffiliation

Returns all affiliations.
installments.installmentsoptions

Returns the best installment options according to the informed params.
transactionFlow.cancelthetransaction

Cancel's transaction that was previously approved, but not settled.
transactionFlow.refundthetransaction

Refunds transaction's value that was previously settled.
transactionFlow.settlethetransaction

Settles transaction's value.
transactionProcess.1Createanewtransaction

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

The second step to create a new transaction. Here, you have the option to send the data in three diferent ways: doing a private request, a public request or a private request that uses a saved Credit Card.
transactionProcess.2SendPaymentsWithSavedCreditCard

The second step to create a new transaction. Here, you have the option to send the data in three diferent ways: doing a private request, a public request or a private request that uses a saved Credit Card.
transactionProcess.3SendAdditionalData

The third step to create a new transaction. It will send the additional related data to the transaction, like billig and shipping adress.
transactionProcess.4Doauthorization

The fouth and last step to create a new transaction. It will authorized the new transction creation acorrdint to the data previously informed in the latests requests.
transactionProcess.paymentDetails

Returns associated information details for the specified payment id.
transactionProcess.transactionDetails

Returns associated data for the specified transaction id, like value and status, for exemple.
transactionProcess.transactionSettlementDetails

Returns associated settlements data for the specified transaction id.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools