Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Payment expiration API

Use these operations to manage payment expirations.| Operation | Method | Description || -- | -- | -- || [Get payment expiry by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/getpaymentexpirybyid) | GET | Gets the time to live (ttl) of a payment expiry in seconds. || [Update payment expiry](/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/updatepaymentexpiry) | PUT | Updates the time to live (ttl) of a payment expiry in seconds. || [Delete payment expiry](/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/deletepaymentexpiry) | DELETE | Deletes a payment expiry. || [Get payment expiries](/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/getpaymentexpiries) | GET | Returns all configured payment expiries. || [Create payment expiry](/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/createpaymentexpiry) | POST | Creates a payment expiration window, or time to live (ttl), in seconds. |

Ripple Labs Payment expiration 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 Payment expiration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 2 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.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ripple Labs Payment expiration 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment expiration 5

Use these operations to manage payment expirations. | Operation | Method | Description | | -- | -- | -- | | [Get payment expiry by ID](/products/payments-odl/api-docs/ripplenet/re…

GET
/config/payments/payment_expiries/{payment_expiry_id}
Get payment expiry by ID
getPaymentExpiryById 1 param → 200400
PUT
/config/payments/payment_expiries/{payment_expiry_id}
Update payment expiry
updatePaymentExpiry 1 param body → 200400
DELETE
/config/payments/payment_expiries/{payment_expiry_id}
Delete payment expiry
deletePaymentExpiry 1 param → 200400
GET
/config/payments/payment_expiries
Get payment expiries
getPaymentExpiries 2 params → 200400
POST
/config/payments/payment_expiries
Create payment expiry
createPaymentExpiry body → 200400

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), Sort (6 properties), PaymentExpiryResponse (5 properties). Each schema is shown below with its type and property counts.

Sort
object
6 properties
PaymentExpiry
object
Use this JSON request object to update the payment time to live represented in seconds.
4 properties
Page
object
Paginated response base object.
8 properties
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
PaymentExpiries
Provides a content array of payment expiry objects and a set of pagination information fields.
PaymentExpiryResponse
object
Use this JSON request object to update the payment time to live represented in seconds.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-payment-expiration-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API