Estimate new conversion rule by account
curl --request POST \
--url https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate \
--header 'API-Key: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'API-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "100.00",
"from": {
"symbol": "EUR",
"type": "bank",
"bank_account": {
"via": "sepa"
}
},
"to": {
"symbol": "USDC",
"type": "wallet",
"wallet": {
"via": "ethereum"
}
}
}
'import requests
url = "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate"
payload = {
"amount": "100.00",
"from": {
"symbol": "EUR",
"type": "bank",
"bank_account": { "via": "sepa" }
},
"to": {
"symbol": "USDC",
"type": "wallet",
"wallet": { "via": "ethereum" }
}
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Timestamp": "<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-Timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: '100.00',
from: {symbol: 'EUR', type: 'bank', bank_account: {via: 'sepa'}},
to: {symbol: 'USDC', type: 'wallet', wallet: {via: 'ethereum'}}
})
};
fetch('https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate', 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.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate",
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([
'amount' => '100.00',
'from' => [
'symbol' => 'EUR',
'type' => 'bank',
'bank_account' => [
'via' => 'sepa'
]
],
'to' => [
'symbol' => 'USDC',
'type' => 'wallet',
'wallet' => [
'via' => 'ethereum'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Sign: <api-key>",
"API-Timestamp: <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.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate"
payload := strings.NewReader("{\n \"amount\": \"100.00\",\n \"from\": {\n \"symbol\": \"EUR\",\n \"type\": \"bank\",\n \"bank_account\": {\n \"via\": \"sepa\"\n }\n },\n \"to\": {\n \"symbol\": \"USDC\",\n \"type\": \"wallet\",\n \"wallet\": {\n \"via\": \"ethereum\"\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-Timestamp", "<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.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"100.00\",\n \"from\": {\n \"symbol\": \"EUR\",\n \"type\": \"bank\",\n \"bank_account\": {\n \"via\": \"sepa\"\n }\n },\n \"to\": {\n \"symbol\": \"USDC\",\n \"type\": \"wallet\",\n \"wallet\": {\n \"via\": \"ethereum\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate")
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-Timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"100.00\",\n \"from\": {\n \"symbol\": \"EUR\",\n \"type\": \"bank\",\n \"bank_account\": {\n \"via\": \"sepa\"\n }\n },\n \"to\": {\n \"symbol\": \"USDC\",\n \"type\": \"wallet\",\n \"wallet\": {\n \"via\": \"ethereum\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"from": {
"symbol": "EUR",
"type": "bank",
"amount": "100.00"
},
"to": {
"symbol": "USDC",
"type": "wallet",
"amount": "107.25000000"
},
"rate": {
"base": {
"symbol": "EUR"
},
"quote": {
"symbol": "USDC"
},
"price": "1.0850"
},
"fees": {
"from": {
"symbol": "EUR",
"amount": "0.00"
},
"trade": {
"symbol": "EUR",
"amount": "0.50"
},
"to": {
"symbol": "USDC",
"amount": "0.50000000"
}
}
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 400,
"code": "bad_request",
"causes": [
{
"field": "account_id",
"message": "must be a valid account identifier"
}
]
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 401,
"code": "unauthenticated"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 403,
"code": "forbidden"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 429,
"code": "resource_exhausted"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 500,
"code": "internal"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 503,
"code": "unavailable"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 504,
"code": "deadline_exceeded"
}
}Conversions
Estimate new conversion rule by account
Uses the authorized account’s country to estimate a conversion rule before you create it.
Returns the indicative amounts, rate, and fees for a hypothetical deposit to a conversion rule. An estimate does not lock a price, reserve funds, or create a conversion rule.
Provide amount as the gross deposit amount in the source asset. Specify bank rails and crypto networks without bank account details or crypto addresses. To create the conversion rule, call Create conversion rule.
POST
/
v1
/
accounts
/
{account_id}
/
conversions
/
estimate
Estimate new conversion rule by account
curl --request POST \
--url https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate \
--header 'API-Key: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'API-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "100.00",
"from": {
"symbol": "EUR",
"type": "bank",
"bank_account": {
"via": "sepa"
}
},
"to": {
"symbol": "USDC",
"type": "wallet",
"wallet": {
"via": "ethereum"
}
}
}
'import requests
url = "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate"
payload = {
"amount": "100.00",
"from": {
"symbol": "EUR",
"type": "bank",
"bank_account": { "via": "sepa" }
},
"to": {
"symbol": "USDC",
"type": "wallet",
"wallet": { "via": "ethereum" }
}
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Timestamp": "<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-Timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: '100.00',
from: {symbol: 'EUR', type: 'bank', bank_account: {via: 'sepa'}},
to: {symbol: 'USDC', type: 'wallet', wallet: {via: 'ethereum'}}
})
};
fetch('https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate', 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.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate",
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([
'amount' => '100.00',
'from' => [
'symbol' => 'EUR',
'type' => 'bank',
'bank_account' => [
'via' => 'sepa'
]
],
'to' => [
'symbol' => 'USDC',
'type' => 'wallet',
'wallet' => [
'via' => 'ethereum'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Sign: <api-key>",
"API-Timestamp: <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.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate"
payload := strings.NewReader("{\n \"amount\": \"100.00\",\n \"from\": {\n \"symbol\": \"EUR\",\n \"type\": \"bank\",\n \"bank_account\": {\n \"via\": \"sepa\"\n }\n },\n \"to\": {\n \"symbol\": \"USDC\",\n \"type\": \"wallet\",\n \"wallet\": {\n \"via\": \"ethereum\"\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-Timestamp", "<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.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"100.00\",\n \"from\": {\n \"symbol\": \"EUR\",\n \"type\": \"bank\",\n \"bank_account\": {\n \"via\": \"sepa\"\n }\n },\n \"to\": {\n \"symbol\": \"USDC\",\n \"type\": \"wallet\",\n \"wallet\": {\n \"via\": \"ethereum\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.services.payward.com/v1/accounts/{account_id}/conversions/estimate")
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-Timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"100.00\",\n \"from\": {\n \"symbol\": \"EUR\",\n \"type\": \"bank\",\n \"bank_account\": {\n \"via\": \"sepa\"\n }\n },\n \"to\": {\n \"symbol\": \"USDC\",\n \"type\": \"wallet\",\n \"wallet\": {\n \"via\": \"ethereum\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"from": {
"symbol": "EUR",
"type": "bank",
"amount": "100.00"
},
"to": {
"symbol": "USDC",
"type": "wallet",
"amount": "107.25000000"
},
"rate": {
"base": {
"symbol": "EUR"
},
"quote": {
"symbol": "USDC"
},
"price": "1.0850"
},
"fees": {
"from": {
"symbol": "EUR",
"amount": "0.00"
},
"trade": {
"symbol": "EUR",
"amount": "0.50"
},
"to": {
"symbol": "USDC",
"amount": "0.50000000"
}
}
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 400,
"code": "bad_request",
"causes": [
{
"field": "account_id",
"message": "must be a valid account identifier"
}
]
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 401,
"code": "unauthenticated"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 403,
"code": "forbidden"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 429,
"code": "resource_exhausted"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 500,
"code": "internal"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 503,
"code": "unavailable"
}
}{
"error": {
"type": "conversions_error",
"instance": "5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"status": 504,
"code": "deadline_exceeded"
}
}Authorizations
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.
Path Parameters
Globally unique public identifier for an account.
Required string length:
14 - 42Body
application/json
Conversion rule to estimate.
Gross deposit amount to estimate, as a positive decimal string in the source asset.
Required string length:
1 - 64Source of the conversion rule. It has the same fields as from in Create conversion rule. Send only the bank rail or network, without bank account details or a crypto address.
Show child attributes
Show child attributes
Destination of the conversion rule. It has the same fields as to in Create conversion rule. Send only the bank rail or network, without bank account details or a crypto address.
Show child attributes
Show child attributes
Response
Conversion rule estimate returned.
Returned indicative conversion rule terms.
Indicative conversion rule terms.
Show child attributes
Show child attributes