/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)

What happens next

Validates the transaction exists in DynamoDB
Retrieves real-time status from SQL Server
Combines DynamoDB and SQL Server data into a unified response
Returns status, holds, compliance requirements, and financial details

Authentication

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

Notes

The required_document_list field indicates what compliance documents are still needed (e.g., KYC, ID, SSN).
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

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.

transaction_idstring

Unique identifier of the generated transaction.

transaction_uuidstring

Unique identifier of the generated transaction.

branch_idstring

Internal identifier for a specific branch within an organization.

status_track_urlstring

URL where the user can track the transaction.

foliostring

Money transfer tracking number

total_receiverstring

Amount in destin 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.

required_document_listArray of strings

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.

payment_railstring

Identifies the payment network or rail used to process the electronic transaction.

This field classifies the clearing and settlement method utilized between financial institutions.

RTP: Real-Time Payments Network

FEDNOW: Federal Reserve FedNow instant payment service

ACH: Automated Clearing House transfer

NULL: In process, unavailable, or not provided

Response

{
  "transaction_uuid": "xxxxx-xxxx-xxxx-xxxx-xxxxx",
  "branch_id": "I99984",
  "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": [
    { … },
    { … },
    { … }
  ],
  "required_document_list": [
    "Copy1ID",
    "Copy2ID",
    "DOB",
    "ID",
    "KYC",
    "SFunds",
    "SSN"
  ],
  "payment_rail": "RTP"
}