v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Request for payment

Get requests for payment

Gets requests for payment that match the query parameters.

get/request_for_payment

Query parameters

end_to_end_idstring

Optional parameter to filter results matching this endToEndId value.

state'REQUESTED' | 'ACCEPTED' | 'FAILED'

State by which to filter results.

sender_addressstring

Field to filter results matching this senderAddress value.

receiver_addressstring

Field to filter results matching this receiverAddress value.

payment_idstring uuid

Field to filter results matching this paymentId value.

beforestring

Filters for requests for payment whose range_field column value is before this specified time stamp (not inclusive). You can also specify after to create a time range between after and before. If before is specified, range_field must also be specified

afterstring

Filters for requests for payment whose range_field column value is after this specified time stamp (not inclusive). You can also specify before to create a time range between after and before. If after is specified, range_field must also be specified.

range_field'CREATED_AT' | 'MODIFIED_AT'

Designates the column name of the requests for payment database table that is used for filtering payments before/after/between time stamps. For example, if you specify range_field=MODIFIED_AT, you would specify a time stamp (in the 24 character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in request for payment objects) as the value for before and/or after to fetch request for payment before, after, or between the specified time range(s) (not inclusive). If range_field is specified, before and/or after must also be specified.

sort_field'CREATED_AT' | 'MODIFIED_AT'

Field to use to sort results.

sort_direction'ASC' | 'DESC'

Sorts result according to the specified direction.

pageinteger

Zero-based index of the page number of results.

sizeinteger

The number of payments per page.

Response

Successfully retrieves requests for payment matching query parameters.

firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

Example response

{
  "sort": [
    {
      "direction": "ASC",
      "nullHandling": "NULLS_FIRST",
      "ascending": true
    }
  ],
  "content": [
    {
      "request_for_payment_id": "1bf93760-ef69-4697-b2b4-47d9e1c42aa7",
      "request_for_payment_state": "REQUESTED",
      "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      "receiver_address": "trans_gbp_lon@rn.eur.uk.london",
      "amount": 100.01,
      "currency": "USD",
      "quote_type": "SENDER_AMOUNT",
      "user_info": [
        {
          "requested": [
            {
              "subState": "EXECUTING"
            }
          ],
          "accepted": [
            {
              "subState": "EXECUTING"
            }
          ],
          "failed": [
            {
              "subState": "EXECUTING"
            }
          ]
        }
      ],
      "payment_id": "5492648d-2132-4e70-9ded-2fc86f22b321"
    }
  ]
}