v1

latestOpenAPI 3.0.3Apache 2.02026-07-1761017.2 KB
Minimum

Send payment

post/accounts/{account_id}/payments

Path parameters

account_idstring required

Account ID

Request body

idstring required
account_idstring required
currency'XUS' | 'XDX' required
amountinteger required
payeestring required

The receiver address of the payment. Only support account identifier defined in DIP-5 for now. We will add Diem ID support in the future when the protocol related is stabilized.

Response

The server accepts the payment request.

  • The server may reflect the payment sent in the account balance immediately. The funds being sent are considered to be in the process of being transferred out and should not be used for any other purpose.
  • Once a client receives the response, expect the payment to be sent in a short time. But it is not a limit to the server to complete the payment before respond the request.
  • Client can confirm if the payment is completed by:
    • Checking if the sending and receiving account balances have been updated accordingly.
    • Checking if the sending or receiving wallet app exposes an event using the get account events endpoint.
  • The optional get account events endpoint (if implemented) can be used to confirm if the action has failed.
idstring required

ID of the resource created.