Basic crypto operations
Every request listed on this page requires authorization to be successfully completed.
Create permanent deposit address
POST
https://public.api.0xpay.app/merchants/addresses
As said previously, you can generate new deposit addresses with receiving addresses
feature. For BEP20 & ERC20 networks: on creation, one wallet address will be generated and assigned for both networks, and monitored for incoming transactions.
Deposit Updates: After a receiving address is created on a dedicated blockchain, 0xpay will notify you about incoming transactions for all the assets supported on this blockchain.
Request Body
Name | Type | Description |
---|---|---|
meta | string | metadata, write your id here to catch it back later with a notification |
blockchain* | string | available values you can find here ("API value" column) |
target | object |
|
Create rotating deposit address
POST
https://public.api.0xpay.app/merchants/rotating-addresses
As said previously, you can generate new deposit addresses with receiving addresses
feature.
An address will be active until the first incoming transaction is received, or for a specified timeframe (set with duration
parameter)
Deposit Updates: After a receiving address is created on a dedicated blockchain, 0xpay will notify you about an incoming transaction for all the assets supported on this blockchain.
Request Body
Name | Type | Description |
---|---|---|
meta | string | metadata, write your id here to catch it back later with a notification |
blockchain* | string | available values you can find here ("API value" column) |
duration | number | timeframe for which the address will be active. (min: 1000 ms; max: 259200000 ms). By default, duration will be set to 86400000ms. |
durationAfterReplenishment | number | additional timeframe after the first replenishment transaction, during which the address will still stay active for deposits. (min: 1000 ms; max: 86400000 ms). By default, duration will be set to 7200000 ms. |
Send cryptocurrency
POST
https://public.api.0xpay.app/merchants/withdrawals/crypto
Creates an outgoing cryptocurrency transaction. 0xpay API will produce notifications according to status updates on your withdrawal.
Request Body
Name | Type | Description |
---|---|---|
ticker* | string | find values with "List available tickers" request |
to* | string | Destination wallet address |
blockchain* | string | available values you can find here ("API value" column) |
amount* | string | amount in decimal format |
fee | string | you can specify withdrawal fees that have to be greater than the actual fee, which can be useful for better fee calculation options on your side. If not the specified – fee will be set automatically |
localId | string | if was specified error will be thrown if not unique, can be useful on your side to avoid the double-spend issue |
meta | string | your metadata that will be passed along to you later with a notification |
Withdrawal fee
GET
https://public.api.0xpay.app/merchants/withdrawals/crypto/fee
This method is used to get a fee for sending a desired amount of assets (ticker
) on a chosen blockchain. Learn how fees work here
Request Body
Name | Type | Description |
---|---|---|
ticker* | string | find values with "List all supported assets" request |
blockchain* | string | available values you can find here ("API value" column) |
amount* | string | amount in decimal format |
address | string | destination wallet address (fill in to check if tx is an internal zero-fee transfer) |
Replenishment risk score
GET
https://public.api.0xpay.app/merchants/replenishment/crypto/:id/compliance
This method is used to get replenishment risk score by it's id.
We recommend you to check risk score in 5 minutes after transaction is being broadcasted to blockchain.
Withdrawal risk score
GET
https://public.api.0xpay.app/merchants/withdrawals/crypto/:id/compliance
This method is used to get withdrawal risk-score by it's id.
Available crypto assets
GET
https://public.api.0xpay.app/merchants/assets/crypto/
This method is used to fetch all available crypto assets of your merchant. You can learn about available assets here.
Last updated