Money Transfer

Overview (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

ViaBlocks API Inbound is a server-to-sever API that enables regulated partners create and track money transfers. The API supports sender and beneficiary onboarding, transaction creation, funding, FX handling, payout execution, and status tracking. The two API calls are POST /transaction/create to submit sender, beneficiary, and transaction details, and POST /transaction/status to retrieve the latest processing status.

Inbound transaction is a money transfer created by a partner through this API. It represents funds sent from a sender in the origination country to a beneficiary in the delivery country, and it is tracked from creation through payout using /transaction/status

Download OpenAPI description

inbound.json

inbound.yaml

Overview

Contact

javier.ararat@viamericas.com

Servers

Mock server

https://docs2-viablocks.viamericas.io/_mock/apis/inbound/

Sandbox environment

https://sandbox-viablocks.viamericas.io/

Production environment

https://viablocks.viamericas.net/

Transaction
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

This section provides the Transaction endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform.

These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support all core business operations and compliance workflows.

Operations

/transaction/create

Request

Creates a new money transfer transaction.

This endpoint validates sender and beneficiary data, applies compliance checks, and registers the transaction for processing.

Bodyapplication/jsonrequired

client_idstring[ 16 .. 64 ] charactersrequired

Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request.

Error codes (click to expand)

Rule	Code
required	400001
type	400002
minLength	400003
maxLength	400004

secret_keystring[ 32 .. 128 ] charactersrequired

Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential.

Error codes (click to expand)

Rule	Code
required	400005
type	400006
minLength	400007
maxLength	400008

senderobjectrequired

Contains the personal and identification information of the transaction sender.

All fields are subject to AML, KYC, and compliance validation rules.

This information is used to verify the identity of the person initiating the transaction and to evaluate regulatory and risk requirements.

Error codes (click to expand)

Rule	Code
required	400011
type	400012

sender.firstNamestring[ 2 .. 60 ] charactersrequired

Sender’s given (first) name as it appears on their official identification document.

Error codes (click to expand)

Rule	Code
required	400013
type	400014
minLength	400015
maxLength	400016

sender.middleNamestring[ 2 .. 60 ] characters

Sender’s middle name, if applicable.

Error codes (click to expand)

Rule	Code
required	400017
type	400018
minLength	400019
maxLength	400020

sender.lastNamestring[ 2 .. 60 ] charactersrequired

Sender’s primary family name (surname).

Error codes (click to expand)

Rule	Code
required	400021
type	400022
minLength	400023
maxLength	400024

sender.secondLastNamestring[ 2 .. 60 ] characters

Sender’s second family name, used in some countries.

Error codes (click to expand)

Rule	Code
required	400025
type	400026
minLength	400027
maxLength	400028

sender.phonestring[ 10 .. 15 ] charactersrequired

Sender’s phone number without country code.

Error codes (click to expand)

Rule	Code
required	400029
type	400030
minLength	400031
maxLength	400032

sender.phoneCountryCodestring[ 2 .. 4 ] charactersrequired

International dialing code of the sender’s phone number

Error codes (click to expand)

Rule	Code
required	400033
type	400034
minLength	400035
maxLength	400036
allowedValues	400087

Value"+52"

sender.emailstring(email)[ 5 .. 60 ] charactersrequired

Sender’s email address used for notifications and transaction updates.

Error codes (click to expand)

Rule	Code
required	400037
type	400038
minLength	400039
maxLength	400040
format	400041

sender.addressStreetstring[ 2 .. 60 ] charactersrequired

Sender address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA' Regular expression: ^[0-9]+\s[\w\s.,-]+$

Error codes (click to expand)

Rule	Code
required	400042
type	400043
minLength	400044
maxLength	400045

sender.addressStatestring[ 2 .. 6 ] charactersrequired

Sender state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2

Error codes (click to expand)

Rule	Code
required	400047
type	400048
minLength	400049
maxLength	400050

sender.addressCitystring[ 2 .. 60 ] charactersrequired

City name of the sender’s residence.

Error codes (click to expand)

Rule	Code
required	400051
type	400052
minLength	400053
maxLength	400054

sender.addressCountrystring[ 2 .. 3 ] charactersrequired

Sender country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

Error codes (click to expand)

Rule	Code
required	400055
type	400056
minLength	400057
maxLength	400058
allowedValues	400085

Enum"TCD""COL""DOM""COD""GNB""HTI""JAM""MEX""MAR""MOZ"

sender.addressZipCodestring[ 5 .. 6 ] charactersrequired

Postal or ZIP code of the sender’s address.

Error codes (click to expand)

Rule	Code
required	400100
type	400101
minLength	400102
maxLength	400103

sender.documentTypestring[ 2 .. 3 ] charactersrequired

Type of identification document provided by the sender (e.g., Passport, National ID).

Document types (documentType) — click to expand

Code	Document Type	Description
BD	BORDER CROSSING CARD	Border crossing card used to enter certain countries without a passport.
BF	CPF/CNPJ	Brazilian tax registry for individuals (CPF) and legal entities (CNPJ).
CA	CARTEIRA DE IDENTIDADE	Identity document issued in Brazil.
CC	CÉDULA CIUDADANÍA	Identification document in Colombia.
CE	CÉDULA DE IDENTIDAD Y ELECTORAL	Identity document used in the Dominican Republic.
CI	CÉDULA DE IDENTIDAD	Identity document issued in various Latin American countries.
CL	CREDENCIAL DE ELECTOR	Voter identification document used in Mexico.
CN	CERTIFICATE OF NATURALIZATION	Naturalization certificate that grants citizenship in the U.S. or other countries.
CP	CADASTRO DE PESSOAS FÍSICAS (CPF)	Tax registry for individuals in Brazil.
CR	CREW LANDING PERMIT & BADGE	Landing permit for aircraft crew members.
CV	CÉDULA DE VECINDAD	Identity document in Guatemala.
CZ	CERTIFICATE OF CITIZENSHIP	Citizenship certificate issued by national governments.
DI	DOCUMENTO NACIONAL DE IDENTIDAD (DNI)	Identity document in Argentina, Spain, and other countries.
DL	DRIVER'S LICENSE	Driver's license.
DN	DOCUMENTO NACIONAL	National identity document.
DU	DOCUMENTO ÚNICO DE IDENTIDAD (DUI)	Identity document in El Salvador.
EA	EMPLOYMENT AUTHORIZATION	Employment authorization document in the U.S.
GC	GREEN CARD	Permanent residence card in the U.S.
GI	GOVERNMENT IDENTIFICATION	Identification issued by the government for its citizens.
IC	CÉDULA DE IDENTIDAD CIVIL	Civil identity document in several countries.
ID	IDENTIFICATION CARD	General identification card.
LD	DRIVER'S LICENSE	Driver's license.
LE	LIBRETA ELECTORAL	Electoral document in Peru.
LP	LEARNER PERMIT	Learner's permit for driving.
MC	MATRÍCULA CONSULAR	Identity document issued by consulates to citizens abroad.
MI	MILITARY ID	Military identification.
NN	NONE	No identity document required.
OI	OFFICIAL ID (POLICE, FIRE, ETC)	Official identification for police, firefighters, etc.
OT	OTHER	Other type of identity document.
PA	PASSPORT	Passport issued by a government.
PC	PASSPORT CARD	Passport card used in the U.S. for certain international travel.
PP	PASAPORTE	Passport.
PR	PERMANENT RESIDENT CARD	Permanent residence card in some countries.
RA	RESIDENT ALIEN	Document for a foreign resident.
SI	STATE ISSUED ID	Identification issued by a state or province.
SS	SSN	Social Security Number (U.S.).
TI	TARJETA DE IDENTIDAD	Identity card in some Latin American countries.
TR	TARJETA DE REGISTRO CONSULAR	Consular registration card for citizens abroad.
VI	VISA	Entry visa for a country.

Error codes (click to expand)

Rule	Code
required	400059
type	400060
minLength	400061
maxLength	400062

sender.documentDescriptionstring[ 0 .. 60 ] charactersrequired

Human-readable description of the identification document.

Error codes (click to expand)

Rule	Code
required	400063
type	400064
minLength	400065
maxLength	400066

sender.documentNumberstring[ 2 .. 60 ] charactersrequired

Identification document number.

Error codes (click to expand)

Rule	Code
required	400067
type	400068
minLength	400069
maxLength	400070

sender.documentExpirationDatestring(YYYY-MM-DD)[ 8 .. 10 ] characters

Expiration date of the identification document.

Error codes (click to expand)

Rule	Code
required	400071
type	400072
minLength	400074
maxLength	400075
format	400073

sender.documentCountrystring[ 2 .. 3 ] characters

Sender country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

Error codes (click to expand)

Rule	Code
required	400076
type	400077
minLength	400078
maxLength	400079

sender.dateOfBirthstring(YYYY-MM-DD)[ 8 .. 10 ] charactersrequired

Sender’s date of birth, used for identity verification and compliance checks.

Error codes (click to expand)

Rule	Code
required	400080
type	400081
minLength	400083
maxLength	400084
format	400082

sender.occupationstring[ 2 .. 60 ] charactersrequired

Sender’s occupation or professional activity.

Error codes (click to expand)

Rule	Code
required	400088
type	400089
minLength	400090
maxLength	400091

sender.employerstring[ 2 .. 60 ] charactersrequired

Name of the sender’s employer or business activity.

Error codes (click to expand)

Rule	Code
required	400092
type	400093
minLength	400094
maxLength	400095

sender.proofOfIncomestring[ 2 .. 60 ] charactersrequired

Description of the sender’s source of income or supporting documentation.

Error codes (click to expand)

Rule	Code
required	400096
type	400097
minLength	400098
maxLength	400099

beneficiaryobjectrequired

Represents the final recipient of the funds in a transaction.

Contains the personal, identification, and location information required to validate the recipient against AML, sanctions, and regulatory screening rules.

This object is used to ensure the payout can be legally and operationally executed in the destination country.

Error codes (click to expand)

Rule	Code
required	400151
type	400152

beneficiary.firstNamestring[ 2 .. 60 ] charactersrequired

Beneficiary’s given name.

Error codes (click to expand)

Rule	Code
required	400153
type	400154
minLength	400155
maxLength	400156

beneficiary.middleNamestring[ 2 .. 60 ] characters

Beneficiary’s middle name, if applicable.

Error codes (click to expand)

Rule	Code
required	400157
type	400158
minLength	400159
maxLength	400160

beneficiary.lastNamestring[ 2 .. 60 ] charactersrequired

Beneficiary’s primary family name.

Error codes (click to expand)

Rule	Code
required	400161
type	400162
minLength	400163
maxLength	400164

beneficiary.secondLastNamestring[ 2 .. 60 ] characters

Beneficiary’s second family name.

Error codes (click to expand)

Rule	Code
required	400165
type	400166
minLength	400167
maxLength	400168

beneficiary.phonestring[ 10 .. 15 ] charactersrequired

Beneficiary’s phone number without country code.

Error codes (click to expand)

Rule	Code
required	400169
type	400170
minLength	400171
maxLength	400172

beneficiary.phoneCountryCodestring[ 2 .. 4 ] charactersrequired

International dialing code of the beneficiary’s phone number.

Error codes (click to expand)

Rule	Code
required	400173
type	400174
minLength	400175
maxLength	400176
allowedValues	400214

Value"+1"

beneficiary.addressStreetstring[ 2 .. 60 ] characters^[0-9]+\s[\w\s.,-]+$required

Beneficiary address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA' Regular expression: ^[0-9]+\s[\w\s.,-]+$

Error codes (click to expand)

Rule	Code
required	400177
type	400178
minLength	400179
maxLength	400180
pattern	400215

beneficiary.addressStatestring[ 2 .. 6 ] charactersrequired

Beneficiary state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2

Error codes (click to expand)

Rule	Code
required	400181
type	400182
minLength	400183
maxLength	400184
allowedValues	400213

Enum"US-AL""US-AK""US-AZ""US-AR""US-CA""US-CO""US-CT""US-DE""US-FL""US-GA"

beneficiary.addressCitystring[ 2 .. 60 ] charactersrequired

City name of residence of the beneficiary.

Error codes (click to expand)

Rule	Code
required	400185
type	400186
minLength	400187
maxLength	400188

beneficiary.addressCountrystring[ 2 .. 3 ] charactersrequired

Beneficiary country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

Error codes (click to expand)

Rule	Code
required	400189
type	400190
minLength	400191
maxLength	400192

beneficiary.addressZipCodestring[ 5 .. 6 ] charactersrequired

Postal or ZIP code of the beneficiary’s address.

Error codes (click to expand)

Rule	Code
required	400216
type	400217
minLength	400218
maxLength	400219

beneficiary.documentTypestring[ 2 .. 3 ] characters

Type of identification document of the beneficiary.

Document types (documentType) — click to expand

Code	Document Type	Description
BD	BORDER CROSSING CARD	Border crossing card used to enter certain countries without a passport.
BF	CPF/CNPJ	Brazilian tax registry for individuals (CPF) and legal entities (CNPJ).
CA	CARTEIRA DE IDENTIDADE	Identity document issued in Brazil.
CC	CÉDULA CIUDADANÍA	Identification document in Colombia.
CE	CÉDULA DE IDENTIDAD Y ELECTORAL	Identity document used in the Dominican Republic.
CI	CÉDULA DE IDENTIDAD	Identity document issued in various Latin American countries.
CL	CREDENCIAL DE ELECTOR	Voter identification document used in Mexico.
CN	CERTIFICATE OF NATURALIZATION	Naturalization certificate that grants citizenship in the U.S. or other countries.
CP	CADASTRO DE PESSOAS FÍSICAS (CPF)	Tax registry for individuals in Brazil.
CR	CREW LANDING PERMIT & BADGE	Landing permit for aircraft crew members.
CV	CÉDULA DE VECINDAD	Identity document in Guatemala.
CZ	CERTIFICATE OF CITIZENSHIP	Citizenship certificate issued by national governments.
DI	DOCUMENTO NACIONAL DE IDENTIDAD (DNI)	Identity document in Argentina, Spain, and other countries.
DL	DRIVER'S LICENSE	Driver's license.
DN	DOCUMENTO NACIONAL	National identity document.
DU	DOCUMENTO ÚNICO DE IDENTIDAD (DUI)	Identity document in El Salvador.
EA	EMPLOYMENT AUTHORIZATION	Employment authorization document in the U.S.
GC	GREEN CARD	Permanent residence card in the U.S.
GI	GOVERNMENT IDENTIFICATION	Identification issued by the government for its citizens.
IC	CÉDULA DE IDENTIDAD CIVIL	Civil identity document in several countries.
ID	IDENTIFICATION CARD	General identification card.
LD	DRIVER'S LICENSE	Driver's license.
LE	LIBRETA ELECTORAL	Electoral document in Peru.
LP	LEARNER PERMIT	Learner's permit for driving.
MC	MATRÍCULA CONSULAR	Identity document issued by consulates to citizens abroad.
MI	MILITARY ID	Military identification.
NN	NONE	No identity document required.
OI	OFFICIAL ID (POLICE, FIRE, ETC)	Official identification for police, firefighters, etc.
OT	OTHER	Other type of identity document.
PA	PASSPORT	Passport issued by a government.
PC	PASSPORT CARD	Passport card used in the U.S. for certain international travel.
PP	PASAPORTE	Passport.
PR	PERMANENT RESIDENT CARD	Permanent residence card in some countries.
RA	RESIDENT ALIEN	Document for a foreign resident.
SI	STATE ISSUED ID	Identification issued by a state or province.
SS	SSN	Social Security Number (U.S.).
TI	TARJETA DE IDENTIDAD	Identity card in some Latin American countries.
TR	TARJETA DE REGISTRO CONSULAR	Consular registration card for citizens abroad.
VI	VISA	Entry visa for a country.

Error codes (click to expand)

Rule	Code
required	400193
type	400194
minLength	400195
maxLength	400196

beneficiary.documentNumberstring[ 2 .. 60 ] characters

Identification document number of the beneficiary.

Error codes (click to expand)

Rule	Code
required	400197
type	400198
minLength	400199
maxLength	400200

beneficiary.documentDescriptionstring[ 2 .. 60 ] characters

Identification document number of the beneficiary.

Error codes (click to expand)

Rule	Code
required	400201
type	400202
minLength	400203
maxLength	400204

beneficiary.documentCountrystring[ 2 .. 3 ] characters

Country that issued the beneficiary’s identification document.

Error codes (click to expand)

Rule	Code
required	400205
type	400206
minLength	400207
maxLength	400208

beneficiary.relationShipstring[ 2 .. 60 ] characters

Relationship between sender and beneficiary (e.g., Family, Friend, Business).

Error codes (click to expand)

Rule	Code
required	400209
type	400210
minLength	400211
maxLength	400212

transactionInformationobjectrequired

Represents the financial, operational, and processing configuration of the transaction.

Contains all parameters required to calculate, validate, route, and execute the transfer, including amounts, currencies, delivery method, funding source, fees, and payout instructions.

All fields are validated against business rules, compliance policies, and operational constraints before the transaction is accepted for processing.

Error codes (click to expand)

Rule	Code
required	400301
type	400302

transactionInformation.deliveryModestring= 1 charactersrequired

Defines the payout execution method and destination details for the transaction.

Specifies how and where the funds will be delivered to the beneficiary (e.g., cash pickup, bank deposit, walletcredit, or home delivery), including all routing and operational parameters required to complete the payout.

Delivery mode

Code	Delivery Mode	Description
P	Cash Pickup	Cash withdrawal at an authorized location.
C	Bank Deposit	Direct deposit to a bank account.
O	Mobile Wallet	Deposit to a mobile wallet.
D	Home Delivery	Cash delivered to the recipient’s address.
U	Undefined	Undefined

Error codes (click to expand)

Rule	Code
required	400303
type	400304
minLength	400305
maxLength	400306
allowedValues	400307

Value"C"

transactionInformation.deliveryModeDetailsobjectrequired

Contains the bank account and routing information required to execute the payout to the beneficiary.

This object defines the destination financial institution and account where the funds will be deposited, including account number, account type, routing number, and bank details.

All fields are validated against country-specific banking rules and payout network requirements before the transaction is released for payment.

Error codes (click to expand)

Rule	Code
required	400308
type	400309

transactionInformation.deliveryModeDetails.accountNumberstring[ 6 .. 60 ] charactersrequired

Destination account number.

Error codes (click to expand)

Rule	Code
required	400310
type	400311
minLength	400312
maxLength	400313

transactionInformation.deliveryModeDetails.accountAuxiliaryFieldstring[ 6 .. 60 ] characters

Error codes (click to expand)

Rule	Code
required	400314
type	400315
minLength	400316
maxLength	400317

transactionInformation.deliveryModeDetails.accountTypestring= 1 characters

Delivery mode used for the transaction.

Account types

Code	Account Type	Description
S	Saving	Savings account
C	Checking	Checking account
U	Undefined	Undefined

Error codes (click to expand)

Rule	Code
required	400318
type	400319
minLength	400320
maxLength	400321
allowedValues	400388

Enum"S""C"

transactionInformation.deliveryModeDetails.routingNumberstring[ 9 .. 60 ] charactersrequired

Bank routing or clearing number

Error codes (click to expand)

Rule	Code
required	400407
type	400408
minLength	400409
maxLength	400410

transactionInformation.deliveryModeDetails.bankstring[ 6 .. 60 ] charactersrequired

Name of the receiving bank.

Error codes (click to expand)

Rule	Code
required	400411
type	400412
minLength	400413
maxLength	400414

transactionInformation.fundingobjectrequired

Defines the source of funds and funding method used to initiate the transaction.

Contains the payment instrument and funding configuration (e.g., cash, debit card, bank account, wallet), and is used to validate, authorize, and register the financial charge before the transaction is processed.

Error codes (click to expand)

Rule	Code
required	400322
type	400323

transactionInformation.funding.typestring= 1 charactersrequired

Funding source type (e.g., bank account, cash, etc.).

Funding types

Code	Funding Type	Description
A	Account bank	Indicates that the transaction is funded directly from a bank account. The funds will be debited from the specified bank account using the configured banking or payment network before the transaction is processed.
C	Cash	Indicates that the transaction is funded using cash. The sender provides the funds in cash at an authorized agent location or branch before the transaction is processed.

Error codes (click to expand)

Rule	Code
required	400324
type	400325
minLength	400326
maxLength	400327
allowedValues	400406

Enum"A""C"

transactionInformation.funding.accountNumberstring[ 6 .. 60 ] charactersrequired

Funding account number.

Error codes (click to expand)

Rule	Code
required	400420
type	400421
minLength	400422
maxLength	400423

transactionInformation.funding.routingNumberstring[ 9 .. 60 ] charactersrequired

Routing number bank.

Error codes (click to expand)

Rule	Code
required	400424
type	400425
minLength	400426
maxLength	400427

transactionInformation.originationCountryISOstring[ 2 .. 6 ] charactersrequired

Origin country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

Error codes (click to expand)

Rule	Code
required	400328
type	400329
minLength	400330
maxLength	400331
allowedValues	400391

Enum"TCD""COL""DOM""COD""GNB""HTI""JAM""MEX""MAR""MOZ"

transactionInformation.originationStateISOstring[ 2 .. 6 ] charactersrequired

Origin state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2

Error codes (click to expand)

Rule	Code
required	400332
type	400333
minLength	400334
maxLength	400335

transactionInformation.originationLocationCitystring[ 2 .. 60 ] charactersrequired

City where the transaction is initiated.

Error codes (click to expand)

Rule	Code
required	400336
type	400337
minLength	400338
maxLength	400339

transactionInformation.originationAmountnumber>= 0required

Amount of money sent in the origination currency.

Error codes (click to expand)

Rule	Code
required	400340
type	400341
minimum	400398
decimal	400399

transactionInformation.originationCurrencyISOstring[ 2 .. 6 ] charactersrequired

Origin currency (ISO). https://en.wikipedia.org/wiki/ISO_4217

Error codes (click to expand)

Rule	Code
required	400342
type	400343
minLength	400344
maxLength	400345
allowedValues	400392

Value"MXN"

transactionInformation.exchangeRatenumber>= 0

Amount of money sent in the origination currency.

Error codes (click to expand)

Rule	Code
required	400346
type	400347
minimum	400400
decimal	400401

transactionInformation.feenumber>= 0

Transaction service fee charged for processing the remittance.

Error codes (click to expand)

Rule	Code
required	400348
type	400349
minimum	400402
decimal	400403

transactionInformation.deliveryCountryISOstring[ 2 .. 6 ] charactersrequired

Delivery country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

Error codes (click to expand)

Rule	Code
required	400350
type	400351
minLength	400352
maxLength	400353
allowedValues	400393

Value"USA"

transactionInformation.deliveryStateISOstring[ 2 .. 6 ] charactersrequired

Delivery state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2

Error codes (click to expand)

Rule	Code
required	400354
type	400355
minLength	400356
maxLength	400357
allowedValues	400395

Enum"US-AL""US-AK""US-AZ""US-AR""US-CA""US-CO""US-CT""US-DE""US-FL""US-GA"

transactionInformation.deliveryAmountnumber>= 0

Amount to be delivered in the destination currency.

Error codes (click to expand)

Rule	Code
required	400358
type	400359
minimum	400404
decimal	400405

transactionInformation.deliveryAmountCurrencyISOstring[ 2 .. 6 ] charactersrequired

Delivery currency (ISO). https://en.wikipedia.org/wiki/ISO_4217

Error codes (click to expand)

Rule	Code
required	400360
type	400361
minLength	400362
maxLength	400363
allowedValues	400394

Value"USD"

transactionInformation.deliveryLocationCodestring[ 2 .. 30 ] charactersrequired

Internal or partner code of the payout location.

Error codes (click to expand)

Rule	Code
required	400364
type	400365
minLength	400366
maxLength	400367
allowedValues	400389

Value"T377"

transactionInformation.deliveryLocationNetworkstring[ 2 .. 30 ] charactersrequired

Network or partner identifier used for payout.

Error codes (click to expand)

Rule	Code
required	400368
type	400369
minLength	400370
maxLength	400371
allowedValues	400390

Value"PV0001"

transactionInformation.deliveryLocationNamestring[ 2 .. 30 ] charactersrequired

Human-readable name of the payout location or method.

Error codes (click to expand)

Rule	Code
required	400372
type	400373
minLength	400374
maxLength	400375

transactionInformation.deliveryLocationCitystring[ 2 .. 60 ] charactersrequired

City where the funds will be delivered.

Error codes (click to expand)

Rule	Code
required	400376
type	400377
minLength	400378
maxLength	400379

transactionInformation.sourceOfFoundsstring[ 2 .. 60 ] characters

Declared source of funds used to finance the remittance (e.g., salary, savings, business income). This information may be required for compliance (KYC/AML) depending on the client configuration, corridor, or transaction amount thresholds.

Error codes (click to expand)

Rule	Code
required	400380
type	400381
minLength	400382
maxLength	400383

transactionInformation.remittancePurposestring[ 2 .. 60 ] characters

Declared purpose of the remittance, describing why the funds are being sent (e.g., family support, education, medical expenses, rent, personal transfer). This can be used for compliance classification, reporting, and corridor-specific regulatory requirements.

Error codes (click to expand)

Rule	Code
required	400384
type	400385
minLength	400386
maxLength	400387

channelstring[ 2 .. 60 ] characters

Identifies the integration channel used to create the transaction (API, Web, Messaging, etc.).

Error codes (click to expand)

Rule	Code
required	400501
type	400502
minLength	400503
maxLength	400504
allowedValues	400507

Enum"API""WHATSAPP"

channelMetadataobject

Dynamic / Data considered relevant by the client for informational purposes for internal tracking

Error codes (click to expand)

Rule	Code
required	400505
type	400506

curl -i -X POST \
  https://docs2-viablocks.viamericas.io/_mock/apis/inbound/transaction/create \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "xxxx123456789",
    "secret_key": "xxxx987654321",
    "sender": {
      "firstName": "MARLON",
      "middleName": "",
      "lastName": "ARANZA",
      "secondLastName": "",
      "phone": "3888111965",
      "phoneCountryCode": "+52",
      "email": "notificationsviablocks@gmail.com",
      "dateOfBirth": "1987-01-01",
      "addressStreet": "125 Hidalgo, Mezcala, Jalisco 47914, México",
      "addressState": "MX-JAL",
      "addressCity": "MEZCALA",
      "addressCountry": "MEX",
      "addressZipCode": "47914",
      "documentType": "PA",
      "documentDescription": "PASSPORT",
      "documentNumber": "FF01231167855",
      "documentState": "MX-JAL",
      "documentCountry": "MEX",
      "occupation": "DRIVER",
      "employer": "UBER DRIVER",
      "proofOfIncome": "NOT APPLICABLE"
    },
    "beneficiary": {
      "firstName": "ANGEL",
      "middleName": "",
      "lastName": "RESTADO",
      "secondLastName": "",
      "phone": "3057118816",
      "phoneCountryCode": "+1",
      "email": "notificationsviablocks@gmail.com",
      "addressStreet": "1450 Brickell Avenue Apt 2908, Miami, FL 33131, USA",
      "addressState": "US-FL",
      "addressCity": "MIAMI",
      "addressCountry": "USA",
      "addressZipCode": "33131"
    },
    "transactionInformation": {
      "originationCountryISO": "MEX",
      "originationStateISO": "MX-JAL",
      "originationLocationCity": "MEZCALA",
      "originationAmount": 360,
      "originationCurrencyISO": "MXN",
      "deliveryCountryISO": "USA",
      "deliveryStateISO": "US-FL",
      "deliveryAmountCurrencyISO": "USD",
      "deliveryLocationCode": "T377",
      "deliveryLocationNetwork": "PV0001",
      "deliveryLocationName": "USA BANK DEPOSIT",
      "deliveryLocationCity": "CITY USA BANK",
      "deliveryMode": "C",
      "deliveryModeDetails": {
        "accountNumber": "5369254747",
        "routingNumber": 96016930,
        "accountType": "S",
        "bank": "USA BANK"
      },
      "funding": {
        "type": "A",
        "accountNumber": "530000000",
        "routingNumber": 80
      }
    }
  }'

