Ripple Labs Request for payment API
Use these operations to interact with your payment requests.| Operation | Method | Description || -- | -- | -- || [Get requests for payment](/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/getrequestsforpayment) | GET | Gets requests for payment that match the query parameters. || [Send request for payment](/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/sendrequestforpayment) | POST | Sends a new request for payment. || [Get request for payment by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/getrequestforpaymentbyid) | GET | Gets a request for payment by request for payment ID. || [Accept request for payment](/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/acceptrequestforpayment) | POST | Accepts a request for payment. || [Fail request for payment](/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/failrequestforpayment) | POST | Fails a request for payment. |
Ripple Labs Request for payment API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Request for payment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 5 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2.0.
Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs Request for payment API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (TokenAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Use these operations to interact with your payment requests. | Operation | Method | Description | | -- | -- | -- | | [Get requests for payment](/products/payments-odl/api-docs/rip…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are RippleNetNodeRequestForPayment (11 properties), Page (8 properties), RippleNetNodeRequestForPaymentRequest (7 properties), Sort (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.