Ripple Labs Payout method API
Payout Method operations let receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods.| Operation | Method | Description || -- | -- | -- || [Create payout method](/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/createpayoutmethod) | POST | Creates a payout method. For example, `LOCAL_RAILS`. || [Get payout methods](/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getpayoutmethods) | GET | Returns a list of payout methods created by a receiving partner. || [Get payout method by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getpayoutmethodbyid) | GET | Returns a payout method by its ID. || [Update payout method](/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/updatepayoutmethod) | PUT | Updates a payout method. || [Delete payout method](/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/deletepayoutmethod) | DELETE | Deletes a payout method. || [Get all categories](/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getallcategories) | GET | Returns all the payout method categories. |
Ripple Labs Payout method 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 Payout method. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 6 operations across 3 paths, and defines 6 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 Payout method 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 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Payout Method operations let receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods. | Operation | Method | Description | |…
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Page (8 properties), RippleNetProblem (6 properties), PayoutMethodResponse (6 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.