Introduction

Welcome to the Transfero Checkout Partner API.

This API lets external partners accept crypto payments (swap order receive flow) and request PIX withdrawals as a service — without using the mobile app or the VTEX Connector.

What you can do

Capability	Description
Receive	Create orders, show a payment QR / deposit address, and track payment and settlement
Withdraw	Check Ultra BRZ balance and request PIX withdrawals to your pre-configured key
Reconcile	Poll Partner API status endpoints; use Ultra webhooks as optional triggers

Environments

Environment	Base URL
Staging	`https://transfero-checkout-bff.transfero.dev`
Production	`https://transfero-checkout-bff-prod.transfero.com`

All operations use the path prefix /api/v1/partner-api.

How to integrate

Authentication — exchange x-partner-id / x-partner-secret for a Bearer JWT
Flows — receive (swap) and withdraw (PIX) sequences
Statuses — payment, settlement, and payout milestones
Webhooks — Ultra events and how to reconcile with status GETs
API Reference — full request/response contracts for every endpoint

Prerequisites

Partner credentials issued by Transfero (Azure AD application / client secret)
Your partner record must have Partner API enabled (PartnerApiEnabled)
For Try-it-out or Postman: use staging credentials provided during onboarding

If you do not have credentials yet, contact your Transfero representative.