Responses

Response success

Bodyapplication/json

statusstring

Request status (success, error, etc.).

messagestring

Descriptive message about the operation result.

transaction_idstring

Unique identifier of the generated transaction.

transaction_uuidstring

Unique identifier of the generated transaction.

status_track_urlstring

URL where the user can track the transaction.

foliostring

Money transfer tracking number.

total_receiverstring

Amount in destination currency that the customer is sending plus fees.

total_pay_receiverstring

Amount in destination currency that the beneficiary is receiving.

ratestring

Exchange rate.

source_currency_amountstring

Amount in source currency that the customer is sending.

Response

application/json

{
  "status": "success",
  "message": "Transaction created successfully",
  "transaction_uuid": "xxxxxx-xxxxx-xxx-xxxx-xxxxx",
  "transaction_id": "xxxxxx-8",
  "folio": "123456789",
  "total_receiver": "46.6200",
  "total_pay_receiver": "46.6200",
  "source_currency_amount": "840.0000",
  "rate": "0.0555",
  "status_track_url": "https://status-track.viamericas.io/?token=xxxxxx-xxxxx-xxx-xxxx-xxxxx"
}

/transaction/status

Request

Retrieves the current status and processing details of a previously created transaction.

This endpoint provides real-time visibility into the transaction lifecycle, including compliance checks, funding confirmation, routing, payout execution, and final settlement.

