Receiver - advanced payment flow
In the advanced payment flow, both Sender and Receiver can use low-level RippleNet API calls to exercise control over each step of the transaction. If the client application uses the advanced payment flow API operations, they must use polling to get information about payment states.
For more information, see Receive a payment - advanced.
RippleNet Server API
Account configuration
Use these operations to configure your accounts.
| Operation | Method | Description |
|---|---|---|
| Get accounts | GET | Gets a list of all accounts. |
| Create account | POST | Creates an account on the RippleNet ledger. |
| Get account by name | GET | Get a specific account. |
| Update account | PUT | Updates the updatable fields for an account. |
| Update nostro account balance limit | PUT | Updates minimum and maximum allowed balance limits on a nostro account. |
| Disable account | POST | Disable an account. |
Auditing
Use these operations to audit your accounts.
| Operation | Method | Description |
|---|---|---|
| Get audits | GET | Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance. |
| Get event trail for payment | GET | Gets an audit trail of a payment's state changes on a local RippleNet instance. |
Balances and statements
Use these operations to view balances and statements for a ledger.
| Operation | Method | Description |
|---|---|---|
| Get balances | GET | Get balances for local and remote accounts owned by a RippleNet address. |
| Get ledger balances | GET | Get balances for ledger owned by a RippleNet address. |
| Get statement | GET | Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range. |
| Get statement by external account ID | GET | Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range. |
| Get ledger account statement | GET | Get statement for a specified Ledger Account |
Beneficiary confirmation
Use these operations to perform beneficiary confirmations.
| Operation | Method | Description |
|---|---|---|
| Get account lookup by status | GET | Get Account Lookup entities by status and other filters. |
| Complete account lookup | POST | Posts an Account Lookup response to validate a beneficiary's account details before payment. |
| Get account lookup by ID | GET | Gets an Account Lookup entity for its account_lookup_id value. |
Diagnostics
Use these operations to view RippleNet Server health.
| Operation | Method | Description |
|---|---|---|
| Check health | GET | Gets the health status of the RippleNet server. |
| Check heartbeat | GET | Gets the health status of the RippleNet server's peers. |
Exchange transfers
Use these operations to manage exchange transfers.
| Operation | Method | Description |
|---|---|---|
| Get exchange transfers | GET | List all exchange transfers. |
| Execute exchange transfer | POST | Execute an exchange transfer to move funds from one of your accounts in one currency, to another one of your accounts in another currency. |
| Get exchange transfer quote | POST | Requests a quote for an exchange transfer. |
| Complete exchange transfer | POST | Updates the status of an exchange transfer to COMPLETED. Make this request once the exchange transfer has been made on both the ledger and on internal systems. |
| Get exchange transfer by ID | GET | Gets an exchange transfer by ID. |
Fees
Use these operations to configure fees.
| Operation | Method | Description |
|---|---|---|
| Get fees | GET | List all fees. |
| Create fee | POST | Creates a fee. |
| Get fee by ID | GET | Gets a fee by ID. |
| Update fee | PUT | Updates an existing fee. |
| Delete fee | DELETE | Deletes a fee. Once deleted, a fee cannot be accessed. |
Payments
Use these operations to perform payments.
| Operation | Method | Description |
|---|---|---|
| Get payments | GET | Retrieves all payments in an instance of RippleNet that meet the criteria defined by the query parameters. |
| Get payment by payment ID | GET | Gets a payment by ID. |
| Lock payment | POST | Locks a payment. The beneficiary and all intermediary institutions agree to proceed with the payment by making successful Lock payment requests. |
| Reject lock payment | POST | Rejects a payment from being locked. |
| Retry accept payment | POST | Returns a rejected payment from the LOCK_DECLINED state to the ACCEPTED state. |
| Fail payment | POST | Fails a payment. Fail payment is a deliberate action that permanently stops the payment and puts it into a non-recoverable state. |
| Finalize payment | POST | Marks a payment with finalized sub-states that reflect what is happening to the payment while it is in the EXECUTED state. |
| Add payment sub-state | POST | Adds a sub-state to a payment that reflects what is happening to the payment while it is in the EXECUTED state. |
| Complete payment | POST | Marks a payment as complete by placing it in the COMPLETED state. |
| Add payment labels | PUT | Adds a list of labels to the payment. To retrieve payments by label, see Get payments. |
| Delete payment labels | DELETE | Deletes an existing label from a payment. |
| Get payment node status | GET | Senders can query for the RippleNet instances (in a given payment chain) that have payments in the LOCKED state. |
| Get filtered payment by payment ID | GET | Returns a sanitized payment with sensitive content filtered from the user_info object. |
| Create quote to return payment | POST | Creates a collection of quotes that can be used to return a payment. |
| Create quote to reverse payment | POST | Creates a quote collection containing at most one quote that can be used to reverse a payment. |
Payout method
Payout Method operations let receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods.
| Operation | Method | Description |
|---|---|---|
| Create payout method | POST | Creates a payout method. For example, LOCAL_RAILS. |
| Get payout methods | GET | Returns a list of payout methods created by a receiving partner. |
| Get payout method by ID | GET | Returns a payout method by its ID. |
| Update payout method | PUT | Updates a payout method. |
| Delete payout method | DELETE | Deletes a payout method. |
| Get all categories | GET | Returns all the payout method categories. |
Pool accounts
Use these operations to configure your RippleNet pool accounts.
| Operation | Method | Description |
|---|---|---|
| Get all pool accounts | GET | Returns a list of all pool accounts on a RippleNet node. |
| Get pool account by pool account ID | GET | Get a pool account by its pool account ID. |
Quotes
Use these operations to manage your quotes.
| Operation | Method | Description |
|---|---|---|
| Get quotes | GET | Gets a list of quotes. |
| Get quote by quote ID | GET | Gets a quote by ID. |
| Get quote collection by ID | GET | Gets a quote collection that was created for a proposed payment. |
Rates
Use these operations to manage your rates.
| Operation | Method | Description |
|---|---|---|
| Get rates | GET | Gets a list of configured exchange rates. |
| Create rate | POST | Creates an exchange rate for a specified currency pair. |
| Get rate by ID | GET | Gets a configured exchange rate by ID. |
| Update rate | PUT | Updates an existing exchange rate. |
| Delete rate | DELETE | Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed. |
Request for payment
Use these operations to interact with your payment requests.
| Operation | Method | Description |
|---|---|---|
| Get requests for payment | GET | Gets requests for payment that match the query parameters. |
| Send request for payment | POST | Sends a new request for payment. |
| Get request for payment by ID | GET | Gets a request for payment by request for payment ID. |
| Fail request for payment | POST | Fails a request for payment. |
Transfers
Use these operations to manage your transfers.
| Operation | Method | Description |
|---|---|---|
| Get transfers | GET | Gets a list of transfers. |
| Get transfer estimate | GET | Get an estimate of the fee to make an "outbound" transfer from an exchange (connected to xRapid) to an another account outside of RippleNet (such as a bank account). |
| Get transfer by ID | GET | Gets a transfer by ID. |
| Execute transfer | POST | Transfers funds between accounts. |
| Complete transfer | POST | Updates the state of a transfer to COMPLETED. |
| Add transfer labels | PUT | Adds a list of labels to the transfer. To retrieve transfers by label, see Get transfers |
| Delete transfer labels | DELETE | Deletes one or more existing labels from the transfer. |
Smart Liquidation
Use these operations for Smart Liquidation.
| Operation | Method | Description |
|---|---|---|
| Get liquidations | GET | List all liquidations by date range. |
| Get liquidation by ID | GET | Gets a liquidation by UUID. |