{"items":[{"type":"link","label":"Smart Liquidation API","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi","content":{"contentType":"overview","meta":{"name":"Smart Liquidation API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Smart Liquidation API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":{"$$mdtype":"Variable","path":["env","PUBLIC_VAR_SL"]}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service splits large XRP liquidations into smaller liquidations over a specified time period. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../ripplenet/system-components/liquidation/smart-liquidation/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Smart Liquidation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check out the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../ripplenet/best-practices/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"best practices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../ripplenet/tutorials/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tutorials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API operations require a bearer access token for your target environment."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request the access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/api-environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":{"$$mdtype":"Variable","path":["env","PUBLIC_VAR_SLAPI"]}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assigns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[domainPrefix]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on the environment. Your tenant information is automatically derived from your API credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Prefix"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liquidation-test.pub.prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenet.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"div","attrs":{"style":{"fontSize":"13px","fontFamily":"'Red Hat Mono'","!important":""}}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liquidation-test.pub.prod.ripplenet.com"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liquidation.pub.prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenet.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liquidation.pub.prod.ripplenet.com"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about base URLs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/baseurls/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API base URLs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/api-environments"}]}]}},{"type":"link","label":"Authentication","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/authentication","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/authentication","content":null},{"type":"link","label":"API environments","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/api-environments","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/api-environments","content":null},{"type":"group","label":"Liquidations","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations","items":[{"type":"link","label":"Authentication with Smart Liquidation Service","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/authentication-with-smart-liquidation-service","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/authentication-with-smart-liquidation-service","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Authentication with Smart Liquidation Service"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"liquidations/authentication-with-smart-liquidation-service"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication with Smart Liquidation Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API operations require a bearer access token for your target environment."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/#request-the-access-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request the access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Domain prefixes with Smart Liquidation Service","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/domain-prefixes-with-smart-liquidation-service","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/domain-prefixes-with-smart-liquidation-service","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Domain prefixes with Smart Liquidation Service"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"liquidations/domain-prefixes-with-smart-liquidation-service"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain prefixes with Smart Liquidation Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Prefix"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request URL"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liquidation-test.pub.prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://liquidation-test.pub.prod.ripplenet.com"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liquidation.pub.prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://liquidation.pub.prod.ripplenet.com"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"label":"Get liquidations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidations","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidations","metadata":{"seo":{"title":"Get liquidations","description":"List all liquidations by date range"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLiquidations","name":"Get liquidations","isWebhook":false,"pointer":"/paths/~1liquidations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get liquidations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all liquidations by date range"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date (inclusive) of first activity. Specified in ISO-8601 format, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]}]}]}]},{"name":"end_date","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date (exclusive) of last activity. Specified in ISO-8601 format, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]}]}]}]},{"name":"payment_id","in":"query","explode":true,"schemaId":"schema_1","description":"RippleNet payment ID(s)"},{"name":"reference_id","in":"query","explode":true,"schemaId":"schema_2","description":"Unique reference ID(s)"},{"name":"status","in":"query","schemaId":"schema_3","description":"Liquidation status"},{"name":"page","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_5","description":"Number of liquidations to return per page."}],"pointer":"/paths/~1liquidations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/liquidations","servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"start_date","in":"query","schemaId":"schema_0"},{"name":"end_date","in":"query","schemaId":"schema_0"},{"name":"payment_id","in":"query","schemaId":"schema_1","explode":true},{"name":"reference_id","in":"query","schemaId":"schema_2","explode":true},{"name":"status","in":"query","schemaId":"schema_3"},{"name":"page","in":"query","schemaId":"schema_4"},{"name":"size","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/liquidations","href":"liquidations/getliquidations","openApiOperationId":"getLiquidations","summary":"Get liquidations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a paginated list of liquidations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationListResponse"}},"schemaId":"components/schemas/LiquidationListResponse"},{"code":"400","description":"Bad liquidation request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Authorization has expired for user to get liquidations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/401/content/application~1json/examples/response"]},{"code":"403","description":"User is not authorized to get all liquidations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/403/content/application~1json/examples/response"]}],"pointer":"/paths/~1liquidations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LiquidationListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/401/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations/get/responses/403/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/getliquidations"}],"panels":[]}]},"httpPath":"/liquidations"},{"label":"Get liquidation by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationbyid","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationbyid","metadata":{"seo":{"title":"Get liquidation by Id","description":"Get a specific liquidation by its unique Id value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLiquidationById","name":"Get liquidation by Id","isWebhook":false,"pointer":"/paths/~1liquidations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get liquidation by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific liquidation by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the liquidation. Obtain this value by performing a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLiquidations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET liquidations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1liquidations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/liquidations/{id}","servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/liquidations/{id}","href":"liquidations/getliquidationbyid","openApiOperationId":"getLiquidationById","summary":"Get liquidation by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a liquidation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Liquidation"}},"schemaId":"components/schemas/Liquidation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Authorization has expired for user to get liquidations by ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/401/content/application~1json/examples/response"]},{"code":"403","description":"User is not authorized to get liquidation by ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/403/content/application~1json/examples/response"]},{"code":"404","description":"Liquidation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/404/content/application~1json/examples/response"]}],"pointer":"/paths/~1liquidations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Liquidation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Liquidation"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/403/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/getliquidationbyid"}],"panels":[]}]},"httpPath":"/liquidations/{id}"},{"label":"Get liquidations by payment Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationsbyripplenetpaymentid","routeSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationsbyripplenetpaymentid","metadata":{"seo":{"title":"Get liquidations by payment Id","description":"Get a list of liquidations associated with a ripplenet_payment_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLiquidationsByRipplenetPaymentId","name":"Get liquidations by payment Id","isWebhook":false,"pointer":"/paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get liquidations by payment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of liquidations associated with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenet_payment_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ripplenet_payment_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for a RippleNet payment. Obtain this value by performing a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLiquidations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET liquidations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/liquidations/ripplenet-payment-id/{ripplenet_payment_id}","servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"parameters":{"path":[{"name":"ripplenet_payment_id","in":"path","required":true,"schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/liquidations/ripplenet-payment-id/{ripplenet_payment_id}","href":"liquidations/getliquidationsbyripplenetpaymentid","openApiOperationId":"getLiquidationsByRipplenetPaymentId","summary":"Get liquidations by payment Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of liquidations associated with the given ripplenet_payment_id"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Authorization has expired for user to get liquidations by Ripplenet Payment ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/401/content/application~1json/examples/response"]},{"code":"403","description":"User is not authorized to get liquidations by Ripplenet Payment ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/403/content/application~1json/examples/response"]}],"pointer":"/paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/403/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/getliquidationsbyripplenetpaymentid"}],"panels":[]}]},"httpPath":"/liquidations/ripplenet-payment-id/{ripplenet_payment_id}"}],"content":{"contentType":"group","meta":{"name":"Liquidations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Liquidations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to retrieve liquidations from the Smart Liquidation service."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLiquidations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get liquidations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all liquidations by date range."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLiquidationById"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get liquidation by Liquidation Id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a liquidation by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLiquidationsByRipplenetPaymentId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get liquidation by RippleNet Payment Id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a liquidation by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenet_payment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To configure liquidation, contact your RippleNet liaison."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/liquidations","summary":"Get liquidations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidations/getliquidations","deprecated":false},{"title":"/liquidations/{id}","summary":"Get liquidation by Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidations/getliquidationbyid","deprecated":false},{"title":"/liquidations/ripplenet-payment-id/{ripplenet_payment_id}","summary":"Get liquidations by payment Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidations/getliquidationsbyripplenetpaymentid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","required":["title","status"],"properties":{"type":{"$ref":"#/components/schemas/ErrorCodeEnum"},"title":{"type":"string","description":"Summary of the returned problem."},"status":{"type":"integer","description":"HTTP error code."},"detail":{"type":"string","description":"Description of the returned problem."},"correlationId":{"type":"string","description":"ID of the correlating request."},"timestamp":{"type":"string","description":"Date and time at which the error occured."},"liquidationId":{"type":"string","description":"Unique identifier of the liquidation."}}}},"components/schemas/ErrorCodeEnum":{"id":"components/schemas/ErrorCodeEnum","kind":"json-schema","title":"ErrorCodeEnum","data":{"type":"string","description":"Type of problem.","enum":["BAD_REQUEST","INVALID_DATES","INVALID_VENUE_AND_OR_CURRENCY","INVALID_LIQUIDATION_AMOUNT","NOT_FOUND","REFERENCE_ID_NOT_UNIQUE","AUTH_PROBLEM","GENERIC_CLIENT_ERROR","GENERIC_SERVER_ERROR"]}},"components/schemas/TradingSummary":{"id":"components/schemas/TradingSummary","kind":"json-schema","title":"TradingSummary","data":{"type":"object","description":"The trading summary","properties":{"total_fiat_executed":{"type":"number","format":"decimal","description":"the total amount of successfully delivered fiat"},"total_fiat_in_flight":{"type":"number","format":"decimal","description":"the total amount of fiat in flight (started but not yet finished trades)"},"total_fiat_non_deliverable":{"type":"number","format":"decimal","description":"the total amount of fiat that was not successfully confirmed to have been delivered due to unknown trade failures"},"total_fiat_remaining_deliverable":{"type":"number","format":"decimal","description":"the total amount of fiat that has not yet been delivered but is eligible to be delivered"}}}},"components/schemas/LiquidationListResponse":{"id":"components/schemas/LiquidationListResponse","kind":"json-schema","title":"LiquidationListResponse","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Array of all liquidation objects that match the specified query parameters, if any","items":{"$ref":"#/components/schemas/LiquidationSummary"}}}}]}},"components/schemas/LiquidationSummary":{"id":"components/schemas/LiquidationSummary","kind":"json-schema","title":"LiquidationSummary","data":{"allOf":[{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/LiquidationRequest"},{"type":"object","required":["id","status","liquidation_source"],"properties":{"liquidation_source":{"$ref":"#/components/schemas/LiquidationSourceEnum"},"status":{"$ref":"#/components/schemas/LiquidationStatusEnum"}}}]}},"components/schemas/Liquidation":{"id":"components/schemas/Liquidation","kind":"json-schema","title":"Liquidation","data":{"allOf":[{"$ref":"#/components/schemas/LiquidationSummary"},{"type":"object","required":["trade_requests","execution_summary"],"properties":{"status":{"$ref":"#/components/schemas/LiquidationStatusEnum"},"trade_requests":{"type":"array","description":"An array of trade objects representing the trades of the liquidation","items":{"$ref":"#/components/schemas/LiquidationTrade"}},"execution_strategy":{"$ref":"#/components/schemas/ExecutionStrategy"},"execution_summary":{"$ref":"#/components/schemas/ExecutionSummary"},"trading_summary":{"$ref":"#/components/schemas/TradingSummary"}}}]}},"components/schemas/LiquidationRequest":{"id":"components/schemas/LiquidationRequest","kind":"json-schema","title":"LiquidationRequest","data":{"type":"object","required":["unique_reference_id","destination_venue","destination_currency","destination_amount","bridge_currency_code"],"properties":{"unique_reference_id":{"type":"string","description":"The unique 32-character string representing the liquidation"},"ripplenet_payment_id":{"type":"string","format":"uuid","description":"Unique identifier for a RippleNet payment"},"ripplenet_payment_created_at":{"description":"Timestamp when the RippleNet payment was created","type":"string","format":"date-time"},"ripplenet_sender_address":{"description":"RippleNet address of the sender","type":"string","example":"sf_gbp@rn.us.ca.san_francisco"},"ripplenet_receiver_address":{"description":"RippleNet address of the receiver","example":"sf_gbp@rn.us.ca.san_francisco","type":"string"},"destination_amount":{"description":"The total amount available for withdrawal after all fees have been collected","type":"number","format":"decimal","example":10000},"destination_currency":{"type":"string","description":"The 3-letter currency code of the destination currency","example":"usd"},"destination_venue":{"type":"string","description":"The name of the exchange where XRP is liquidated into fiat currency","example":"bitso"},"estimate_type":{"$ref":"#/components/schemas/EstimateTypeEnum"},"expires_at":{"type":"string","description":"The expiration time of the liquidation","format":"date-time","example":"2018-04-06T20:33:35Z"}}}},"components/schemas/OperatorLiquidationRequest":{"id":"components/schemas/OperatorLiquidationRequest","kind":"json-schema","title":"OperatorLiquidationRequest","data":{"type":"object","required":["unique_reference_id","destination_amount","ripplenet_payment_id"],"properties":{"unique_reference_id":{"type":"string"},"ripplenet_payment_id":{"type":"string","format":"uuid"},"destination_amount":{"type":"number","format":"decimal"},"expires_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z"}}}},"components/schemas/LiquidationTrade":{"id":"components/schemas/LiquidationTrade","kind":"json-schema","title":"LiquidationTrade","data":{"allOf":[{"$ref":"#/components/schemas/Entity"},{"type":"object","required":["sequence_number","destination_venue","destination_currency","destination_amount","status","expires_at","liquidation_id","account_id","trade_executions","bridge_currency_code"],"properties":{"liquidation_id":{"type":"string","description":"The identifier of the liquidation"},"sequence_number":{"type":"integer","description":"The sequence number of the liquidation trade"},"odl_payment_id":{"type":"string","description":"The identifier of the ODL payment corresponding to the liquidation"},"status":{"$ref":"#/components/schemas/LiquidationTradeStatusEnum"},"bridge_currency_code":{"type":"string","x-interal":true},"destination_amount":{"type":"number","format":"decimal","description":"The total amount available for withdrawal after all fees have been collected"},"destination_currency":{"type":"string","description":"The 3-letter currency code of the destination currency of the trade"},"destination_venue":{"type":"string","description":"The name of the trade exchange where XRP is liquidated into fiat currency"},"expires_at":{"type":"string","description":"The expiration time of the liquidation trade","format":"date-time","example":"2018-04-06T20:33:35Z"},"xrp_deposit_amount":{"type":"number","description":"The XRP deposit amount of the trade","format":"decimal"},"trade_executions":{"type":"array","description":"The trade execution objects","items":{"$ref":"#/components/schemas/TradeExecution"}},"error_message":{"type":"string","description":"The reason why a trade failed"},"estimated_trade_displacement_bps":{"type":"integer","description":"trade displacement bps in estimate"}}}]}},"components/schemas/TradeExecution":{"id":"components/schemas/TradeExecution","kind":"json-schema","title":"TradeExecution","data":{"allOf":[{"$ref":"#/components/schemas/Entity"},{"type":"object","required":["trade_request_id","venue"],"properties":{"trade_request_id":{"type":"string","description":"The identifier of the trade request"},"venue":{"type":"string","description":"The exchange used by this trade"},"venue_id":{"type":"string","description":"The mapped id for the exchange used by this trade"},"amount":{"type":"number","format":"decimal","description":"The amount of XRP sent by this trade"},"adjusted_amount":{"type":"number","format":"decimal","description":"The adjusted amount of XRP sent by this trade"},"proceeds":{"type":"number","format":"decimal","description":"The amount of XRP liquidated"},"adjusted_proceeds":{"type":"number","format":"decimal","description":"The adjusted amount of XRP liquidated"},"start_date":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Start date (inclusive) of last activity"},"end_date":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Start date (inclusive) of last activity"},"incentive_type":{"type":"string","description":"The type of incentive (also called slippage)"},"incentive_value":{"type":"number","format":"decimal","description":"Amount of incentive (also called slippage) used"},"is_pushed_forward":{"type":"boolean","description":"True if the funds from a failed trade will be made available in fiat currency"},"adjusted_trade_difference":{"type":"number","description":"The trade amount including incentives"},"executed_slippage_bps":{"type":"integer"}}}]}},"components/schemas/ExecutionStrategy":{"id":"components/schemas/ExecutionStrategy","kind":"json-schema","title":"ExecutionStrategy","data":{"type":"object","description":"The trade execution strategy","required":["maxAmountPerTrade","minimumTradeInterval"],"properties":{"maxAmountPerTrade":{"type":"number","format":"decimal","description":"The maximum amount (in destination currency) per trade"},"minimumTradeInterval":{"type":"integer","description":"The minimum interval (in seconds) between creation of trades"}}}},"components/schemas/BridgeAssetPrioritizationRequest":{"id":"components/schemas/BridgeAssetPrioritizationRequest","kind":"json-schema","title":"BridgeAssetPrioritizationRequest","data":{"type":"object","properties":{"sender_id":{"type":"string","description":"A unique identifier for the customer sending the funds"},"receiver_id":{"type":"string","description":"A unique identifier for the customer receiving the funds"},"bridge_asset_prioritization_options":{"type":"array","items":{"$ref":"#/components/schemas/BridgeAssetPrioritizationOption"},"description":"Describes the different bridge assets to pick from"}},"required":["sending_tenant_id","receiving_tenant_id","bridge_asset_prioritization_options"]}},"components/schemas/BridgeAssetPrioritizationOption":{"id":"components/schemas/BridgeAssetPrioritizationOption","kind":"json-schema","title":"BridgeAssetPrioritizationOption","data":{"properties":{"bridge_currency_code":{"type":"string"},"bridge_currency_amount":{"type":"number","format":"decimal"},"destination_exchange":{"type":"string"},"destination_currency_code":{"type":"string"},"destination_currency_amount":{"type":"number","format":"decimal"},"digital_asset_origination":{"type":"boolean","description":"Whether Wallet Send will be used"}},"required":["bridge_currency_code","bridge_currency_amount","destination_exchange","destination_currency_code","destination_currency_amount","digital_asset_origination"]}},"components/schemas/BridgeAssetPrioritizationResponse":{"id":"components/schemas/BridgeAssetPrioritizationResponse","kind":"json-schema","title":"BridgeAssetPrioritizationResponse","data":{"properties":{"prioritized_bridge_asset_liquidation_options":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/BridgeAssetSelection"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sorted list prioritizing which bridge assets to use from BridgeAssetPrioritizationRequest#bridge_asset_liquidation_options. Some options may be missing if they shouldn't be used."},"children":[]}]}]}]}},"required":["prioritized_bridge_asset_liquidation_options"]}},"components/schemas/BridgeAssetSelection":{"id":"components/schemas/BridgeAssetSelection","kind":"json-schema","title":"BridgeAssetSelection","data":{"properties":{"selected_index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zero-based index from the BridgeAssetPrioritizationRequest#bridge_asset_liquidation_options list"},"children":[]}]}]}]}},"required":["selected_index"]}},"components/schemas/Entity":{"id":"components/schemas/Entity","kind":"json-schema","title":"Entity","data":{"type":"object","required":["id","account_id","created_at","modified_at"],"properties":{"id":{"type":"string","description":"Unique liquidation identifier","format":"uuid"},"account_id":{"type":"string","description":"The identifier of the account requesting the liquidation"},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date specified in ISO-8601 format, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-04-06T20:33:35Z"},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"},"modified_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date specified in ISO-8601 format, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-04-06T20:33:35Z"},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"}}}},"components/schemas/ExecutionSummary":{"id":"components/schemas/ExecutionSummary","kind":"json-schema","title":"ExecutionSummary","data":{"type":"object","description":"The trade execution summary","required":["total_xrp","total_fiat","total_slippage","total_trades","total_sender_fees","total_receiver_fees"],"properties":{"total_xrp":{"type":"number","format":"decimal","description":"Total amount of XRP successfully liquidated"},"total_fiat":{"type":"number","format":"decimal","description":"Total fiat amount available for withdrawal after all fees have been collected"},"total_slippage":{"type":"number","format":"decimal","description":"Total amount of slippage (also called incentive) used"},"total_sender_fees":{"type":"number","format":"decimal","description":"Total XRP sender fees"},"total_receiver_fees":{"type":"number","format":"decimal","description":"Total fiat receiver fees"},"total_trades":{"type":"integer","description":"The total number of exchange orders/trades completed"},"fx_rate":{"type":"number","format":"decimal","description":"The conversion rate from XRP to destination currency (fiat)"},"incentive_type":{"type":"string"}}}},"components/schemas/LiquidationStatusEnum":{"id":"components/schemas/LiquidationStatusEnum","kind":"json-schema","title":"LiquidationStatusEnum","data":{"type":"string","enum":["CREATED","QUEUED","STARTED","COMPLETED","PARTIALLY_COMPLETED","FAILED"]}},"components/schemas/LiquidationTradeStatusEnum":{"id":"components/schemas/LiquidationTradeStatusEnum","kind":"json-schema","title":"LiquidationTradeStatusEnum","data":{"type":"string","enum":["CREATED","QUEUED","THROTTLED","QUOTED","STARTED","COMPLETED","PARTIALLY_COMPLETED","FAILED","FAILED_RETRYABLE"]}},"components/schemas/LiquidationSourceEnum":{"id":"components/schemas/LiquidationSourceEnum","kind":"json-schema","title":"LiquidationSourceEnum","data":{"type":"string","enum":["xrrn","operator"]}},"components/schemas/EstimateTypeEnum":{"id":"components/schemas/EstimateTypeEnum","kind":"json-schema","title":"EstimateTypeEnum","data":{"type":"string","enum":["firm","indicative"]}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","required":["first","last","number","numberOfElements","size","totalElements","totalPages","sort"],"properties":{"first":{"type":"boolean","description":"True if this is the first page"},"last":{"type":"boolean","description":"True if this is the last page"},"number":{"type":"integer","description":"Page number"},"numberOfElements":{"type":"integer","description":"Number of elements in this request"},"size":{"type":"integer","description":"Number of objects returned per page"},"totalElements":{"type":"integer","description":"Total number of elements for the given request","format":"int64"},"totalPages":{"type":"integer","description":"Total number of pages for the given request"},"sort":{"type":"array","description":"Sort details of this page","items":{"$ref":"#/components/schemas/Sort"}}},"description":"Paginated response base object"}},"components/schemas/Sort":{"id":"components/schemas/Sort","kind":"json-schema","title":"Sort","data":{"type":"object","properties":{"direction":{"type":"string","description":"Direction of the sort","example":"ASC"},"property":{"type":"string","description":"Property name to sort on"},"ascending":{"type":"boolean","description":"True if the sort direction is ascending","example":true},"descending":{"type":"boolean","description":"True if the sort direction is descending","example":false}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":200,"default":50},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Liquidation"}},"id":"schema_7"}},"exampleStore":{"paths/~1liquidations/get/responses/400/content/application~1json/examples/response":{"value":{"type":"BAD_REQUEST","title":"Bad Request","status":400,"detail":"JSON parse error: problem: Cannot build LiquidationRequest, some of required attributes are not set [destinationVenue]","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations/get/responses/400/content/application~1json/examples/response"},"paths/~1liquidations/get/responses/401/content/application~1json/examples/response":{"value":{"type":"AUTH_PROBLEM","title":"Unauthorized","status":401,"detail":"An error occurred while attempting to decode the Jwt: Expired JWT","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations/get/responses/401/content/application~1json/examples/response"},"paths/~1liquidations/get/responses/403/content/application~1json/examples/response":{"value":{"type":"AUTH_PROBLEM","title":"Forbidden","status":403,"detail":"Could not verify the provided CSRF token because no token was found to compare.","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations/get/responses/403/content/application~1json/examples/response"},"paths/~1liquidations~1{id}/get/responses/400/content/application~1json/examples/response":{"value":{"type":"BAD_REQUEST","title":"Bad Request","status":400,"detail":"JSON parse error: problem: Cannot build LiquidationRequest, some of required attributes are not set [destinationVenue]","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1{id}/get/responses/400/content/application~1json/examples/response"},"paths/~1liquidations~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"type":"AUTH_PROBLEM","title":"Unauthorized","status":401,"detail":"An error occurred while attempting to decode the Jwt: Expired JWT","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1liquidations~1{id}/get/responses/403/content/application~1json/examples/response":{"value":{"type":"AUTH_PROBLEM","title":"Forbidden","status":403,"detail":"Could not verify the provided CSRF token because no token was found to compare.","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1{id}/get/responses/403/content/application~1json/examples/response"},"paths/~1liquidations~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"type":"NOT_FOUND","title":"Liquidation not found","status":404,"detail":"Liquidation 'c2812c43-0874-42e6-b1b1-27e07b2bb1e5' not found","liquidationId":"c2812c43-0874-42e6-b1b1-27e07b2bb1e5","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/400/content/application~1json/examples/response":{"value":{"type":"BAD_REQUEST","title":"Bad Request","status":400,"detail":"JSON parse error: problem: Cannot build LiquidationRequest, some of required attributes are not set [destinationVenue]","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/400/content/application~1json/examples/response"},"paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/401/content/application~1json/examples/response":{"value":{"type":"AUTH_PROBLEM","title":"Unauthorized","status":401,"detail":"An error occurred while attempting to decode the Jwt: Expired JWT","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/401/content/application~1json/examples/response"},"paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/403/content/application~1json/examples/response":{"value":{"type":"AUTH_PROBLEM","title":"Forbidden","status":403,"detail":"Could not verify the provided CSRF token because no token was found to compare.","correlationId":"b99decdd-0fe2-4f4c-bb6a-f7b6d60aee1c","timestamp":"2018-04-06T20:33:35Z"},"key":"response","summary":"response","id":"paths/~1liquidations~1ripplenet-payment-id~1{ripplenet_payment_id}/get/responses/403/content/application~1json/examples/response"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"apiKey","in":"header","paramName":"Authorization"}},"specVersion":"3.2.0","servers":[{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://liquidation-test.pub.prod.ripplenet.com"},{"url":"https://liquidation.pub.prod.ripplenet.com","description":"Production environment"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"}]},"schemasExpansionLevel":3,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideDownloadButtons":true,"mockServer":{"url":"/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/payments-odl/api-docs/smart_liquidation/reference/openapi.json?download"},{"url":"/_bundle/products/payments-odl/api-docs/smart_liquidation/reference/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Smart Liquidation API","description":"The {% $env.PUBLIC_VAR_SL %} service splits large XRP liquidations into smaller liquidations over a specified time period. For more information, see [Smart Liquidation](../../ripplenet/system-components/liquidation/smart-liquidation/).\n\nCheck out the [best practices](../../ripplenet/best-practices/) and [tutorials](../../ripplenet/tutorials/).\n\n### Authentication\n\nAll API operations require a bearer access token for your target environment.<br>Learn how to [request the access token](../../ripplenet/best-practices/authentication/).\n\n### API environments\n\nThe {% $env.PUBLIC_VAR_SLAPI %} assigns a `[domainPrefix]` based on the environment. Your tenant information is automatically derived from your API credentials. \n\n| Environment  | Domain Prefix |\tDomain | Base URL|\n| --- | --- | --- | --- |\n| Test | `liquidation-test.pub.prod` | `ripplenet.com` | <div style=\"font-size: 13px;font-family:'Red Hat Mono'; !important\">`liquidation-test.pub.prod.ripplenet.com`</div> |\n| Production | `liquidation.pub.prod` | `ripplenet.com` | `liquidation.pub.prod.ripplenet.com` |\n\nFor more information about base URLs, see [API base URLs](/products/payments-odl/api-docs/ripplenet/best-practices/baseurls/)."}},"baseSlug":"/products/payments-odl/api-docs/smart_liquidation/reference/openapi","routesMapping":{}}