Skip to main content
POST
/
payment-request
New Payment Request
curl --request POST \
  --url https://api.royalti.io/payment-request/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "PaymentSettingId": "24d2c371-4a7a-4acd-b4aa-d3eb3bebd8fa",
  "currency": "USD",
  "amountUSD": 500,
  "amount": 130,
  "memo": "Payment for services rendered"
}
'
{
  "status": "success",
  "message": "Payment Request created successfully",
  "newpayment": {
    "id": "0654cd19-cea3-4fad-b92e-4033c4252c79",
    "status": "pending",
    "TenantId": 2,
    "TenantUserId": "f4b4e2f8-fe5e-4076-9e09-3424ff7f185f",
    "transactionDate": "2023-04-21",
    "currency": "USD",
    "amountUSD": 100,
    "amount": 74000,
    "memo": "Sale of album",
    "updatedAt": "2023-11-22T20:48:36.034Z",
    "createdAt": "2023-11-22T20:48:36.034Z"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Endpoint: /payment-request/ Method: POST

​
Request Body

FieldTypeRequiredDescription
PaymentSettingIdstringYesID of the payment setting being used.
currencystringYesCurrency code for the payment.
amountUSDnumberYesAmount in USD.
amountnumberNoAmount in the specified currency (optional).
memostringNoOptional memo describing the purpose of payment.
This endpoint allows you to create a new payment request, specifying the payment setting ID, currency, amounts, and an optional memo.

​
Code Examples

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

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
currency
string
required

Currency code for the payment

​
amountUSD
number
required

Amount in USD

​
user
string<uuid>

ID of the user to create the payment request for. Admin/API key only. If not provided, creates for authenticated user.

​
PaymentSettingId
string

ID of the payment setting being used. Optional during creation but required for approval and payment processing.

​
amount
number

Amount in the specified currency

​
memo
string

Optional memo describing the purpose of payment

Response

Success

​
status
string
​
message
string
​
newpayment
object