You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

get-payment-channel.json 2.0KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. {
  2. "$schema": "http://json-schema.org/draft-04/schema#",
  3. "title": "getPaymentChannel",
  4. "type": "object",
  5. "properties": {
  6. "account": {
  7. "$ref": "address",
  8. "description": "Address that created the payment channel."
  9. },
  10. "destination": {
  11. "$ref": "address",
  12. "description": "Address to receive XRP claims against this channel."
  13. },
  14. "amount": {
  15. "$ref": "value",
  16. "description": "The total amount of XRP funded in this channel."
  17. },
  18. "balance": {
  19. "$ref": "value",
  20. "description": "The total amount of XRP delivered by this channel."
  21. },
  22. "settleDelay": {
  23. "type": "number",
  24. "description": "Amount of seconds the source address must wait before closing the channel if it has unclaimed XRP."
  25. },
  26. "expiration": {
  27. "type": "string",
  28. "format": "date-time",
  29. "description": "Time when this channel expires."
  30. },
  31. "publicKey": {
  32. "$ref": "publicKey",
  33. "description": "Public key of the key pair the source uses to sign claims against this channel."
  34. },
  35. "cancelAfter": {
  36. "type": "string",
  37. "format": "date-time",
  38. "description": "Time when this channel expires as specified at creation."
  39. },
  40. "sourceTag": {
  41. "$ref": "tag",
  42. "description": "Source tag."
  43. },
  44. "destinationTag": {
  45. "$ref": "tag",
  46. "description": "Destination tag."
  47. },
  48. "previousAffectingTransactionID": {
  49. "$ref": "hash256",
  50. "description": "Hash value representing the most recent transaction that affected this payment channel."
  51. },
  52. "previousAffectingTransactionLedgerVersion": {
  53. "$ref": "ledgerVersion",
  54. "description": "The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in."
  55. }
  56. },
  57. "required": [
  58. "account",
  59. "destination",
  60. "amount",
  61. "balance",
  62. "settleDelay",
  63. "previousAffectingTransactionID",
  64. "previousAffectingTransactionLedgerVersion"
  65. ],
  66. "additionalProperties": false
  67. }