Claim deposit address

curl --request POST \
  --url https://api.services.payward.com/v1/accounts/{account_id}/funds/deposits/addresses \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method_id": "479c45eb-6558-430a-8794-4308137d2588"
}
'

import requests

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

payload = { "method_id": "479c45eb-6558-430a-8794-4308137d2588" }
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({method_id: '479c45eb-6558-430a-8794-4308137d2588'})
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/funds/deposits/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/deposits/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([
    'method_id' => '479c45eb-6558-430a-8794-4308137d2588'
  ]),
  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/deposits/addresses"

	payload := strings.NewReader("{\n  \"method_id\": \"479c45eb-6558-430a-8794-4308137d2588\"\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/deposits/addresses")
  .header("API-Key", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method_id\": \"479c45eb-6558-430a-8794-4308137d2588\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/funds/deposits/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  \"method_id\": \"479c45eb-6558-430a-8794-4308137d2588\"\n}"

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

{
  "data": {
    "address": "GDHHZIA4OO5GUQXMWIFWA3JSJRJCJRNDTKJYIAURARM4R2QNMQ2NC6YH",
    "memo": "7421968351048273065"
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "causes": [
      {
        "field": "asset_symbol",
        "message": "must contain between 1 and 16 characters"
      }
    ],
    "status": 400,
    "code": "bad_request"
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "unauthenticated",
    "status": 401
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "forbidden",
    "status": 403
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "resource_exhausted",
    "status": 429
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "internal",
    "status": 500
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "unavailable",
    "status": 503
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "deadline_exceeded",
    "status": 504
  }
}

Funds

Claim deposit address

Claims a crypto deposit address for a funding method available to the selected account.

BTC over Lightning uses a per-payment invoice instead of a reusable deposit address. Use Create Lightning invoice.

This operation is not idempotent. If a request times out or otherwise has an unknown outcome, do not automatically retry it because an address may already have been claimed. First list the account’s claimed deposit addresses or contact Payward Services support.

Compatible funding methods can share address limits. List and reuse an existing address before claiming another. When the shared limit has been reached and no existing address is eligible to expire, the request returns 409 with code deposit_address_limit_reached.

POST

accounts

{account_id}

funds

deposits

addresses

Claim deposit address

curl --request POST \
  --url https://api.services.payward.com/v1/accounts/{account_id}/funds/deposits/addresses \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method_id": "479c45eb-6558-430a-8794-4308137d2588"
}
'

import requests

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

payload = { "method_id": "479c45eb-6558-430a-8794-4308137d2588" }
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({method_id: '479c45eb-6558-430a-8794-4308137d2588'})
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/funds/deposits/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/deposits/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([
    'method_id' => '479c45eb-6558-430a-8794-4308137d2588'
  ]),
  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/deposits/addresses"

	payload := strings.NewReader("{\n  \"method_id\": \"479c45eb-6558-430a-8794-4308137d2588\"\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/deposits/addresses")
  .header("API-Key", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method_id\": \"479c45eb-6558-430a-8794-4308137d2588\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/funds/deposits/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  \"method_id\": \"479c45eb-6558-430a-8794-4308137d2588\"\n}"

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

{
  "data": {
    "address": "GDHHZIA4OO5GUQXMWIFWA3JSJRJCJRNDTKJYIAURARM4R2QNMQ2NC6YH",
    "memo": "7421968351048273065"
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "causes": [
      {
        "field": "asset_symbol",
        "message": "must contain between 1 and 16 characters"
      }
    ],
    "status": 400,
    "code": "bad_request"
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "unauthenticated",
    "status": 401
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "forbidden",
    "status": 403
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "resource_exhausted",
    "status": 429
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "internal",
    "status": 500
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "unavailable",
    "status": 503
  }
}

{
  "error": {
    "type": "funding_error",
    "instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
    "code": "deadline_exceeded",
    "status": 504
  }
}

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 deposit addresses.

Required string length: 1 - 64

Body

application/json

Crypto funding method whose deposit address should be claimed.

method_id

string<uuid>

required

Crypto funding method identifier returned by the deposit-methods endpoint.

Response

Crypto deposit address claimed for the selected account and method.

Claimed crypto deposit address for the selected account.

data

object

required

Crypto deposit address and any network-specific routing information.

Show child attributes

⌘I