/transaction/status

API Reference/

/transaction/status

Request

Retrieves the current status and details of a transaction.

Purpose

Returns the real-time status, financial details, compliance information, and tracking data for a specific transaction.

When to use

Use this endpoint to:

Check the current processing status of a transaction
Retrieve hold information and compliance requirements
Get the transaction tracking URL
Monitor transaction lifecycle (creation, confirmation, payment, cancellation)
Check which required documents have been fulfilled or are still pending

What happens next

Validates the transaction exists
Retrieves real-time transaction status
Checks fulfillment status of each required document
Returns status, holds, compliance requirements with fulfillment status, and financial details

Authentication

Requires x-client-id and x-secret-key headers.

Notes

The required_document_list field indicates what compliance documents are needed (e.g., KYC, ID, SSN).
The document_requirements field provides the detailed fulfillment status for each required document, showing whether it has been completed or is still pending.
Hold information includes active holds that may be blocking the transaction.

Common errors

400 Missing or invalid UUID
401 Invalid credentials
404 Transaction not found
500 Internal error

Query

uuidstring, [ 32 .. 60 ] charactersrequired

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

Example:uuid=string

x-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: required=400001, type=400002, minLength=400003, maxLength=400004

Example:string

x-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: required=400001, type=400002, minLength=400003, maxLength=400004

Example:string

GET

/transaction/status

curl -i -X GET \
  'https://sandbox-viablocks.viamericas.io/transaction/status?uuid=string' \
  -H 'x-client-id: string' \
  -H 'x-secret-key: string'

Responses

Response success

Bodyapplication/json

transaction_uuidstring

Unique UUID identifier of the transaction.

transaction_idstring

Internal transaction identifier in the format {branchId}-{receiverId} (e.g., I00123-456789).

status_track_urlstring

URL where the user can track the transaction status in real-time.

date_createdstring

Date and time when the transaction was created. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time).

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.
TRANSFERED	The funds have been transferred to the payout network or external institution.

foliostring

Money transfer tracking number (MTCN).

source_currency_amountnumber

Amount in the source (origination) currency that the sender is sending.

source_currency_isostring

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

total_receivernumber

Total amount in destination currency that the customer is sending (including fees applied to delivery).

total_pay_receivernumber

Amount in destination currency that the beneficiary will actually receive.

currency_receiver_isostring

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

ratenumber

Exchange rate applied to the transaction.

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.

required_document_listArray 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.

document_requirementsArray of objects

Detailed real-time status of each required document. Use this field to:

Show the user which requirements are complete and which need action
Determine if a document is under review (no action needed, wait)
Detect rejections or expirations that require re-submission

Each object contains:

type: The compliance requirement code (matches items in required_document_list)
fulfilled: true if no further action is needed for this requirement, false if action is required
status: Detailed lifecycle status of the requirement

Possible status values:

Status	Meaning	User Action
`completed`	Requirement fully satisfied and approved	None
`pending`	Not yet submitted — upload/submit required	Submit via PUT /transaction/update
`in_review`	Document uploaded, awaiting approval	Wait — do not re-submit
`rejected`	Document was reviewed and rejected	Re-submit with corrected document
`expired`	Document was valid but has expired	Re-submit with current document

payment_railstring

Payment rail used for the transaction (e.g., ACH, RTP, FEDNOW). Null if not applicable or not yet determined.

date_availablestring

Estimated date when the funds will be available to the beneficiary. Null if not applicable or not yet determined. Format: MM/DD/YYYY or ISO 8601 depending on the payout network.

date_paymentstring

Date when the transaction was paid out to the beneficiary. Null if the transaction has not been paid yet. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time).

date_transferstring

Date when the funds were transferred to the payout network or external institution. Null if the transaction has not been transferred yet. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time).

date_cancelstring

Date when the transaction was cancelled or voided. Null if the transaction has not been cancelled. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time).

Response

{
  "transaction_uuid": "xxxxx-xxxx-xxxx-xxxx-xxxxx",
  "transaction_id": "I00123-456789",
  "status_track_url": "https://status-track.viamericas.io/?token=xxxxx-xxxx-xxxx-xxxx-xxxxx",
  "date_created": "07/27/2026 01:45:19 PM",
  "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": [
    { … },
    { … }
  ],
  "required_document_list": [
    "Copy1ID",
    "DOB",
    "ID",
    "KYC"
  ],
  "document_requirements": [
    { … },
    { … },
    { … },
    { … }
  ],
  "payment_rail": null,
  "date_available": null,
  "date_payment": null,
  "date_transfer": null,
  "date_cancel": null
}