Skip to main content
POST
/
integrations
/
vertofx
/
payment-requests
Create VertoFx Payment Request
curl --request POST \
  --url https://api.royalti.io/integrations/vertofx/payment-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiaryId": "<string>",
  "amount": 123,
  "currency": "<string>",
  "walletId": "<string>",
  "reference": "<string>",
  "memo": "<string>"
}
'
{
  "success": true,
  "message": "Payment request created successfully",
  "data": {
    "paymentId": "vfx-payment-123",
    "status": "pending"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Description:
The /integrations/vertofx/payment-requests endpoint allows creation of new payment requests through VertoFX. Method: POST Request Payload:
ParameterTypeDescription
beneficiaryIdstringID of the beneficiary to send payment to
amountnumberAmount to be sent
currencystringCurrency code
walletIdstringID of the wallet to send from
referencestringPayment reference
memostringOptional memo for the payment

​
Code Examples

const response = await fetch('https://api.royalti.io/integrations/vertofx/payment-requests', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "beneficiaryId": "sample-beneficiaryId",
    "amount": 1,
    "currency": "sample-currency",
    "walletId": "sample-walletId",
    "reference": "sample-reference",
    "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
​
beneficiaryId
string
required

ID of the beneficiary to send payment to

​
amount
number
required

Amount to be sent

​
currency
string
required

Currency code

​
walletId
string
required

ID of the wallet to send from

​
reference
string
required

Payment reference

​
memo
string

Optional memo for the payment

Response

Success

​
success
boolean
​
data
object
​
message
string