The transaction is uniquely identified by its uuid, which is returned by the transaction creation endpoint.

Bodyapplication/jsonrequired

client_idstring[ 16 .. 64 ] charactersrequired

Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request.

Error codes (click to expand)

Rule	Code
required	400001
type	400002
minLength	400003
maxLength	400004

secret_keystring[ 32 .. 128 ] charactersrequired

Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential.

Error codes (click to expand)

Rule	Code
required	400005
type	400006
minLength	400007
maxLength	400008

uuidstring[ 32 .. 60 ] charactersrequired

Unique identifier of the generated transaction.

Error codes (click to expand)

Rule	Code
required	400500
type	400501
minLength	400502
maxLength	400503

curl -i -X POST \
  https://docs2-viablocks.viamericas.io/_mock/apis/inbound/transaction/status \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "xxxx123456789",
    "secret_key": "xxxx987654321",
    "uuid": "xxxxx-xxxx-xxxx-xxxx-xxxxx"
  }'

Responses

Response success

Bodyapplication/json

statusstring

Transaction status

Status	Description
VOID	The transaction has been voided and is no longer valid.
CANCEL	The transaction was cancelled before completion.
EXPIRED	The transaction was not completed within the allowed time window and has expired.
HOLD	The transaction is temporarily on hold due to compliance or operational review.
DONE	The transaction has completed its internal processing flow successfully.
SENDTOBANK	The transaction has been sent to the bank for processing.
PAID	The funds have been paid out to the beneficiary.
TRANSFERRED	The funds have been transferred to the payout network or external institution.

