FAQ Sandbox Portal Log In

API Reference

FAQ Sandbox Portal Log In

User Guides API Reference Changelog

Loginpost

Sub-Account Loginpost
Create Sub-Accounts
- Create a sub-account (New)post
- Get all Sub-Accounts (New)post
Add information to sub-accounts
Send Terms & Conditions email to a sub-account directorpost

Trade

OTC
- Gets a list of OTC deals.get

Payment Service
Payment Services

Fetch user beneficiariesget
Create new beneficiarypost
Fetch user beneficiary by IDget
Update an existing beneficiaryput
Delete beneficiarydel
Document Upload
- Get signed URLs to upload beneficiary documentspost
Name Enquiry
- Retrieve ConfirmPayee verification detailspost
- Nigeria - Get account namepost

Wallet Service

FX Status Change
Wallet to Account
Wallet Credit
- Successwebhook
Wallet to Wallet
- Completedwebhook
Inbound Bank Payments
Beneficiary Status Change
Wallet Statement Ready
- Triggered when a wallet statement is readywebhook
Refund Completed
- Triggered when a refund is completedwebhook

Payment Document (Legacy)
- Generate a link to be used to upload a file.post
Rate (Legacy)
- Get Rates (New)post
Trade
Authorization
Withdrawal Service
- Create a Payment Request (v2.2)post
Rate
Loginpost
Payment Service (Legacy)
- Create a Wallet-to-Wallet Transfer (New)post
- Retrieve payment details by paymentIdget
Beneficiary (Legacy)
Payment Transactions
- Get Bulk Exchange Rates (New)post
- Retrieve proof of payments for a transaction.get

Pending

webhook

beneficiaryStatusChange.pending

Payload

id

integer | null

required

accountNumber

string

required

bankName

string

required

beneficiaryAddress

string | null

beneficiaryCity

string | null

beneficiaryCountryCode

string | null

beneficiaryEntityType

string

enum

required

Allowed:

beneficiaryPostcode

string | null

beneficiaryFirstName

string | null

beneficiaryLastName

string | null

beneficiaryCompanyName

string | null

beneficiaryEmail

string | null

country

string

required

reference

string

required

nationalId

string

required

currencyId

integer | null

currency

string | null

clientReference

string | null

status

string

enum

Allowed:

Response

200

Acknowledged successfully.

Updated about 2 hours ago

Approved

Rejected

Did this page help you?

Loading…

Updated about 2 hours ago

Approved

Rejected

Did this page help you?

Privacy policy Terms of service

VertoFX Ltd (No. 10973066) designs and operates the VertoFX website and app. VertoFX is authorised by the Financial Conduct Authority under the Electronic Money Regulations 2011, Firm Reference 901073, for the issuing of electronic money. Database rights protect data on VertoFX website(s) (including pricing data).

Please Note: we do NOT and WILL not deal with unregulated exchanges or affiliates as this currently falls outside of our risk appetite.