Inter API Documentation

Version 2.0 - Enhanced Partner Integration Guide

Corridor-specific field requirements

Last Updated: April 14, 2026 Version: 2.0

This page is a companion to CreateNewOrder. Use it when you need to know how sender country, recipient country, payment rail (TypeOfPaymentID / ACH, FedNow-style instant credit, TED/DOC, PIX, etc.), and transaction type (P2P, P2B, B2B, B2P) interact beyond the generic R / O / C column in the main field tables.

Legend

SymbolMeaning
Required: Must be filled with real information.
Required (Structural): Required but accepts default/placeholder.
Conditional: Required for transactions ≥ USD 3K
Optional
Not Applicable

Brazil: RecipientTIN and beneficiary type

For every order with RecipientCountry = BR, RecipientTIN is mandatory on CreateNewOrder. The value must match who receives the funds:

The API uses this distinction together with name and company fields: when RecipientTIN is treated as a CPF (11 digits), RecipientFirstName cannot be empty (empty XML elements count as missing). When it is treated as a CNPJ (14 digits), RecipientCompany must contain the legal company name. Do not send a CPF for a corporate beneficiary or a CNPJ for an individual.

For non-production environments, syntactically valid sample numbers may be built with third-party generators such as CPF generator and CNPJ generator; use only sandboxes, never real taxpayer data you do not own.

Field requirements by corridor

Each block below is one corridor: origin → destination and payment rail. The Brazil matrices — bank deposit (TED/DOC) and PIX — are titled * → Brazil and follow the * → BR partner sheets (any sender country). Full request rules remain in CreateNewOrder. For Brazil payouts, read Brazil: RecipientTIN and beneficiary type above in addition to the matrices.

* → United States — ACH / FedNow (instant bank credit)

RecipientCountry = US

FieldP2PP2BB2BB2P
Sender
SenderFirstName
SenderLastName
SenderCompanyName
SenderCountry
SenderAddress
SenderCity
SenderState
SenderZip
SenderPhone1
SenderDateOfBirth
SenderDocument1Type
SenderDocument1Number
Recipient
RecipientFirstName
RecipientLastName
RecipientCompany
RecipientCountry
RecipientAddress1
RecipientCity
RecipientState
RecipientZip
RecipientPhone1
RecipientTIN
RecipientDocument1Type
RecipientDocument1Number

* → Brazil — Bank deposit (TED/DOC)

Typical TypeOfPaymentID = 31 · RecipientCountry = BR. Sender columns match the * → BR (Bank Deposit) product matrix (any sender country).

FieldP2PP2BB2BB2P
Sender
SenderFirstName
SenderLastName
SenderCompanyName
SenderCountry
SenderAddress
SenderCity
SenderState
SenderZip
SenderPhone1
SenderDateOfBirth
SenderDocument1Type
SenderDocument1Number
Recipient
RecipientFirstName
RecipientLastName
RecipientCompany
RecipientCountry
RecipientAddress1
RecipientCity
RecipientState
RecipientZip
RecipientPhone1
RecipientTIN
RecipientDocument1Type
RecipientDocument1Number

* → Brazil — PIX

Typical TypeOfPaymentID = 42 · RecipientCountry = BR. Sender columns match the * → BR (PIX) product matrix (any sender country). Recipient name columns differ from bank deposit; use PixTypeId / PixId and empty bank-account fields per CreateNewOrder.

FieldP2PP2BB2BB2P
Sender
SenderFirstName
SenderLastName
SenderCompanyName
SenderCountry
SenderAddress
SenderCity
SenderState
SenderZip
SenderPhone1
SenderDateOfBirth
SenderDocument1Type
SenderDocument1Number
Recipient
RecipientFirstName
RecipientLastName
RecipientCompany
RecipientCountry
RecipientAddress1
RecipientCity
RecipientState
RecipientZip
RecipientPhone1
RecipientTIN
RecipientDocument1Type
RecipientDocument1Number

← Back to CreateNewOrder