# Get sub-merchant payments

Retrieve payments for a specific sub-merchant

Endpoint: GET /merchants/{merchantId}/payments
Version: 1.0.0
Security: ApiKeyAuth

## Path parameters:

  - `merchantId` (string, required)
    The unique identifier for the sub-merchant
    Example: "mer_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9"

## Query parameters:

  - `limit` (integer)
    The maximum number of payments to return

  - `offset` (integer)
    The number of payments to skip

  - `status` (string)
    Filter payments by status
    Enum: "pending", "completed", "failed"

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string)
    The unique identifier for the payment
    Example: "pay_7uAd21uizm5p1psa"

  - `data.amount` (integer)
    The payment amount in the lowest currency unit (e.g. cents)
    Example: 1099

  - `data.currency` (string)
    The payment currency
    Example: "EUR"

  - `data.description` (string)
    A short description of the payment
    Example: "Payment for order #1234"

  - `data.checkout_url` (string)
    The URL to redirect the user to for payment
    Example: "https://checkout.helixpay.io/pay_7uAd21uizm5p1psa"

  - `data.return_urls` (object)

  - `data.return_urls.success` (string)
    Example: "https://example.com/payment/success"

  - `data.return_urls.failure` (string)
    Example: "https://example.com/payment/failure"

  - `data.destination_wallet_id` (string)
    The ID of the wallet to which the payment will be sent
    Example: "wlt_7uAd21uizm5p1psa"

  - `data.metadata` (object)
    Additional metadata for the payment
    Example: {"order_id":"1234","customer_id":"5678"}

  - `data.payment_status_code` (string)
    The status of the payment request. This will always be "Created" for a newly created payment request.
    Example: "CREATED"

  - `data.payment_method_code` (string)
    The payment method used for the payment
    Example: "card"

  - `data.test_mode` (boolean)
    If the payment is a test payment for sandbox testing

  - `data.breakdown` (object)

  - `data.breakdown.fees` (integer)

  - `data.breakdown.net_amount` (integer)

  - `data.refund` (object)

  - `data.refund.id` (string)
    The unique identifier for the refund
    Example: "rfd_123"

  - `data.refund.payment_id` (string)
    The unique identifier for the payment
    Example: "pay_123"

  - `data.refund.amount` (integer)
    The amount refunded
    Example: 1000

  - `data.refund.reason_code` (string)
    The reason for the refund
    Example: "DUPLICATE"

  - `data.refund.other_reason` (string)
    Other reason for the refund if code is OTHER
    Example: "Cancellation"

  - `data.refund.created_at` (string)
    The date and time the refund was created
    Example: "2021-01-01T00:00:00Z"

  - `data.refund.status` (string)
    The status of the refund
    Example: "REFUND_REQUESTED"

  - `data.refund.updated_at` (string)
    The date and time the refund was last updated
    Example: "2021-01-01T00:00:00Z"

  - `data.billing_address` (object)

  - `data.billing_address.first_name` (string)
    The first name of the person or entity being billed
    Example: "John"

  - `data.billing_address.last_name` (string)
    The last name of the person or entity being billed
    Example: "Doe"

  - `data.billing_address.email` (string)
    The email address

  - `data.billing_address.phone_number` (string)
    The phone number of the person or entity being billed

  - `data.billing_address.address_line_1` (string)
    The first line of the billing address
    Example: "123 Main St"

  - `data.billing_address.address_line_2` (string)
    The second line of the billing address
    Example: "Apt 101"

  - `data.billing_address.city` (string)
    The city of the billing address
    Example: "San Francisco"

  - `data.billing_address.state` (string)
    The state, region, or province of the billing address
    Example: "CA"

  - `data.billing_address.zip_code` (string)
    The postal code of the billing address
    Example: "94107"

  - `data.billing_address.country_code` (string)
    The country code of the billing address
    Example: "US"

  - `data.payment_config` (object)

  - `data.payment_config.collected_fields` (string)
    Comma-separated list of fields to collect during checkout.
    Example: "email,phone_number"

  - `data.created_at` (string)
    The date and time the payment request was created
    Example: "2021-01-01T12:00:00Z"

  - `data.updated_at` (string)
    The date and time the payment request was last updated
    Example: "2021-01-01T12:00:00Z"

  - `data.expires_at` (string)
    The time after which the payment request will expire
    Example: "2022-01-01T12:00:00Z"

  - `data.completed_at` (string)
    The time at which the payment was completed
    Example: "2022-01-01T12:00:00Z"

  - `metadata` (object)

  - `metadata.total` (integer)

  - `metadata.limit` (integer)

  - `metadata.offset` (integer)


## Response 401 fields

## Response 404 fields

## Response 500 fields