Skip to main content
POST
/
payment-request
/
New Payment Request
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/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,
    "UserId": "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"
  }
}

Create Payment Request

Endpoint: /payment-request/ Method: POST

Request Body

FieldTypeRequiredDescription
PaymentSettingIdstringYesID of the payment setting being used.
currencystringYesCurrency code for the payment.
amountUSDnumberYesAmount in USD.
amountnumberYesAmount in the specified currency.
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.

Authentication

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

Request Body

Example Request

{
  "PaymentSettingId": "24d2c371-4a7a-4acd-b4aa-d3eb3bebd8fa",
  "currency": "USD",
  "amountUSD": 500,
  "amount": 130,
  "memo": "Payment for services rendered"
}

Request Schema

FieldTypeRequiredDescription
PaymentSettingIdstringID of the payment setting being used
currencystringCurrency code for the payment
amountUSDnumberAmount in USD
amountnumberAmount in the specified currency
memostringOptional memo describing the purpose of payment

Responses

✅ 201 - Success

⚠️ 400 - Bad Request

⚠️ 401 - Unauthorized

❌ 500 - Internal Server Error

Tags

Payment Requests

Authorizations

Authorization
string
header
required

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

Body

application/json
PaymentSettingId
string
required

ID of the payment setting being used

currency
string
required

Currency code for the payment

amountUSD
number
required

Amount in USD

amount
number
required

Amount in the specified currency

memo
string

Optional memo describing the purpose of payment

Response

Success

status
string
message
string
newpayment
object
I