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
Sub-Accounts

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
Money Transfer Rates
Wallet Rates

fx quotes

Third-Party Quotes
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

FX Execution

Third-Party Execution
- Executes a Quote.post
Money Transfer Execution
Wallet Execution
- Initiate a Payment Request via Currency Balance for Card Quotes.post
Common

Ledger

Balances/Sub Balances
Internal Distribution
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
Beneficiaries
Transfers
Bulk Payments

Wallets

Currency Card
Expenses
Multi Wallet
Transactions

Webhooks

Webhooks

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
Sub-Accounts

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
Money Transfer Rates
Wallet Rates

fx quotes

Third-Party Quotes
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

FX Execution

Third-Party Execution
- Executes a Quote.post
Money Transfer Execution
Wallet Execution
- Initiate a Payment Request via Currency Balance for Card Quotes.post
Common

Ledger

Balances/Sub Balances
Internal Distribution
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
Beneficiaries
Transfers
Bulk Payments

Wallets

Currency Card
Expenses
Multi Wallet
Transactions

Webhooks

Webhooks

Process or Cancel a Bulk Payment.

put https://sandbox.caxton.io/api/payments/{bulkPaymentUploadId}

Call this endpoint when a Bulk Payment file is ready to be submitted, or in case it needs to be cancelled after being uploaded.

URL Expired

The URL for this request expired after 30 days.

📂

Submit or Cancel a Bulk Upload File - Step 3

Open Recipe

Path Params

bulkPaymentUploadId

int64

required

Body Params

Status

string

Headers

Authorization

string

required

Response

Response body

object

LoggedInUserName

string

MainAccountHolderName

string

Content

object

Model

object

ExpectedResponses

array of strings

ExpectedResponses

AuthorisedClientModel

object

Authorised Client

ClientId

string

This is a GUID created at the time of first registration.

ClientRef

string

This is a unique string created for the API client at the time of first registration.

UserId

string

The Client's CXTN platform Id. This is a unique Id created at the time of first registration.

TokenStartDate

date-time

The date from when the token is valid. This is set to 30 days until the TokenEndDate, but also configurable.

TokenEndDate

date-time

The date the token expires. This is set to 30 days from the TokenStartDate, but also configurable.

AuthorisedUserModel

object

Authorised User

UserId

string

The User's CXTN platform Id. This is a unique Id created at the time of first registration.

AppVersion

string

TokenStartDate

date-time

Timestamp assigned when the token becomes valid. This is set to 30 days until the TokenEndDate, but also configurable.

TokenEndDate

date-time

Timestamp assigned when the token expires. This is set to 30 days from the TokenStartDate, but also configurable.

LoginTimestamp

date-time

The timestamp created upon User login. Indicates the time and date the User logged in.

ApiLoginType

string

Describes the type of user account currently logged in.

UserApiToken ClientApiTokenWrapped UserApiTokenOverridden

FirebirdApiError

object

ExpectedResponses

array of strings

ExpectedResponses

AdditionalInfo

object

Has additional fields

Exception

object

Has additional fields

ApiStatusCode

string

ApiStatus

string

ApiStatusDescription

string

Updated about 1 year ago

Lists Bulk Upload by the Id.

Upload a Bulk Payment file.

Did this page help you?

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://sandbox.caxton.io/api/payments/bulkPaymentUploadId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: text/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

Updated about 1 year ago

Lists Bulk Upload by the Id.

Upload a Bulk Payment file.

Did this page help you?

🦉

Recipe Title

Recipe Description

{"success":true}

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

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

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

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

fx quotes
Third-Party Quotes
Retrieve a Quote by Id.get
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
Money Transfer 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
Wallet Quotes
Retrieve a Quote by Id.get
Create a Quote by Trading a Main currency into an Exchange currency.post
Create a Card Quote from an Exchange currency into a Main currency.post

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

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

Inbound Payments
Funds In
Lists available banks by currency.get
Lists deposit options available.get

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

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

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

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

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

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

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

fx quotes
Third-Party Quotes
Retrieve a Quote by Id.get
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
Money Transfer 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
Wallet Quotes
Retrieve a Quote by Id.get
Create a Quote by Trading a Main currency into an Exchange currency.post
Create a Card Quote from an Exchange currency into a Main currency.post

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

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

Inbound Payments
Funds In
Lists available banks by currency.get
Lists deposit options available.get

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

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

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

200OK