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. |
Gets a list of transfers.
Security
Bearer
The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.
Default:0
- Mock serverhttps://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers
- https://[domainPrefix].ripplexcurrent.com/v4https://[domainPrefix].ripplexcurrent.com/v4/transfers
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers?page=0&size=20&with_labels=string&without_labels=string&include_labels=false&state=PREPARED&internal_id=string&sender_end_to_end_id=string&sort_field=CREATED_AT&sort_direction=ASC&account=string&transfer_account_role=SENDING' \
-H 'Authorization: YOUR_API_KEY_HERE'Successfully returned transfers.
Response
{ "first": true, "last": true, "number": 0, "numberOfElements": 0, "size": 0, "totalElements": 0, "totalPages": 0, "sort": [ { … } ], "content": [ { … } ] }