Creating Static Wallet

You can create a static address in a specific currency and network using this endpoint. The static address will be associated with a unique trackId, and if a callbackUrl is set, your server will be notified of any payments received to that address. This allows you to receive transactions to the static address regardless of the amount and time.

Please note that static addresses with no transactions for six months will be revoked.

POST https://api.oxapay.com/merchants/request/staticaddress

Request Body

Name

Type

Description

merchant*

string

Your merchant API key for authentication and authorization.

callbackUrl

string

The URL where payment information will be sent. Use this to receive notifications about payments made to the static address.

network

string

The blockchain network on which the static address should be created. If not specified, the default network will be used.

currency*

string

The specific currency for which you want to create a static address.

string

Provide the payer's email address for reporting purposes.

orderId

string

Specify a unique order ID for reference in your system.

description

string

Provide order details or any additional information that will be shown in different reports.

{
    "result": integer, // The result code indicates the success or failure of the request.
    "message": string, // A message providing additional information about the result.
    "address": string // The generated static address for the specified currency and network.
}

Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding result codes for further details.

Example codes

curl -X POST https://api.oxapay.com/merchants/request/staticaddress \
  -d '{
    "merchant": "YOUR_MERCHANT_API_KEY",
    "currency": "BTC",
    "callbackUrl": "https://example.com/callback",
    "description": "Order #12345",
    "orderId": "ORD-12345",
    "email": "[email protected]"
  }'

<?php

$url = 'https://api.oxapay.com/merchants/request/staticaddress';

$data = array(
    'merchant' => 'YOUR_MERCHANT_API_KEY',
    'currency' => 'BTC',
    'callbackUrl' => 'https://example.com/callback',
    'description' => 'Order #12345',
    'orderId' => 'ORD-12345',
    'email' => '[email protected]'
);

$options = array(
    'http' => array(
        'header' => 'Content-Type: application/json',
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
$result = json_decode($response);
var_dump($result);
?>

const axios = require('axios');
const url = 'https://api.oxapay.com/merchants/request/staticaddress';
const data = JSON.stringify({
    merchant: 'YOUR_MERCHANT_API_KEY',
    currency: 'BTC',
    callbackUrl: 'https://example.com/callback',
    description: 'Order #12345',
    orderId: 'ORD-12345',
    email: '[email protected]'
});

axios.post(url, data)
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(error);
    });

import requests
import json

url = 'https://api.oxapay.com/merchants/request/staticaddress'
data = {
    'merchant': 'YOUR_MERCHANT_API_KEY',
    'currency': 'BTC',
    'callbackUrl': 'https://example.com/callback',
    'description': 'Order #12345',
    'orderId': 'ORD-12345',
    'email': '[email protected]'
}

response = requests.post(url, data=json.dumps(data))
result = response.json()
print(result)

Please note that you need to replace YOUR_MERCHANT_API_KEY with your actual merchant API key in the code snippets.

PreviousCreating White-Label Payment NextRevoking Static Wallet

Last updated 1 year ago

hashtagRequest Body

hashtagExample codes

Request Body

Example codes