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-paths.json 2.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. {
  2. "$schema": "http://json-schema.org/draft-04/schema#",
  3. "title": "getPathsParameters",
  4. "type": "object",
  5. "properties": {
  6. "pathfind": {
  7. "description": "Specification of a pathfind request.",
  8. "properties": {
  9. "source": {
  10. "description": "Properties of the source of funds.",
  11. "type": "object",
  12. "properties": {
  13. "address": {
  14. "$ref": "address",
  15. "description": "The XRP Ledger address of the planned sender."
  16. },
  17. "amount": {
  18. "$ref": "laxAmount",
  19. "description": "The amount of funds to send."
  20. },
  21. "currencies": {
  22. "description": "An array of currencies (with optional counterparty) that may be used in the payment paths.",
  23. "type": "array",
  24. "items": {
  25. "description": "A currency with optional counterparty.",
  26. "type": "object",
  27. "properties": {
  28. "currency": {"$ref": "currency"},
  29. "counterparty": {
  30. "$ref": "address",
  31. "description": "The counterparty for the currency; if omitted any counterparty may be used."
  32. }
  33. },
  34. "required": ["currency"],
  35. "additionalProperties": false
  36. },
  37. "uniqueItems": true
  38. }
  39. },
  40. "not": {
  41. "required": ["amount", "currencies"]
  42. },
  43. "additionalProperties": false,
  44. "required": ["address"]
  45. },
  46. "destination": {
  47. "description": "Properties of the destination of funds.",
  48. "type": "object",
  49. "properties": {
  50. "address": {
  51. "$ref": "address",
  52. "description": "An address representing the destination of the transaction."
  53. },
  54. "amount": {
  55. "$ref": "laxLaxAmount",
  56. "description": "The amount to be received by the receiver (`value` may be ommitted if a source amount is specified)."
  57. }
  58. },
  59. "required": ["address", "amount"],
  60. "additionalProperties": false
  61. }
  62. },
  63. "required": ["source", "destination"],
  64. "additionalProperties": false
  65. }
  66. },
  67. "additionalProperties": false,
  68. "required": ["pathfind"]
  69. }