Auto Swap Addresses

Create Auto Swap Address for End User

Endpoint that allows the creation of a auto swap deposit address for a given end user. This endpoint behaves idempontently for a given user and any of the networks from a network family.

Auto Swap is a feature that allows you to create a deposit address, and any deposit you make will be automatically swapped for a pre-defined asset (contact the admin to set this value) and then withdrawn to the desired target address.

Important Notes:

  • The swap will be executed at the best market price obtained after your deposit is confirmed. In other words, this is an open-price model, so there are no guarantees or held-quotes on the final price obtained before the deposit happens.
  • Trading and withdrawal fees will be deducted before the converted funds are sent to your target address.
post/api/v1/end-users/{end_user_id}/auto-swap-addresses/

Request

  • Base URL: https://sandbox-b2b.ripio.com
  • URL: https://sandbox-b2b.ripio.com/api/v1/end-users/{end_user_id}/auto-swap-addresses/
  • Auth: OAuth 2 (client credentials, token URL https://sandbox-b2b.ripio.com/oauth2/token/)

Request body

network'BITCOIN' | 'BITCOIN_TESTNET' | 'ETHEREUM' | 'ETHEREUM_SEPOLIA' required

Represents the crypto network that will be used to create an address.

target_addressstring

Represents the desired address to send the funds after a successful swap.

Response

OK

network'BITCOIN' | 'ETHEREUM' | 'BITCOIN_TESTNET' | 'ETHEREUM_SEPOLIA' | 'POLYGON' | 'POLYGON_MUMBAI'
end_user_idstring

End user's external ref, usually a uuid.

addressstring

Address where the assets for AutoSwap should be sent.

target_addressstring

Address where assets will be sent after AutoSwap process.

xpubstring nullable

Last six characters of The Extended Public Key.

derivation_pathstring nullable

Address derivation path, for addresses generated before April 2025, this value will be null.

Changes

No recorded changes to this operation across all 1 revision of this API.