Skip to main content
POST
/
integrations
/
vertofx
/
payment-requests
Create VertoFx Payment Request
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/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"
  }
}
Create VertoFX Payment Request 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

Authentication

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

Request Body

Request Schema

FieldTypeRequiredDescription
beneficiaryIdstringāœ…ID of the beneficiary to send payment to
amountnumberāœ…Amount to be sent
currencystringāœ…Currency code
walletIdstringāœ…ID of the wallet to send from
referencestringāœ…Payment reference
memostringāŒOptional memo for the payment

Responses

āœ… 201 - Success

āš ļø 400 - Bad Request

āš ļø 401 - Unauthorized

āŒ 500 - Internal Server Error

Tags

VertoFx

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
⌘I