# List settlements

API to fetch first party payouts (settlements).

Endpoint: GET /v0/collections/settlements
Version: 0.0.1
Security: Bearer

## Query parameters:

  - `id` (string)
    Filter settlements by specific settlement ID
    Example: "63dd59dd-88be-41a2-a246-2f6724209422"

  - `type` (string)
    Settlement type
    Enum: "FIAT", "CRYPTO"

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

  - `since` (string)
    ISO 8601 timestamp after settlement was created
    Example: "2025-06-17T12:00:00Z"

  - `until` (string)
    ISO 8601 timestamp before settlement was created
    Example: "2025-06-17T12:00:00Z"

  - `page` (integer)
    Page number (starts at 1)
    Example: 1

  - `size` (integer)
    Page size (items per page)
    Example: 10

## Response 200 fields (application/json):

  - `content` (array)

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

  - `content.type` (string, required)
    Settlement type
    Enum: "FIAT", "CRYPTO"

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

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

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

  - `content.fees` (string, required)
    Total fees applied to the settlement
    Example: "0.50"

  - `content.data` (object, required)
    Additional settlement data including account details

  - `content.data.sending_account` (object)
    Account details for settlement transactions

  - `content.data.sending_account.account_holder` (string, required)
    Full name of the account holder
    Example: "John Doe"

  - `content.data.sending_account.institution_name` (string, required)
    Name of the financial institution
    Example: "Bank of America"

  - `content.data.sending_account.account_number` (string, required)
    Account number for the settlement
    Example: "XXXX6789"

  - `content.data.sending_account.routing_number` (string, required)
    Routing number for the financial institution
    Example: "XXXX4321"

  - `content.data.receiving_account` (object)
    Account details for settlement transactions

  - `content.data.transaction_reference_numbers` (array)
    Bank reference numbers for the settlement transaction
    Example: ["ABC12345"]

  - `content.data.description` (string)
    Human-readable description of the settlement
    Example: "Monthly Payout"

  - `content.transactions` (array, required)
    List of transactions associated with this settlement

  - `content.transactions.id` (string, required)
    Unique identifier for the transaction
    Example: "487ba009-56cf-4ad9-8b5c-045e27893e00"

  - `content.transactions.parent_id` (string, required)
    Identifier of the parent entity (collection link or channel) for this transaction
    Example: "e8d43598-107d-4694-9fb2-934e7484c3d4"

  - `content.transactions.settlement_id` (string,null)
    Identifier of the settlement associated with this transaction. Null if the transaction has not been included in a settlement yet.
    Example: "9f3e4d2c-1a5b-4c8e-9d7f-2e1a3b4c5d6e"

  - `content.transactions.payer` (object, required)
    Payer partner details

  - `content.transactions.payer.id` (string, required)
    Unique identifier for the payer partner
    Example: "0c5479ff-3772-4123-b2b7-e679e71eb570"

  - `content.transactions.payer.name` (string, required)
    Full name of the payer partner
    Example: "Nigerian Imports Ltd."

  - `content.transactions.payer.email` (string, required)
    Email address of the payer partner
    Example: "nigerian@imports.com"

  - `content.transactions.beneficiary` (object, required)
    Beneficiary partner details

  - `content.transactions.beneficiary.id` (string, required)
    Unique identifier of the beneficiary partner
    Example: "01467076-8bb0-41c1-ad54-5751dd4a9e80"

  - `content.transactions.beneficiary.name` (string, required)
    Full name of the beneficiary partner
    Example: "Hong Kong Exports Ltd."

  - `content.transactions.beneficiary.email` (string, required)
    Email address of the beneficiary partner
    Example: "hongkong@exports.com"

  - `content.transactions.payment_amount` (object, required)
    Crypto payment amount and asset

  - `content.transactions.payment_amount.value` (string, required)
    Payment amount as a string to preserve precision
    Example: "50.00000000"

  - `content.transactions.payment_amount.asset` (string, required)
    Crypto asset symbol of the payment
    Example: "USDT"

  - `content.transactions.fiat_equivalent` (object, required)
    Fiat equivalent amounts for payment, fee, and net

  - `content.transactions.fiat_equivalent.gross_amount` (object, required)

  - `content.transactions.fiat_equivalent.gross_amount.value` (string, required)
    Gross amount in fiat
    Example: "50.00"

  - `content.transactions.fiat_equivalent.gross_amount.currency` (string, required)
    Fiat currency code
    Example: "USD"

  - `content.transactions.fiat_equivalent.fee_amount` (object, required)

  - `content.transactions.fiat_equivalent.fee_amount.value` (string, required)
    Fee amount in fiat
    Example: "0.50"

  - `content.transactions.fiat_equivalent.fee_amount.currency` (string, required)
    Fiat currency code
    Example: "USD"

  - `content.transactions.fiat_equivalent.net_amount` (object, required)

  - `content.transactions.fiat_equivalent.net_amount.value` (string, required)
    Net amount in fiat
    Example: "49.50"

  - `content.transactions.fiat_equivalent.net_amount.currency` (string, required)
    Fiat currency code
    Example: "USD"

  - `content.transactions.market_rate` (object, required)
    Market rate reference for the transaction

  - `content.transactions.market_rate.base` (string)
    Base currency for the exchange rate
    Example: "USDT"

  - `content.transactions.market_rate.counter` (string)
    Counter currency for the exchange rate
    Example: "USD"

  - `content.transactions.market_rate.rate` (string)
    Exchange rate from base to counter currency
    Example: "1.00"

  - `content.transactions.exchange_rate` (object, required)
    Exchange rate applied on the transaction

  - `content.transactions.exchange_rate.base` (string)
    Base currency for the exchange rate
    Example: "USDT"

  - `content.transactions.exchange_rate.counter` (string)
    Counter currency for the exchange rate
    Example: "USD"

  - `content.transactions.exchange_rate.rate` (string)
    Exchange rate from base to counter currency
    Example: "0.99"

  - `content.transactions.source_transaction_details` (object, required)
    On-chain transaction details

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

  - `content.transactions.source_transaction_details.transaction_hash` (string, required)
    Blockchain transaction hash
    Example: "0x94365ftfr76iy45t6ghu876567ytr54ertyui987uyt698uyh87u"

  - `content.transactions.source_transaction_details.block_id` (string, required)
    Blockchain block identifier containing this transaction
    Example: "0xh7865gugi87yea94e8267987a9e91eddcd0da916b22f3cfa0c8bd91dbad85"

  - `content.transactions.source_transaction_details.source_address` (string, required)
    Blockchain address from which funds were sent
    Example: "0x880f622a1933ACf82bFC5e630c9ab7f18eF47809"

  - `content.transactions.source_transaction_details.destination_address` (string, required)
    Blockchain address to which funds were sent
    Example: "0x02937b288b588058533C48b18EdFDdd76A324D6"

  - `content.transactions.source_transaction_details.gas_fee` (object, required)
    Blockchain gas fee details

  - `content.transactions.source_transaction_details.gas_fee.value` (string)
    Gas fee value
    Example: "0.0045"

  - `content.transactions.source_transaction_details.gas_fee.asset` (string)
    Asset used to pay gas fee
    Example: "ETH"

  - `content.transactions.status` (string, required)
    Transaction status
    Enum: "COMPLETED", "FAILED_KYT", "FAILED", "HOLD_KYT", "REFUNDED_KYT", "PROCESSING"

  - `content.transactions.reason` (string,null)
    Reason for current status (if applicable)

  - `content.transactions.transaction_processed_date` (string, required)
    ISO 8601 timestamp of the transaction
    Example: "2025-06-17T12:20:00Z"

  - `content.transactions.date_created` (integer, required)
    Unix timestamp (milliseconds) when transaction was created
    Example: 1566203005000

  - `content.transactions.date_confirmed` (integer, required)
    Unix timestamp (milliseconds) when transaction was confirmed on blockchain
    Example: 1566203005000

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

  - `content.reason` (string,null)
    Reason for current status (if applicable)

  - `page` (object)
    Pagination metadata.

  - `page.page` (integer, required)
    Example: 1

  - `page.size` (integer, required)
    Example: 10

  - `page.total_elements` (integer, required)
    Example: 100

  - `page.total_pages` (integer, required)
    Example: 10

## Response 400 fields (application/json):

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

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