Create a payment
curl --request POST \
--url http://localhost:5000/api/v1/payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customerId": "<string>",
"beneficiaryId": "<string>",
"amount": "<string>",
"purposeOfPayment": "<string>",
"documentIds": [
"<string>"
],
"paymentQuoteId": "<string>",
"internalReference": "<string>",
"invoiceNumber": "<string>",
"memo": "<string>"
}
'import requests
url = "http://localhost:5000/api/v1/payment"
payload = {
"customerId": "<string>",
"beneficiaryId": "<string>",
"amount": "<string>",
"purposeOfPayment": "<string>",
"documentIds": ["<string>"],
"paymentQuoteId": "<string>",
"internalReference": "<string>",
"invoiceNumber": "<string>",
"memo": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customerId: '<string>',
beneficiaryId: '<string>',
amount: '<string>',
purposeOfPayment: '<string>',
documentIds: ['<string>'],
paymentQuoteId: '<string>',
internalReference: '<string>',
invoiceNumber: '<string>',
memo: '<string>'
})
};
fetch('http://localhost:5000/api/v1/payment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/api/v1/payment",
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([
'customerId' => '<string>',
'beneficiaryId' => '<string>',
'amount' => '<string>',
'purposeOfPayment' => '<string>',
'documentIds' => [
'<string>'
],
'paymentQuoteId' => '<string>',
'internalReference' => '<string>',
'invoiceNumber' => '<string>',
'memo' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:5000/api/v1/payment"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"beneficiaryId\": \"<string>\",\n \"amount\": \"<string>\",\n \"purposeOfPayment\": \"<string>\",\n \"documentIds\": [\n \"<string>\"\n ],\n \"paymentQuoteId\": \"<string>\",\n \"internalReference\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"memo\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:5000/api/v1/payment")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"beneficiaryId\": \"<string>\",\n \"amount\": \"<string>\",\n \"purposeOfPayment\": \"<string>\",\n \"documentIds\": [\n \"<string>\"\n ],\n \"paymentQuoteId\": \"<string>\",\n \"internalReference\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"memo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/payment")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"<string>\",\n \"beneficiaryId\": \"<string>\",\n \"amount\": \"<string>\",\n \"purposeOfPayment\": \"<string>\",\n \"documentIds\": [\n \"<string>\"\n ],\n \"paymentQuoteId\": \"<string>\",\n \"internalReference\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"memo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"customerId": "<string>",
"beneficiaryId": "<string>",
"amount": "<string>",
"currencyCode": "<string>",
"internalReference": "<string>",
"invoiceNumber": "<string>",
"purposeOfPayment": "<string>",
"memo": "<string>",
"paymentToken": "<string>",
"paymentNetwork": "<string>",
"paymentQuoteId": "<string>",
"status": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"customer": {
"companyName": "<string>",
"status": "<string>",
"orgId": "<string>"
},
"beneficiary": {
"companyName": "<string>",
"bankBic": "<string>",
"status": "<string>"
},
"sourceFunding": {
"type": "BANK_ACCOUNT",
"bankAccountId": "<string>",
"bankName": "<string>",
"countryCode": "<string>",
"currencyCode": "<string>",
"accountNumber": "<string>",
"iban": "<string>"
},
"rail": {
"method": "<string>",
"countryCode": "<string>"
},
"receiptUrl": "<string>",
"paymentQuote": {
"id": "<string>",
"paymentAmount": "<string>",
"paymentCurrencyCode": "<string>",
"totalTarget": "<string>",
"targetCurrencyCode": "<string>",
"createdAt": "<string>",
"expiresAt": "<string>",
"usedAt": "<string>",
"priceBreakdown": {
"payout": {
"label": "Payment amount",
"amountUsd": "<string>"
},
"platformFees": {
"feeProfileId": "<string>",
"feeProfileName": "<string>",
"subtotalUsd": "<string>",
"lines": [
{
"feeRuleId": "<string>",
"name": "<string>",
"feeType": "PERCENT",
"feeValue": "<string>",
"baseAmountUsd": "<string>",
"rawAmountUsd": "<string>",
"minAmountUsd": "<string>",
"maxAmountUsd": "<string>",
"finalAmountUsd": "<string>",
"paymentSystemId": "<string>"
}
]
},
"partnerFees": {
"feeProfileId": "<string>",
"feeProfileName": "<string>",
"subtotalUsd": "<string>",
"lines": [
{
"feeRuleId": "<string>",
"name": "<string>",
"feeType": "PERCENT",
"feeValue": "<string>",
"baseAmountUsd": "<string>",
"rawAmountUsd": "<string>",
"minAmountUsd": "<string>",
"maxAmountUsd": "<string>",
"finalAmountUsd": "<string>",
"paymentSystemId": "<string>"
}
]
},
"funding": {
"subtotalUsd": "<string>",
"lines": [
{
"feeRuleId": "<string>",
"name": "<string>",
"feeType": "PERCENT",
"feeValue": "<string>",
"baseAmountUsd": "<string>",
"rawAmountUsd": "<string>",
"minAmountUsd": "<string>",
"maxAmountUsd": "<string>",
"finalAmountUsd": "<string>",
"paymentSystemId": "<string>"
}
]
},
"totals": {
"fundingType": "CRYPTO",
"feesUsd": "<string>",
"totalTarget": "<string>",
"targetCurrencyCode": "<string>",
"effectivePriceUsdPerToken": "<string>",
"quotedTokenAmount": "<string>"
}
},
"fundingType": "CRYPTO",
"paymentToken": "USDC",
"paymentNetwork": "ETHEREUM",
"networkFeeUsd": "<string>",
"effectivePriceUsdPerToken": "<string>",
"quotedTokenAmount": "<string>",
"paymentSystemId": "<string>"
}
}Payments
Create a payment
Create a new payment and submit for review.
POST
/
api
/
v1
/
payment
Create a payment
curl --request POST \
--url http://localhost:5000/api/v1/payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customerId": "<string>",
"beneficiaryId": "<string>",
"amount": "<string>",
"purposeOfPayment": "<string>",
"documentIds": [
"<string>"
],
"paymentQuoteId": "<string>",
"internalReference": "<string>",
"invoiceNumber": "<string>",
"memo": "<string>"
}
'import requests
url = "http://localhost:5000/api/v1/payment"
payload = {
"customerId": "<string>",
"beneficiaryId": "<string>",
"amount": "<string>",
"purposeOfPayment": "<string>",
"documentIds": ["<string>"],
"paymentQuoteId": "<string>",
"internalReference": "<string>",
"invoiceNumber": "<string>",
"memo": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customerId: '<string>',
beneficiaryId: '<string>',
amount: '<string>',
purposeOfPayment: '<string>',
documentIds: ['<string>'],
paymentQuoteId: '<string>',
internalReference: '<string>',
invoiceNumber: '<string>',
memo: '<string>'
})
};
fetch('http://localhost:5000/api/v1/payment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/api/v1/payment",
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([
'customerId' => '<string>',
'beneficiaryId' => '<string>',
'amount' => '<string>',
'purposeOfPayment' => '<string>',
'documentIds' => [
'<string>'
],
'paymentQuoteId' => '<string>',
'internalReference' => '<string>',
'invoiceNumber' => '<string>',
'memo' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:5000/api/v1/payment"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"beneficiaryId\": \"<string>\",\n \"amount\": \"<string>\",\n \"purposeOfPayment\": \"<string>\",\n \"documentIds\": [\n \"<string>\"\n ],\n \"paymentQuoteId\": \"<string>\",\n \"internalReference\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"memo\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:5000/api/v1/payment")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"beneficiaryId\": \"<string>\",\n \"amount\": \"<string>\",\n \"purposeOfPayment\": \"<string>\",\n \"documentIds\": [\n \"<string>\"\n ],\n \"paymentQuoteId\": \"<string>\",\n \"internalReference\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"memo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/payment")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"<string>\",\n \"beneficiaryId\": \"<string>\",\n \"amount\": \"<string>\",\n \"purposeOfPayment\": \"<string>\",\n \"documentIds\": [\n \"<string>\"\n ],\n \"paymentQuoteId\": \"<string>\",\n \"internalReference\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"memo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"customerId": "<string>",
"beneficiaryId": "<string>",
"amount": "<string>",
"currencyCode": "<string>",
"internalReference": "<string>",
"invoiceNumber": "<string>",
"purposeOfPayment": "<string>",
"memo": "<string>",
"paymentToken": "<string>",
"paymentNetwork": "<string>",
"paymentQuoteId": "<string>",
"status": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"customer": {
"companyName": "<string>",
"status": "<string>",
"orgId": "<string>"
},
"beneficiary": {
"companyName": "<string>",
"bankBic": "<string>",
"status": "<string>"
},
"sourceFunding": {
"type": "BANK_ACCOUNT",
"bankAccountId": "<string>",
"bankName": "<string>",
"countryCode": "<string>",
"currencyCode": "<string>",
"accountNumber": "<string>",
"iban": "<string>"
},
"rail": {
"method": "<string>",
"countryCode": "<string>"
},
"receiptUrl": "<string>",
"paymentQuote": {
"id": "<string>",
"paymentAmount": "<string>",
"paymentCurrencyCode": "<string>",
"totalTarget": "<string>",
"targetCurrencyCode": "<string>",
"createdAt": "<string>",
"expiresAt": "<string>",
"usedAt": "<string>",
"priceBreakdown": {
"payout": {
"label": "Payment amount",
"amountUsd": "<string>"
},
"platformFees": {
"feeProfileId": "<string>",
"feeProfileName": "<string>",
"subtotalUsd": "<string>",
"lines": [
{
"feeRuleId": "<string>",
"name": "<string>",
"feeType": "PERCENT",
"feeValue": "<string>",
"baseAmountUsd": "<string>",
"rawAmountUsd": "<string>",
"minAmountUsd": "<string>",
"maxAmountUsd": "<string>",
"finalAmountUsd": "<string>",
"paymentSystemId": "<string>"
}
]
},
"partnerFees": {
"feeProfileId": "<string>",
"feeProfileName": "<string>",
"subtotalUsd": "<string>",
"lines": [
{
"feeRuleId": "<string>",
"name": "<string>",
"feeType": "PERCENT",
"feeValue": "<string>",
"baseAmountUsd": "<string>",
"rawAmountUsd": "<string>",
"minAmountUsd": "<string>",
"maxAmountUsd": "<string>",
"finalAmountUsd": "<string>",
"paymentSystemId": "<string>"
}
]
},
"funding": {
"subtotalUsd": "<string>",
"lines": [
{
"feeRuleId": "<string>",
"name": "<string>",
"feeType": "PERCENT",
"feeValue": "<string>",
"baseAmountUsd": "<string>",
"rawAmountUsd": "<string>",
"minAmountUsd": "<string>",
"maxAmountUsd": "<string>",
"finalAmountUsd": "<string>",
"paymentSystemId": "<string>"
}
]
},
"totals": {
"fundingType": "CRYPTO",
"feesUsd": "<string>",
"totalTarget": "<string>",
"targetCurrencyCode": "<string>",
"effectivePriceUsdPerToken": "<string>",
"quotedTokenAmount": "<string>"
}
},
"fundingType": "CRYPTO",
"paymentToken": "USDC",
"paymentNetwork": "ETHEREUM",
"networkFeeUsd": "<string>",
"effectivePriceUsdPerToken": "<string>",
"quotedTokenAmount": "<string>",
"paymentSystemId": "<string>"
}
}Authorizations
Nuvera API application secret key
RS256 per-request signed JWT
Body
application/json
Customer making the payment
Beneficiary receiving the payment
Payment amount
ISO 4217 currency code
Available options:
USD, BRL, MXN, COP, HKD, CNY, NGN, KES, MWK, ZAR, XOF, XAF, UGX, TZS, ZMW, BWP, SGD, USDT, USDC, DAI, BTC Purpose of payment
Minimum string length:
1IDs of uploaded documents (invoice required)
Minimum array length:
1ID of the active payment quote used for the payment
Client's internal reference number
Invoice number
Optional payment memo
Maximum string length:
64Response
default - application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes