For AI agents: visit https://dev.caxton.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Caxton
HomeGuidesRecipesAPI Reference
v1.0

Log InCaxton
API Reference
Log In
v1.0HomeGuidesRecipesAPI Reference

Getting started

  • Client Sandbox
    • Approve or Reject a Transfer Id.post
    • Fund the account.post
  • Authentication
    • Generate Password.post
    • Get Access Tokenpost

Accounts

  • User Accounts
    • Get User Account Detailsget
    • User Login.post
    • Create Userspost
  • Sub-Accounts
    • Show User Details.get
    • List All Subsidiaries.get
    • Create Credentials for Existing Sub-Accounts.put
    • Create Sub-Account.post
    • Reset User Credentials.put
    • Deactivate a subsidiary account.put

FX Currencies

  • Third-Party Currencies
    • Retrieve Main currencies for Third Parties.get
    • Retrieve Exchange currencies for Third Parties.get
  • Money Transfer Currencies
    • Retrieve Main currencies for Money Transfers.get
    • Retrieve Exchange currencies for Money Transfers.get
  • Wallet Currencies
    • Retrieve Exchange currencies for Cards.get

Fx Rates

  • Third-Party Rates
    • Display Rates from Main currency to Exchange currency.post
    • Display Rates from Exchange currency into Main currency.post
    • Shows conversion rates for all currencies.post
  • Money Transfer Rates
    • Display conversion rates for all Money Transfer currencies.post
    • Display Rates from Exchange currency into Main currency.post
    • Display Rates from a Main currency into an Exchange currency.post
  • Wallet Rates
    • Display Rates from an Exchange currency into a Main currency.post
    • Display Rates from Main currency into Exchange currency.post
    • Display conversion rates for all Card currencies.post

fx quotes

  • Third-Party Quotes
    • Create a Quote by Trading a Main currency into an Exchange currency.post
    • Create a Quote by Trading an Exchange currency into a Main currency.post
    • Retrieve a Quote by Id.get
  • Money Transfer Quotes
    • Create a Quote by Trading an Exchange currency into a Main currency.post
    • Create a Quote by Trading a Main currency into an Exchange currency.post
  • Wallet Quotes
    • Create a Card Quote from an Exchange currency into a Main currency.post
    • Create a Quote by Trading a Main currency into an Exchange currency.post
    • Retrieve a Quote by Id.get

FX Execution

  • Third-Party Execution
    • Executes a Quote.post
  • Money Transfer Execution
    • Initiate a Payment Request via Bank Transfer.post
    • Process a Bank Transfer Payment Request.post
    • Initiate a Payment Request via Currency Balance for Money Transfers.post
    • Display Quote Status for Bank Transfers.get
  • Wallet Execution
    • Initiate a Payment Request via Currency Balance for Card Quotes.post
  • Common
    • Process a Payment Request.post
    • Display Quote Status for Currency Loads.get
    • Shows the quote Settlement.post

Ledger

  • Balances/Sub Balances
    • List All Main Balances.get
    • List Main and Pot Balances.get
    • List a specific currency balance.get
    • Gets the pot balance.get
  • Internal Distribution
    • Create a Pot.post
    • Transfer funds to an account.post
    • Transfer funds between balances.post
  • Reporting
    • Search Account Transactions.post
    • Search Account Deposits.post

Inbound Payments

  • Funds In
    • Lists deposit options available.get
    • Lists available banks by currency.get

Outbound Payments

  • Countries
    • Retrieve a list of countries and their respective bank requirements.get
    • Retrieve a specific country's bank requirements.get
    • Retrieve country bank requirements.get
    • Gets country purpose codes.get
    • Gets country purpose code information.get
  • Beneficiaries
    • List all Beneficiaries.get
    • Creates a Beneficiary.post
    • Checks for existing Beneficiaries.post
    • Retrieve bank information details.post
    • List Beneficiary by Idget
    • Edit Beneficiary.put
    • Deletes Beneficiary.del
    • Gets all beneficiaries by Currency Code.get
  • Transfers
    • Lookup Pending Payments.get
    • Lookup Payment by Id.get
    • Create a Payment.post
    • List All Payments.post
  • Bulk Payments
    • /api/paymentsget
    • Create a Bulk Upload.post
    • Lists Bulk Upload by the Id.get
    • Process or Cancel a Bulk Payment.put
    • Upload a Bulk Payment file.post
    • Modify a Single Entry.put
    • Include or Exclude a Single Entry.put

Wallets

  • Currency Card
    • List Cards.get
    • Lookup Card.get
    • View PIN.get
    • Activate Card - Step One.get
    • Activate Card - Step Two.post
    • Block Card.put
    • Unblock Card.put
    • Card Lost.put
    • Card Stolen.put
    • Move a Card.post
    • Create Card.post
    • Assign a Card.post
    • Activate Card by Owner.post
  • Expenses
    • Expense summary.get
    • Retrieve all expense categories.get
    • Submit expense.post
    • Retrieve expense details.get
    • Update an expense.put
    • Remove expense.del
    • Submit a receipt.post
    • Retrieve receipt information.get
    • Remove receipt.del
  • Multi Wallet
    • List Wallets.get
    • Create Wallet.post
    • Lookup Wallet by Name.get
    • Lookup Wallet by the Id.get
    • Archive Wallet.put
    • Rename Wallet.put
    • Retrieve the Balance for a Specific Wallet.get
    • Exchange Currencies.post
    • Retrieve a Specific Currency Balance.get
    • Display the Wallet Balances in a Single Currency.get
    • Retrieve Wallet Fund Requests by date.post
    • Toggle Purchase Restrictions.put
    • Transfer All Wallet Balances to the Main Balance.post
    • Transfer a Specific Wallet Balance to the Main Balance.post
  • Transactions
    • Lookup Wallet Transactions by Default WalletId.post
    • List Recent Wallet Transactions.post
    • Lookup Wallet Transactions by WalletId.post
    • Lookup Wallet Transactions by WalletId.post
    • Lookup Card Transactions by CardId and WalletId.post
    • Lookup Recent Card Transactions.post
    • Lookup Card Transactions by CardId and Currency.post
    • Lookup Wallet Transactions by WalletId and Currency.post

Webhooks

  • Webhooks
    • Enable Webhooks.post
    • Disable Webhooks.put
    • Retrieve All Webhook Endpoints.get
    • Edit Webhook Endpoint.put
    • Create Webhook Endpoint.post
    • Toggle Webhook Endpoint.put
Powered by 

Common

Common endpoints are shared across products.

Updated about 1 year ago


Initiate a Payment Request via Currency Balance for Card Quotes.
Process a Payment Request.
Did this page help you?

Updated about 1 year ago


Initiate a Payment Request via Currency Balance for Card Quotes.
Process a Payment Request.
Did this page help you?