Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Payment expiration

Create payment expiry

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

post/config/payments/payment_expiries

Request body

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.

sending_partnerstring

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

receiving_partnerstring

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

currencystring

currency of the exchange rate.

Example request

{
  "payment_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD"
}

Response

Successfully created the payment expiration window.

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.

sending_partnerstring

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

receiving_partnerstring

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

currencystring

currency of the exchange rate.

expiry_idstring uuid

id of payment expiry object

Example response

{
  "payment_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "expiry_id": "4711728c-cd35-49ec-96a5-72732b4333ec"
}