List funding addresses

curl --request GET \
  --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>'

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"

headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "API-Nonce": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Sign': '<api-key>', 'API-Nonce': '<api-key>'}
};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("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>")
  .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::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "address_id": "AB12345-6789A-BCDEFG",
      "scope": {
        "method_id": "2fa11f79-eeba-4d4e-afda-029abff6e29e"
      },
      "name": "My cold wallet",
      "address_details": {
        "crypto": {
          "address": "bc1qexampleaddress",
          "tag": "123",
          "memo": "456"
        }
      }
    }
  ],
  "next_page_token": "MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4"
}

Funds

List funding addresses

Lists user-added cryptocurrency funding addresses available to the selected account.

Claimed deposit addresses remain under the deposit-address endpoint and are not returned here. The list contains withdrawal-direction funding addresses. On the first request, omit page_token and optionally set page_size and method_id. To continue, send the returned page_token and the same method_id when filtering. Omit page_size; the token preserves it. The token is bound to the selected account and method filter.

GET

accounts

{account_id}

funds

addresses

List funding addresses

curl --request GET \
  --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>'

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"

headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "API-Nonce": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Sign': '<api-key>', 'API-Nonce': '<api-key>'}
};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.services.payward.com/v1/accounts/{account_id}/funds/addresses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("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>")
  .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::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "address_id": "AB12345-6789A-BCDEFG",
      "scope": {
        "method_id": "2fa11f79-eeba-4d4e-afda-029abff6e29e"
      },
      "name": "My cold wallet",
      "address_details": {
        "crypto": {
          "address": "bc1qexampleaddress",
          "tag": "123",
          "memo": "456"
        }
      }
    }
  ],
  "next_page_token": "MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4"
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id

string

required

Public identifier of the account that owns the funding addresses.

Required string length: 1 - 64

Query Parameters

method_id

string<uuid>

Funding method identifier. Restricts the listing to addresses registered for that method, its network, or its network group. An address matched this way may report a network_id or network_group_id scope rather than method_id. An empty value is rejected as a validation error rather than treated as no filter.

page_size

integer<int32>

default:20

Maximum number of results to return. Defaults to 20 when omitted.

Required range: 1 <= x <= 25

page_token

string

Opaque token returned as next_page_token in the previous response. Omit to request the first page.

Required string length: 1 - 256

Response

User-added cryptocurrency funding addresses available to the selected account.

data

object[]

required

User-added cryptocurrency funding addresses.

Show child attributes

next_page_token

string

Opaque token for retrieving the next page. Absent when there are no more results.

Required string length: 1 - 256