API Reference
FAQSandbox Portal

List Payment Purpose Codes

get
https://api-payment-sandbox.vertofx.com/payments/purpose-codes

Retrieves a list of Payment Purpose Codes based on the provided filters.
This endpoint supports filtering by purpose, entity type, and payment direction.

Read the guide on purpose codes for more info


📘

NOTE:
Always confirm your Base URL: If you are testing in the sandbox environment, ensure your base URL is set to the sandbox base url: https://api-company-sandbox.vertofx.com, and if in production, use the production base URL: https://api-company-beta.vertofx.com. Using them interchangably will result in 403 errors.



Query Params

Document type ID or array of IDs. Can be a single ID or a JSON array string
(e.g., "[1,2,3]").

string
enum

If "true", returns only Payment Purpose category types.
If "false" or omitted, returns all non-Payment Purpose types.

Allowed:
string

Filter by entity type (e.g., "individual", "business").

string
enum

Filter by payment direction.

Allowed:
string
required

Filter by currency

string
enum
required

Filter by document type (e.g., "LOCAL", "GLOBAL")

Allowed:
Responses

Updated 14 days ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago

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.

© Verto 2026

All rights reserved Registered Office: 20-22 Wenlock Road, London, England, N1 7GU