Create payment expiry

Request

Creates a payment expiration window, or time to live (ttl), in seconds.

Security

Bearer

Bodyapplication/jsonrequired

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment creation timestamp.

Example:5900

sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

Example:"rn.us.ca.san_francisco"

receiving_partnerstring

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example:"rn.us.tx.austin"

currencystring

currency of the exchange rate.

Example:"USD"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/config/payments/payment_expiries \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_ttl": 5900,
    "sending_partner": "rn.us.ca.san_francisco",
    "receiving_partner": "rn.us.tx.austin",
    "currency": "USD"
  }'

Responses

Successfully created the payment expiration window.

Bodyapplication/json