curl --request POST \
--url https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses \
--header 'API-Key: <api-key>' \
--header 'API-Nonce: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": {
"method_id": "2fa11f79-eeba-4d4e-afda-029abff6e29e"
},
"name": "My cold wallet",
"address_details": {
"crypto": {
"address": "bc1qexampleaddress"
}
}
}
'import requests
url = "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"
payload = {
"scope": { "method_id": "2fa11f79-eeba-4d4e-afda-029abff6e29e" },
"name": "My cold wallet",
"address_details": { "crypto": { "address": "bc1qexampleaddress" } }
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Nonce": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Nonce': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
scope: {method_id: '2fa11f79-eeba-4d4e-afda-029abff6e29e'},
name: 'My cold wallet',
address_details: {crypto: {address: 'bc1qexampleaddress'}}
})
};
fetch('https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => [
'method_id' => '2fa11f79-eeba-4d4e-afda-029abff6e29e'
],
'name' => 'My cold wallet',
'address_details' => [
'crypto' => [
'address' => 'bc1qexampleaddress'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Nonce: <api-key>",
"API-Sign: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"
payload := strings.NewReader("{\n \"scope\": {\n \"method_id\": \"2fa11f79-eeba-4d4e-afda-029abff6e29e\"\n },\n \"name\": \"My cold wallet\",\n \"address_details\": {\n \"crypto\": {\n \"address\": \"bc1qexampleaddress\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Nonce", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Nonce", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": {\n \"method_id\": \"2fa11f79-eeba-4d4e-afda-029abff6e29e\"\n },\n \"name\": \"My cold wallet\",\n \"address_details\": {\n \"crypto\": {\n \"address\": \"bc1qexampleaddress\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": {\n \"method_id\": \"2fa11f79-eeba-4d4e-afda-029abff6e29e\"\n },\n \"name\": \"My cold wallet\",\n \"address_details\": {\n \"crypto\": {\n \"address\": \"bc1qexampleaddress\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"address_id": "AB12345-6789A-BCDEFG"
}
}Create funding address
Registers a user-added cryptocurrency funding address for the selected account.
Set scope to exactly one method_id or network_id returned by the withdrawal-methods endpoint. Supply the crypto destination fields required by that method. The address is validated when it is created.
This operation is not idempotent. If a request times out or otherwise has an unknown outcome, list the account’s funding addresses before creating another one.
curl --request POST \
--url https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses \
--header 'API-Key: <api-key>' \
--header 'API-Nonce: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": {
"method_id": "2fa11f79-eeba-4d4e-afda-029abff6e29e"
},
"name": "My cold wallet",
"address_details": {
"crypto": {
"address": "bc1qexampleaddress"
}
}
}
'import requests
url = "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"
payload = {
"scope": { "method_id": "2fa11f79-eeba-4d4e-afda-029abff6e29e" },
"name": "My cold wallet",
"address_details": { "crypto": { "address": "bc1qexampleaddress" } }
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Nonce": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Nonce': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
scope: {method_id: '2fa11f79-eeba-4d4e-afda-029abff6e29e'},
name: 'My cold wallet',
address_details: {crypto: {address: 'bc1qexampleaddress'}}
})
};
fetch('https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => [
'method_id' => '2fa11f79-eeba-4d4e-afda-029abff6e29e'
],
'name' => 'My cold wallet',
'address_details' => [
'crypto' => [
'address' => 'bc1qexampleaddress'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Nonce: <api-key>",
"API-Sign: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"
payload := strings.NewReader("{\n \"scope\": {\n \"method_id\": \"2fa11f79-eeba-4d4e-afda-029abff6e29e\"\n },\n \"name\": \"My cold wallet\",\n \"address_details\": {\n \"crypto\": {\n \"address\": \"bc1qexampleaddress\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Nonce", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Nonce", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": {\n \"method_id\": \"2fa11f79-eeba-4d4e-afda-029abff6e29e\"\n },\n \"name\": \"My cold wallet\",\n \"address_details\": {\n \"crypto\": {\n \"address\": \"bc1qexampleaddress\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": {\n \"method_id\": \"2fa11f79-eeba-4d4e-afda-029abff6e29e\"\n },\n \"name\": \"My cold wallet\",\n \"address_details\": {\n \"crypto\": {\n \"address\": \"bc1qexampleaddress\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"address_id": "AB12345-6789A-BCDEFG"
}
}Authorizations
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Monotonically increasing nonce included in the request signature.
Path Parameters
Public identifier of the account that will own the funding address.
1 - 64Body
Cryptocurrency funding address to register for the selected account.
One withdrawal method or network for the saved address.
Show child attributes
Show child attributes
Partner-provided label for the funding address. Must be unique per account. Limited to 64 characters.
1 - 64Address details, as exactly one fiat bank account or crypto address branch.
Show child attributes
Show child attributes
Response
Funding address created successfully.
Funding address created for the selected account.
Stable identifier for a user-added cryptocurrency funding address.
Show child attributes
Show child attributes