Use the operations in the RippleNet Orchestration API to integrate the RippleNet basic payment flow into your payment system. These API operations also let you use webhooks to receive notifications about changes to the status of your RippleNet payments.
For more information, see:
Use these operations to work with payments in the basic payment flow.
| Operation | Method | Description |
|---|---|---|
| Get orchestration payments | GET | Get all payments initiated using basic payment flow. |
| Get orchestration payment | GET | Get a payment by unique reference number. |
| Return orchestration payment | POST | For fiat payments only Return a payment by customer end-to-end ID. |
| Reverse orchestration payment | POST | For fiat payments only Reverse a payment by customer end-to-end ID. |
Use these operations to get notifications about payments initiated using the basic payment flow.
| Operation | Method | Description |
|---|---|---|
| Get orchestration payment notifications | GET | Get notifications that have a given notification status. |
| Get orchestration payment notification by UUID | GET | Get a given payment notification with specified UUID. |
| Acknowledge orchestration payment notification by UUID | PUT | Acknowledge a notification with a specified UUID. |
| Acknowledge orchestration payment notifications | PUT | Acknowledge multiple notifications using a group of UUIDs. |
Use this operation to perform various webhook-enabled actions on payments.
| Operation | Method | Description |
|---|---|---|
| Send orchestration payment action | POST | Get notifications that have a given notification status. |