Get payment node status

Request

Senders can query for the RippleNet instances (in a given payment chain) that have payments in the LOCKED state. This information is only stored on the sender's RippleNet instance.

Security

Bearer

Path

payment_idstring, (uuid)required

Unique identifier of the payment for which to get states on each node participating in the payment.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/payments/{payment_id}/node-status' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved payment states on each node participating in the payment.

Bodyapplication/json

Array [

paymentIdstring, (uuid)required

Unique identifier of the payment.

Example:"efdf213c-9f64-43f7-80ab-15e7b4d139ae"

paymentStatestringrequired

State of the payment. This API only recognizes payments in the LOCKED state. For more on payment states, see Payment States in the RippleNet Developer Guide.

Enum:"QUOTED""ACCEPTED""AWAITING_COLLECTION""COMPLETED""EXECUTED""FAILED""FORWARDED""LOCK_DECLINED""LOCKED""PREPARED"

Example:"LOCKED"

nodeAddressstringrequired

RippleNet address of the participating node reporting the payment state.

Example:"rn.eur.uk.london"

pathOrderinteger, (int32)required

Each node in the payment chain participates in sequence. Provides the order in the sequence in which this node participates.

Example:3

]

Response

[
  {
    "paymentId": "efdf213c-9f64-43f7-80ab-15e7b4d139ae",
    "paymentState": "LOCKED",
    "nodeAddress": "rn.eur.uk.london",
    "pathOrder": 3
  }
]