{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/payments-odl/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Sender - basic payment flow","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","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":"sender---basic-payment-flow","__idx":0},"children":["Sender - basic payment flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the operations in the ","RippleNet Orchestration"," API to integrate the RippleNet ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["basic payment flow"]}," into your payment system."," ","These API operations also let you use ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["webhooks"]}," to receive notifications about changes to the status of your RippleNet payments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, see:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/introduction/concepts/payment-flow"},"children":["Payment flow"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/webhooks"},"children":["Webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/tutorials/send-a-payment/send-a-payment-basic"},"children":["Send a payment - basic"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"ripplenet-orchestration-api","__idx":1},"children":["RippleNet Orchestration"," API"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"orchestration-payments","__idx":2},"children":["Orchestration payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these operations to work with payments in the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["basic payment flow"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/createorchestrationpayment"},"children":["Create orchestration payment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a payment using ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["basic payment flow"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpayments"},"children":["Get orchestration payments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get all payments initiated using ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["basic payment flow"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpayment"},"children":["Get orchestration payment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a payment by unique reference number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acceptorchestrationpayment"},"children":["Accept orchestration payment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept a payment by customer end-to-end ID."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"orchestration-payment-notifications","__idx":3},"children":["Orchestration payment notifications"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these operations to get notifications about payments initiated using the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["basic payment flow"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotifications"},"children":["Get orchestration payment notifications"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get notifications that have a given notification status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotificationbyuuid"},"children":["Get orchestration payment notification by UUID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a given payment notification with specified UUID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid"},"children":["Acknowledge orchestration payment notification by UUID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Acknowledge a notification with a specified UUID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acknowledgeorchestrationpaymentnotifications"},"children":["Acknowledge orchestration payment notifications"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Acknowledge multiple notifications using a group of UUIDs."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"orchestration-payment-actions","__idx":4},"children":["Orchestration payment actions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this operation to perform various webhook-enabled actions on payments."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/sendorchestrationpaymentaction"},"children":["Send orchestration payment action"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get notifications that have a given notification status."]}]}]}]}]}]},"headings":[{"value":"Sender - basic payment flow","id":"sender---basic-payment-flow","depth":1},{"value":"RippleNet Orchestration API","id":"ripplenet-orchestration-api","depth":2},{"value":"Orchestration payments","id":"orchestration-payments","depth":3},{"value":"Orchestration payment notifications","id":"orchestration-payment-notifications","depth":3},{"value":"Orchestration payment actions","id":"orchestration-payment-actions","depth":3}],"frontmatter":{"seo":{"title":"Sender - basic payment flow"}},"lastModified":"2025-10-03T17:57:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-odl/ripplenet-apis/sender-basic-payment-flow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}