---
title: "Get requests for payment"
method: GET
path: "/request_for_payment"
tags: ["Request for payment"]
---

# Get requests for payment

`GET /request_for_payment`

Gets requests for payment that match the query parameters.

## Query parameters

- `end_to_end_id` string
- `state` 'REQUESTED' | 'ACCEPTED' | 'FAILED'
- `sender_address` string
- `receiver_address` string
- `payment_id` string, uuid
- `before` string
- `after` string
- `range_field` 'CREATED_AT' | 'MODIFIED_AT'
- `sort_field` 'CREATED_AT' | 'MODIFIED_AT'
- `sort_direction` 'ASC' | 'DESC'
- `page` integer
- `size` integer

## Response `200`

Successfully retrieves requests for payment matching query parameters.

- RippleNetNodeRequestsForPayment — Paged response for requests for payment includes:
  - `first` boolean — true if this is the first page.
  - `last` boolean — true if this is the last page.
  - `number` integer — page number
  - `numberOfElements` integer — Number Of elements in this request
  - `size` integer — page size
  - `totalElements` integer — Total number of elements for the given request
  - `totalPages` integer — Total number of pages for the given request
  - `sort` Sort[] — Sort details of this page
    - `direction` string — Direction of the sort
    - `property` string
    - `ignoreCase` boolean
    - `nullHandling` string
    - `ascending` boolean
    - `descending` boolean
  - `content` RippleNetNodeRequestForPayment[]
    - `request_for_payment_id` string, uuid, required — Unique identifier of a request for payment.
    - `request_for_payment_state` 'REQUESTED' | 'ACCEPTED' | 'FAILED', required — State of the request for payment.
    - `sender_address` string, required — RippleNet address of the node that is receiving the request for payment, or the eventual sender of the payment.
    - `receiver_address` string, required — RippleNet address of the node that is sending the request for payment, or the eventual receiver of the payment.
    - `amount` number, required — Amount requested to be paid.
    - `currency` string, required — Currency code for the `amount` value.
    - `quote_type` 'SENDER_AMOUNT' | 'RECEIVER_AMOUNT' | 'SENDER_INSTITUTION_AMOUNT' | 'RECEIVER_INSTITUTION_AMOUNT', required — Indicates how the amount field should be treated for calculating quote values.
    - `end_to_end_id` string — ID that the eventual payment receiver can specify. Persisted on all rippleNet Node instances (namely, the sender and receiver of the payment) that participate in the request for payment.
    - `user_info` RippleNetNodeRequestForPaymentUserInfo[], required — User-provided data with arbitrary key/value pairs.
      - `node_address` string, required — RippleNet address of the node that provided the user information.
      - `requested` UserInfoEntry[] — User information optionally provided when sending the request for payment.
        - `json` object, required — User information provided across the payment lifecycle stored as arbitrary JSON key/value pairs.
        - `created_at` string, date-time, required — Date and time at which the user information was added to the payment, as an ISO-8601 timestamp in UTC.
        - `subState` string — If provided, this parameter descibes payment state more granularly.
      - `accepted` UserInfoEntry[] — User information optionally provided when accepting the request for payment.
        - `json` object, required — User information provided across the payment lifecycle stored as arbitrary JSON key/value pairs.
        - `created_at` string, date-time, required — Date and time at which the user information was added to the payment, as an ISO-8601 timestamp in UTC.
        - `subState` string — If provided, this parameter descibes payment state more granularly.
      - `failed` UserInfoEntry[] — User information optionally provided when failing the request payment.
        - `json` object, required — User information provided across the payment lifecycle stored as arbitrary JSON key/value pairs.
        - `created_at` string, date-time, required — Date and time at which the user information was added to the payment, as an ISO-8601 timestamp in UTC.
        - `subState` string — If provided, this parameter descibes payment state more granularly.
    - `created_at` string, date-time, required — Date and time at which the request for payment was created, as an ISO-8601 timestamp in UTC.
    - `payment_id` string, uuid — Unique identifier of a payment associated to request for payment.

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)