# Glossary

This glossary defines the most common terms, fields, and concepts used across the ViaBlocks API and documentation.
It is intended to provide a consistent vocabulary for partners integrating money transfer services.

## Amounts and Currencies

### `originationAmount`

The amount collected from the sender in the origination currency before any fees, taxes, or exchange rate conversion are applied.

### `originationCurrencyISO`

The ISO 4217 currency code representing the currency in which the sender provides the funds (for example, `MXN`, `USD`, `COP`).

### `deliveryAmountCurrencyISO`

The ISO 4217 currency code representing the currency in which the beneficiary will receive the funds.

### `total_receiver`

The total amount that the beneficiary will receive in the destination currency after all conversions, fees, and adjustments have been applied.

### `total_pay_receiver`

The total amount effectively paid to the beneficiary in the destination currency.
This value usually matches `total_receiver`, but may differ in specific operational scenarios.

### `source_currency_amount`

The original amount provided by the sender in the source (origination) currency.

### `source_currency_iso`

The ISO 4217 currency code of the source (origination) currency.

### `currency_receiver_iso`

The ISO 4217 currency code of the destination (receiver) currency.

### `rate`

The exchange rate applied to convert the source currency into the destination currency for the transaction.

### `folio`

A human-readable reference number assigned to the transaction for operational and customer support purposes.

## Statuses and Holds

### `status`

The current processing state of the transaction as returned by the `/transaction/status` endpoint.
This value represents the position of the transaction within the ViaBlocks processing lifecycle.

### Known Status Values

#### `HOLD`

The transaction is temporarily paused due to compliance, risk, or operational validation.

#### `REVIEW`

The transaction is under manual or automated review before further processing.

#### `READY_TO_SEND`

The transaction has passed all validations and is ready to be sent to the payout or settlement network.

#### `SENT`

The transaction has been sent to the payout or external processing network.

#### `PAID`

The funds have been successfully paid to the beneficiary.

#### `TRANSFERRED`

The funds have been transferred to the payout or settlement institution, but final confirmation may still be pending.

#### `TRANSFERRED_PAID`

The transaction has been both transferred and fully paid to the beneficiary.

### `hold`

Represents a restriction or blocking condition applied to a transaction that prevents it from continuing its normal processing flow.
Holds are typically triggered by compliance, risk, or missing information.

### `requiredDocumentList`

A list of documents that must be provided by the sender or beneficiary in order to release a hold or continue processing the transaction.

### `requiredDocumentList.item`

A single required document entry, describing one specific document that must be submitted for compliance or validation purposes.

### `message`

A human-readable message describing the current state of the transaction or explaining the reason for a hold, rejection, or validation requirement.

### `status_track_url`

A URL that allows real-time tracking of the transaction status through the ViaBlocks tracking interface.

## General Concepts

### Transaction

A financial operation representing a money transfer from a sender to a beneficiary processed through the ViaBlocks platform.

### Sender

The person or entity that initiates and funds the transaction.

### Beneficiary

The person or entity that receives the funds from the transaction.

### Inbound Transaction

A transaction where funds are sent from an international location to the United States.

### Outbound Transaction

A transaction where funds are sent from the United States to an international destination.

### Settlement

The final financial reconciliation stage of a transaction after funds have been successfully delivered.

### Compliance

The set of regulatory, risk, and validation processes applied to ensure that transactions meet legal and operational requirements.