transaction_idstring

Unique identifier of the generated transaction.

transaction_uuidstring

Unique identifier of the generated transaction.

status_track_urlstring

URL where the user can track the transaction.

foliostring

Money transfer tracking number.

total_receiverstring

Amount in destination currency that the customer is sending plus fees.

total_pay_receiverstring

Amount in destination currency that the beneficiary is receiving.

ratestring

Exchange rate

source_currency_isostring

ISO currency code of the source (sending) amount. Represents the currency in which the sender funds the transaction.

currency_receiver_isostring

ISO currency code of the destination (receiving) amount. Represents the currency in which the beneficiary will receive the funds.

holdsArray of objects

List of compliance or operational holds applied to the transaction.

Each hold represents a restriction or review requirement that must be resolved before the transaction can proceed.

requiredDocumentListArray of objects

List of documents required to resolve compliance or regulatory requirements for the transaction.

This list is typically populated when the transaction requires additional verification or is placed on hold.

Response

application/json

{
  "transaction_uuid": "xxxxx-xxxx-xxxx-xxxx-xxxxx",
  "status_track_url": "https://status-track.viamericas.io/?token=xxxxx-xxxx-xxxx-xxxx-xxxxx",
  "status": "HOLD",
  "folio": "1234567890",
  "source_currency_amount": 84000,
  "source_currency_iso": "MXN",
  "total_receiver": 84000,
  "total_pay_receiver": 4662,
  "currency_receiver_iso": "USD",
  "rate": 0.0555,
  "holds": [
    { … },
    { … },
    { … }
  ],
  "requiredDocumentList": [
    "Copy1ID",
    "Copy2ID",
    "DOB",
    "ID",
    "KYC",
    "SFunds",
    "SSN"
  ]
}

Overview (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Transaction
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

/transaction/create

Request

Delivery mode

Account types

Funding types

Responses

Was this helpful?

/transaction/status

Request

Responses

Was this helpful?

Overview (1.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

TransactionCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

/transaction/create

RequestExpand all

Delivery mode

Account types

Funding types

Responses

Was this helpful?

/transaction/status

Request

Responses

Was this helpful?

Overview (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Transaction
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request