# Get settlement by ID

API to fetch a first party payout (settlement to our customer) with enhanced v1 response format.

Endpoint: GET /v1/collections/settlements/{settlement_id}
Version: 1.0.0
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer JWT

## Path parameters:

  - `settlement_id` (string, required)
    Unique identifier of the settlement to retrieve

## Response 200:

  - `200` (unknown)
    Successful response.

## Response 200 fields (application/json):

  - `id` (string, required)
    Unique identifier for the settlement
    Example: 63dd59dd-88be-41a2-a246-2f6724209422

  - `source_account_id` (string, required)
    Source account the settlement was drawn from
    Example: b2c3d4e5-f6a7-8901-bcde-f12345678901

  - `currency` (string, required)
    Currency code for the settlement
    Example: USD

  - `gross_amount` (string, required)
    Total settlement amount before fees
    Example: 50.00

  - `settlement_amount` (string, required)
    Net settlement amount after fees
    Example: 49.50

  - `fees` (object, required)
    Fees applied to the settlement

  - `fees.transaction_fees` (string, required)
    Total transaction fees applied to the settlement, as a string to preserve precision
    Example: 0.50

  - `status` (string, required)
    Settlement status
    Enum: "PENDING", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"

  - `data` (object, required)
    Settlement execution data — carries the bank transaction reference numbers (fiat) or the on-chain transaction hash (crypto), plus the configured payout destination.

  - `data.transaction_reference_numbers` (array)
    Bank transaction reference numbers; populated for fiat settlements after completion
    Example: ["ABC12345"]

  - `data.transaction_hash` (string)
    On-chain transaction hash; populated for crypto settlements after completion
    Example: 0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF

  - `data.payout_destination` (object, required)
    Configured payout destination for a settlement, discriminated by `type` (the payment rail).
Fiat settlements use FEDWIRE / ACH / RTP / PIX; crypto settlements use BLOCKCHAIN.

  - `data.payout_destination.type` (string, required)
    Discriminator: indicates blockchain payout
    Enum: "BLOCKCHAIN"

  - `data.payout_destination.network` (string, required)
    Supported blockchain networks
    Enum: "ETHEREUM", "ETHEREUM_SEPOLIA_TESTNET", "SOLANA", "SOLANA_TESTNET", "XRPL", "XRPL_TESTNET"

  - `data.payout_destination.address` (string, required)
    Destination blockchain wallet address
    Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh

  - `data.payout_destination.currency` (string)
    Cryptocurrency asset symbol
    Example: RLUSD

  - `data.payout_destination.destination_tag` (string)
    Optional destination tag/memo for networks that require one (e.g. XRPL)
    Example: 12345

  - `data.payout_destination.type` (string, required)
    Discriminator: indicates Fedwire payout
    Enum: "FEDWIRE"

  - `data.payout_destination.account_name` (string)
    Name on the destination bank account (the Ripple customer receiving the settlement)
    Example: Finance Corp

  - `data.payout_destination.account_number` (string, required)
    Destination bank account number (obfuscated; only the last four digits are shown)
    Example: XXXX7890

  - `data.payout_destination.routing_number` (string, required)
    ABA routing number
    Example: 021000021

  - `data.payout_destination.swift_code` (string)
    SWIFT/BIC code for international payouts
    Example: CHASUS33

  - `data.payout_destination.institution_name` (string)
    Name of the receiving financial institution
    Example: Bank of America

  - `data.payout_destination.reference` (string)
    Reference to include with the payout
    Example: INV-2024-001

  - `data.payout_destination.type` (string, required)
    Discriminator: indicates ACH payout
    Enum: "ACH"

  - `data.payout_destination.type` (string, required)
    Discriminator: indicates RTP payout
    Enum: "RTP"

  - `data.payout_destination.type` (string, required)
    Discriminator: indicates PIX payout
    Enum: "PIX"

  - `data.payout_destination.pix_key` (string, required)
    PIX key for the payout (obfuscated; only the last four characters are shown)
    Example: XXXX8901

  - `data.payout_destination.pix_key_type` (string, required)
    Type of PIX key
    Enum: "CPF", "CNPJ", "EMAIL", "PHONE", "RANDOM"

  - `data.payout_destination.beneficiary_name` (string)
    Name of the account holder as registered with PIX (the Ripple customer receiving the settlement)
    Example: Finance Corp

  - `created_at` (string, required)
    ISO 8601 timestamp when the settlement was created
    Example: 2025-09-18T22:54:00.542Z

  - `updated_at` (string, required)
    ISO 8601 timestamp when the settlement was last updated
    Example: 2025-09-18T22:54:00.542Z

## Response 400:

  - `400` (unknown)
    Bad Request - Invalid input parameters

## Response 400 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message

## Response 401:

  - `401` (unknown)
    Unauthorized - Invalid or missing authentication

## Response 401 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message

## Response 404:

  - `404` (unknown)
    Not Found - Settlement does not exist

## Response 404 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message

## Response 500:

  - `500` (unknown)
    Internal server error

## Response 500 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message