Home User Guides API Reference Changelog

API Reference

FAQ Sandbox Portal Log In

Home User Guides API Reference Changelog

Loginpost

Create Sub-Accounts
- Create a sub-account (New)post
- Get all Sub-Accounts (New)post
Add information to sub-accounts
Sub-Account Login
- Login as a subaccountpost

Trade

OTC
- Gets a list of OTC deals.get

Get payment tracking detailsget
Payment Service
Payment Document
- Generate a link to be used to upload a file.post

Beneficiary (New)
Name Enquiry
- Payee verificationpost

Wallet Service

Inbound Bank Payments
Wallet to Wallet
- Completedpost
Wallet Credit
- Successpost
Wallet to Account

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

Payment Document (Legacy)
- Generate a link to be used to upload a file.post

Refunded

wbhk

walletToAccount.refunded

Payload

id

integer

required

amount

string

required

reference

string

required

state

string

enum

required

Allowed:

currency

string

required

type

string

enum

required

Allowed:

subState

string | null

initiationSource

string | null

paymentId

string | null

clientReference

string | null

account

object

walletId

integer

required

createdDate

date-time

required

completedDate

date-time | null

archivedDate

date-time | null

archiveReason

string | null

externalUniqueRef

string | null

Response

200

Webhook received

Updated about 2 months ago

Archived

Rate (Legacy)

Did this page help you?

Loading…

Updated about 2 months ago

Archived

Rate (Legacy)

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.