Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Non-orchestration payments

Get payment node status

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

get/payments/{payment_id}/node-status

Path parameters

payment_idstring uuid required

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

Response

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

paymentIdstring uuid required

Unique identifier of the payment.

paymentState'QUOTED' | 'ACCEPTED' | 'AWAITING_COLLECTION' | 'COMPLETED' | 'EXECUTED' | 'FAILED' | 'FORWARDED' | 'LOCK_DECLINED' | 'LOCKED' | 'PREPARED' | 'RETURNED' | 'SETTLEMENT_DECLINED' required

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

nodeAddressstring required

RippleNet address of the participating node reporting the payment state.

pathOrderinteger required

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

Example response

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