Automate VTEX Payments Gateway

What VTEX Payments Gateway is

>ℹ️ Onboarding guide > > Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). 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 pro

API host: vtex.local

What HumDay can do in VTEX Payments Gateway

13 documented operations change something in VTEX Payments Gateway.

• POST1. Starts a new transaction/api/pvt/transactions
• POST2.1 Send Payments Information Public/api/pub/transactions/{transactionId}/payments
• POST2.2 Send Payments With Saved Credit Card/api/pvt/transactions/{transactionId}/payments
• POSTInsert Rule/api/pvt/rules
• POSTInsert Affiliation/api/pvt/affiliations
• POST3. Send Additional Data/api/pvt/transactions/{transactionId}/additional-data
• DELETEDelete Rule/api/pvt/rules/{ruleId}
• PUTRule By Id/api/pvt/rules/{ruleId}
• PUTUpdate Affiliation/api/pvt/affiliations/{affiliationId}
• POSTRefund the transaction/api/pvt/transactions/{transactionId}/refunding-request
• POSTSettle the transaction/api/pvt/transactions/{transactionId}/settlement-request
• POSTCancel the transaction/api/pvt/transactions/{transactionId}/cancellation-request
• POSTDo authorization/api/pvt/transactions/{transactionId}/authorization-request

What HumDay can read from VTEX Payments Gateway

These are the operations a schedule or a trigger can watch.

• GETAvailable Payment Methods/api/pvt/merchants/payment-systems
• GETRules/api/pvt/rules
• GETAffiliations/api/pvt/affiliations
• GETInstallments options/api/pvt/installments
• GETPayment Details/api/pvt/transactions/{transactionId}/payments/{paymentId}
• GETRule By Id/api/pvt/rules/{ruleId}
• GETAffiliation By Id/api/pvt/affiliations/{affiliationId}
• GETTransaction Details/api/pvt/transactions/{transactionId}
• GETTransaction Settlement Details/api/pvt/transactions/{transactionId}/settlements

How automating VTEX Payments Gateway works

1. Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
2. Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
3. See it proven. The program runs and shows you the result before it is allowed near your live VTEX Payments Gateway account.
4. Grant access, then go live. You approve the specific VTEX Payments Gateway operations it may use — and only those.

Automate VTEX Payments Gateway with these

• VTEX Catalog162 operations
• VTEX Catalog Seller Portal16 operations
• VTEX Checkout32 operations
• VTEX Customer Credit26 operations
• VTEX Do8 operations
• VTEX GiftCard11 operations
• VTEX GiftCard Hub15 operations
• VTEX Headless CMS3 operations
• VTEX Intelligent Search7 operations
• VTEX Legacy Search15 operations
• VTEX License Manager12 operations
• VTEX Logistics53 operations

Questions about VTEX Payments Gateway automation

Can HumDay connect to VTEX Payments Gateway?

Yes. HumDay reads VTEX Payments Gateway's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 22 operations are documented.

Do I need to write code to automate VTEX Payments Gateway?

No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your VTEX Payments Gateway account.

What can HumDay do in VTEX Payments Gateway?

13 of the 22 documented operations change something in VTEX Payments Gateway, and 9 read from it. HumDay only ever uses the specific operations your approved contract needs.

Is my VTEX Payments Gateway account safe?

Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to VTEX Payments Gateway is held behind that approval.

Where this came from

The operations above are read from a published API description for VTEX Payments Gateway at raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Payments Gateway API.json. Descriptions are the provider’s own words, not ours. Last published 2023-03-03.