Create payment address
Method: POST
Route: /merchants/:merchant/wallets/:wallet/address (opens in a new tab)
If you want to receive notifications when funds are received at the created address, you need to provide the URL where the webhook will be sent as a POST request. We will send the Transaction object when the payment is detected and again after it is confirmed in the blockchain network.
Warning: The Secure Token is required if a callback URL is provided. The Secure Token is a random string that needs to be safely stored in your application. After receiving the webhook, check it against the Token header.
To link the address to a User or Order, you need to provide its ID in the identify field.
Path
| Parameter | Type | Description |
|---|---|---|
merchant | String | required Merchant ID in UUIDv4 format |
wallet | String | required Wallet ID in UUIDv4 format |
Body
| Parameter | Type | Description |
|---|---|---|
label | String | required Label for Payment Address |
callback | String | optional Payment Processor URL |
token | String | optional Secure Token to Validate Webhook Header |
identify | String | optional Identifier to Link with Order or User |
Response
| Field | Type | Description |
|---|---|---|
currency | String | Currency Name |
network | String | Currency Network |
address | String | Generated Payment Address |
qr | String | QR Code |
createdAt | Number | Timestamp hen the address was generated |
status | String | Address Status, listen or archive |
minPaymentAmount | Number | Minimum Allowable Payment Amount |
This API endpoint is private and requires an authorization header X-Api-Key