Skills
.Work. You
Rest

payment-async-flow

Official

Coordinate async payments with safe callbacks.

Software Engineering#async#webhook#payments#retry#callback#vtex
Authorvtexdocs
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Implement asynchronous payment flows with undefined status handling, ensuring proper callback and retry mechanisms for non-synchronous payments like Boleto and Pix.

Core Features & Use Cases

  • Handles Create Payment responses with status "undefined" for async methods (BankInvoice/Boleto, Pix) and stores the callbackUrl for later notification.
  • Notifies the Gateway via the exact callbackUrl with proper VTEX headers after the acquirer confirms payment, respecting VTEX IO and non-VTEX IO flows.
  • Enforces idempotent Create Payment retries within the 7-day window and updates status in response to callbacks.

Quick Start

Set up an async payment flow for a Boleto or Pix method and verify the callback notification cycle.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: payment-async-flow
Download link: https://github.com/vtexdocs/ai-skills/archive/main.zip#payment-async-flow

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.