# List collections

Retrieves a list of collections using account-based routing, filterable by query parameters.

Endpoint: GET /v1/collections/links
Version: 1.0.0
Security: Bearer

## Query parameters:

  - `id` (string)
    Filter collections by specific collection identifier

  - `payer_id` (string)
    Filter collections by payer identifier

  - `account_id` (string)
    Filter collections by account identifier

  - `beneficiary_id` (string)
    Filter collections by beneficiary identifier

  - `since` (string)
    ISO 8601 timestamp after collection was created

  - `until` (string)
    ISO 8601 timestamp before collection was created

  - `page` (integer)
    Page number (zero-indexed, starts at 0)

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

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (string, required)
    Unique identifier for the collection
    Example: "e8d43598-107d-4694-9fb2-934e7484c3d4"

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

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

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

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

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

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

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

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

  - `content.account` (object, required)
    Account associated to this collection, which funds will be routed to

  - `content.account.id` (string, required)
    Unique identifier for the account
    Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

  - `content.account.beneficiary_id` (string, required)
    Unique identifier of the beneficiary partner
    Example: "291ecf34-a01d-466a-b0fd-662a88b7a1bb"

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

  - `content.account.type` (string, required)
    Type of account
    Enum: "FIAT", "CRYPTO"

  - `content.reference_id` (string)
    External reference identifier for the collection
    Example: "INV-2025-009"

  - `content.gross_amount` (string, required)
    Total amount including fees
    Example: "808.00"

  - `content.net_amount` (string, required)
    Amount excluding buyer fees
    Example: "800.00"

  - `content.fee_mode` (string, required)
    How fees are handled in the collection
    Enum: "INCLUDED", "EXCLUDED"

  - `content.fee` (string, required)
    Fee amount charged for the collection
    Example: "8.00"

  - `content.amount_remaining` (string, required)
    Amount remaining for an incomplete payment
    Example: "758.50"

  - `content.description` (string, required)
    Human-readable description of the collection purpose
    Example: "Payment for Order #2668"

  - `content.link_expiry` (integer, required)
    Payment link expiry time in seconds from creation
    Example: 172800

  - `content.return_url` (string, required)
    Example: "https://example.com/payment/completion"

  - `content.expires_at` (string, required)
    ISO 8601 timestamp when the collection expires
    Example: "2025-06-30T23:59:59Z"

  - `content.payment_link` (string)
    URL for the payment interface
    Example: "https://collections.ripple.com/link/pay/384c5f9b"

  - `content.status` (string, required)
    The status of the collection
    Enum: "CREATED", "CLOSED", "HOLD", "EXPIRED", "PENDING", "PROCESSING", "COMPLETED", "UNDERPAID", "OVERPAID", "CANCELLED"

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

  - `content.created_at` (string, required)
    ISO 8601 timestamp when the collection was created
    Example: "2025-06-17T12:00:00Z"

  - `content.updated_at` (string, required)
    ISO 8601 timestamp when the collection was last updated
    Example: "2025-06-17T12:30:00Z"

  - `page` (object)
    Pagination metadata.

  - `page.page` (integer, required)

  - `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