{"templateId":"markdown","versions":[{"version":"v1","label":"v1","link":"/pt-br/products/collections/concepts/settlements","default":true,"active":true,"folderId":"3a2d3fa8"},{"version":"v0","label":"v0","link":"/pt-br/products/collections/v0/concepts/settlements","default":false,"active":false,"folderId":"3a2d3fa8"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/pt-BR/products/collections/@v0/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Settlements","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"settlements","__idx":0},"children":["Settlements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A settlement represents the transfer of collected funds from Ripple to your designated account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Collections and channels bring funds ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["in"]},", crediting an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/collections/concepts/accounts"},"children":["account"]},"'s sub-ledger. A settlement moves those funds ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["out"]},", to the destination you have configured. In v1, settlements are tied to accounts, which gives you a clear trail from the account that received the money to the payout that disbursed it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/collections/concepts/transactions"},"children":["transaction"]}," included in a settlement carries that settlement's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlement_id"]},". Cross-referencing the two is how you confirm that received funds and paid-out funds agree."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-settlements-relate-to-other-resources","__idx":1},"children":["How settlements relate to other resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A settlement draws from an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/collections/concepts/accounts"},"children":["account"]}," balance."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["It covers one or more ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/collections/concepts/transactions"},"children":["transactions"]},", each stamped with its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlement_id"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Settlement progress emits ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SETTLEMENT_INITIATED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SETTLEMENT_COMPLETED"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SETTLEMENT_FAILED"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/collections/concepts/webhooks"},"children":["webhook"]}," events."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-operations","__idx":2},"children":["API operations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/collections/api/collections/settlements/createsettlementv1"},"children":["Create a settlement"]},": Initiate a new settlement for an account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/collections/api/collections/settlements/listsettlementsv1"},"children":["List settlements"]},": Retrieve a list of all settlements, which can be filtered by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/collections/api/collections/settlements/getsettlementbyidv1"},"children":["Get settlement by ID"]},": View the full details and current status of a single settlement."]}]}]},"headings":[{"value":"Settlements","id":"settlements","depth":1},{"value":"How settlements relate to other resources","id":"how-settlements-relate-to-other-resources","depth":2},{"value":"API operations","id":"api-operations","depth":2}],"frontmatter":{"seo":{"title":"Settlements"}},"lastModified":"2026-10-07T18:01:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/collections/concepts/settlements","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}