# /transaction/status

## Purpose
Retrieves the latest status and processing details for a previously created transaction.

## When to use
Use this endpoint to:
- Poll for lifecycle updates (funding confirmation, compliance holds, payout progression)
- Display current transaction state in your UI or partner system
- Retrieve hold reasons and required documents (when applicable)

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

## How to identify the transaction
Provide the uuid query parameter. The uuid is returned by /transaction/create.

## Notes
- Responses may include holds and requiredDocumentList when compliance or operational review is required.
- Status values reflect internal processing and payout execution steps.

## Common errors
- 400 Missing/invalid uuid
- 401 Invalid credentials
- 404 Transaction not found
- 500 Internal error

Endpoint: GET /transaction/status
Version: 1.0.0

## Header parameters:

  - `x-client-id` (string, required)
    Error codes: required=400001, type=400002, minLength=400003, maxLength=400004
    Example: "xxxx123456789"

  - `x-secret-key` (string, required)
    Error codes: required=400001, type=400002, minLength=400003, maxLength=400004
    Example: "xxxx987654321xxs"

## Query parameters:

  - `uuid` (string, required)
    Error codes: required=400001, type=400002, minLength=400003, maxLength=400004
    Example: "xxxxxx-xxxxx-xxx-xxxx-xxxxx"

## Response 200 fields (application/json):

  - `status` (string)
    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_id` (string)
    Unique identifier of the generated transaction.

  - `transaction_uuid` (string)
    Unique identifier of the generated transaction.

  - `status_track_url` (string)
    URL where the user can track the transaction.

  - `folio` (string)
    Money transfer tracking number

  - `total_receiver` (string)
    Amount in destin currency that the customer is sending plus fees

  - `total_pay_receiver` (string)
    Amount in destination currency that the beneficiary is receiving

  - `rate` (string)
    Exchange rate

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

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

  - `holds` (array)
    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.

  - `holds.type` (string)

  - `holds.description` (string)
    Name or description of the hold that lifted the transaction.

  - `requiredDocumentList` (array)
    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 400 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 400 (click to expand)CodeDescription400000The body of the request is required. Invalid JSON format of the request body.400415The routing number 'routingNumber' is not valid.

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 401 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 401 (click to expand)CodeDescription401000Invalid credentials

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 404 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 404 (click to expand)CodeDescription404000Transaction not found

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 500 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 500 (click to expand)CodeDescription500000Internal Error

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)