What problem does it solve?
Asynchronous payment methods can return no final approval immediately, causing orders to stall or cancel incorrectly unless your connector correctly handles callback/notification lifecycles and status evolution.
Core Features & Use Cases
- Correct async handling (status: undefined): Ensures Boleto/Pix/redirect-based flows never prematurely return approved/denied before the acquirer confirms.
- CallbackUrl integrity & validation: Uses the exact
callbackUrl from the Create Payment request (including X-VTEX-signature) and includes required headers for non-VTEX IO notifications.
- Sync vs async retry behavior: Supports both non-VTEX IO callback notification and VTEX IO retry endpoint patterns, including idempotent Create Payment with evolving status.
- Redirect-based flow correctness: Avoids using
inboundRequestsUrl for browser GET redirects by implementing a custom public route that updates state and triggers Gateway retry.
Quick Start
Use the payment-async-flow skill to implement a Pix/Boleto connector that returns status undefined, stores and reuses the exact callbackUrl for notifications, updates local status on provider webhooks, and triggers Gateway retry or approval accordingly.