Update Payment

curl --request PUT \
  --url https://api.royalti.io/payment/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "<string>",
  "title": "<string>",
  "transactionDate": "<string>",
  "currency": "<string>",
  "amount": 123,
  "amountUSD": 123,
  "conversionRate": 123,
  "memo": "<string>"
}
'

import requests

url = "https://api.royalti.io/payment/{id}"

payload = {
    "user": "<string>",
    "title": "<string>",
    "transactionDate": "<string>",
    "currency": "<string>",
    "amount": 123,
    "amountUSD": 123,
    "conversionRate": 123,
    "memo": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user: '<string>',
    title: '<string>',
    transactionDate: '<string>',
    currency: '<string>',
    amount: 123,
    amountUSD: 123,
    conversionRate: 123,
    memo: '<string>'
  })
};

fetch('https://api.royalti.io/payment/{id}', 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.royalti.io/payment/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'user' => '<string>',
    'title' => '<string>',
    'transactionDate' => '<string>',
    'currency' => '<string>',
    'amount' => 123,
    'amountUSD' => 123,
    'conversionRate' => 123,
    'memo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.royalti.io/payment/{id}"

	payload := strings.NewReader("{\n  \"user\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"amount\": 123,\n  \"amountUSD\": 123,\n  \"conversionRate\": 123,\n  \"memo\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	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.put("https://api.royalti.io/payment/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"amount\": 123,\n  \"amountUSD\": 123,\n  \"conversionRate\": 123,\n  \"memo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/payment/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"amount\": 123,\n  \"amountUSD\": 123,\n  \"conversionRate\": 123,\n  \"memo\": \"<string>\"\n}"

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

{
  "message": "Payment updated successfully"
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

PUT

payment

{id}

Update Payment

curl --request PUT \
  --url https://api.royalti.io/payment/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "<string>",
  "title": "<string>",
  "transactionDate": "<string>",
  "currency": "<string>",
  "amount": 123,
  "amountUSD": 123,
  "conversionRate": 123,
  "memo": "<string>"
}
'

import requests

url = "https://api.royalti.io/payment/{id}"

payload = {
    "user": "<string>",
    "title": "<string>",
    "transactionDate": "<string>",
    "currency": "<string>",
    "amount": 123,
    "amountUSD": 123,
    "conversionRate": 123,
    "memo": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user: '<string>',
    title: '<string>',
    transactionDate: '<string>',
    currency: '<string>',
    amount: 123,
    amountUSD: 123,
    conversionRate: 123,
    memo: '<string>'
  })
};

fetch('https://api.royalti.io/payment/{id}', 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.royalti.io/payment/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'user' => '<string>',
    'title' => '<string>',
    'transactionDate' => '<string>',
    'currency' => '<string>',
    'amount' => 123,
    'amountUSD' => 123,
    'conversionRate' => 123,
    'memo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.royalti.io/payment/{id}"

	payload := strings.NewReader("{\n  \"user\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"amount\": 123,\n  \"amountUSD\": 123,\n  \"conversionRate\": 123,\n  \"memo\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	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.put("https://api.royalti.io/payment/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"amount\": 123,\n  \"amountUSD\": 123,\n  \"conversionRate\": 123,\n  \"memo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/payment/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"amount\": 123,\n  \"amountUSD\": 123,\n  \"conversionRate\": 123,\n  \"memo\": \"<string>\"\n}"

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

{
  "message": "Payment updated successfully"
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Update Payment Description: The /payment/{id} endpoint updates a specific payment. Method: PUT Authorization:

Required role: admin or higher

Path Parameter:

Parameter	Type	Description
id	string	The unique identifier of the payment

Request Body:

Field	Type	Required	Description
user (Optional)	string	No	TenantUserId associated with the payment
title (Optional)	string	No	Title/description of the payment
transactionDate (Optional)	string	No	Date and time of the transaction
currency (Optional)	string	No	Currency code (e.g., USD, NGN)
amount (Optional)	number	No	Amount in the specified currency
amountUSD (Optional)	number	No	Amount converted to USD
conversionRate (Optional)	number	No	Exchange rate used for conversion
memo (Optional)	string	No	Additional notes about the payment
files (Optional)	array	No	Array of file names associated with the payment

Code Examples

const response = await fetch('https://api.royalti.io/payment/example-id', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "user": "sample-user",
    "title": "sample-title",
    "transactionDate": "sample-transactionDate",
    "currency": "sample-currency",
    "amount": 1,
    "amountUSD": 1,
    "conversionRate": 1,
    "memo": "sample-memo"
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.put(
  'https://api.royalti.io/payment/example-id',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"user":"sample-user","title":"sample-title","transactionDate":"sample-transactionDate","currency":"sample-currency","amount":1,"amountUSD":1,"conversionRate":1,"memo":"sample-memo"}
)

data = response.json()
print(data)

curl -X PUT https://api.royalti.io/payment/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user":"sample-user","title":"sample-title","transactionDate":"sample-transactionDate","currency":"sample-currency","amount":1,"amountUSD":1,"conversionRate":1,"memo":"sample-memo"}'

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

string

required

Payment ID

Body

application/json

user

string

TenantUserId associated with the payment

title

string

Title/description of the payment

transactionDate

string

Date and time of the transaction

currency

string

Currency code

amount

number

Amount in the specified currency

amountUSD

number

Amount converted to USD

conversionRate

number

Exchange rate used for conversion

memo

string

Optional memo

Response

Success

message

string

payment

object

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples