Guides

Inbound Payments

Suggest Edits

Overview

With Caxton's Inbound Payments, you can deposit funds in 20+ different currency accounts. Whether it’s a client or a personal transaction, funds can be transferred directly to a designated currency account 24/7 – 365 days of the year.

Lookup Bank Accounts

To check which currency deposit options are available to the account, call the GET - Banks Lookupendpoint. A list of bank accounts for multiple currencies is displayed, along with the corresponding bank details, such as Iban, Swift, Sort Code, etc.

RESPONSE

This is an example response:

{
    "Content": {
        "Model": {
            "BankDetails": [              
									{
                    "AccountName": "Caxton Payments Limited",
                    "Currency": "USD",
                    "BankName": "Royal Bank of Scotland\r\n",
                    "AccountNumber": "<accountnumber>",
                    "IbanNumber": "<iban>",
                    "SwiftCode": "<swift>",
                    "SortCode": "<sortcode>",
                    "BankAddress": null,
                    "BankAddress1": null,
                    "BankAddress2": null,
                    "Country": null,
                    "Type": 0,
                    "PayInReference": "6259575960"
                },

Lookup Bank Accounts by Currency

Alternatively, call the GET - Banks Lookup by CCY endpoint to display the bank account details associated with a particular currency by entering the currency in the path parameters. In the example below, 'EUR' is entered for the ccy parameter,

REQUEST

curl --location 'https://caxapi-integration.azurewebsites.net/api/reference/lookup/banks/EUR' \
--header 'authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--header 'userapitoken: <userapitoken>' \
--data ''

RESPONSE

{
    "Content": {
        "Model": {
            "BankDetails": [
                {
                    "AccountName": "<accountname>",
                    "Currency": "EUR",
                    "BankName": "Simulator Bank",
                    "AccountNumber": "010128820",
                    "IbanNumber": "<iban>",
                    "SwiftCode": "<swift>",
                    "SortCode": null,
                    "BankAddress": "The Bower, 207-211 Old Street, London, England, EC1V 9NR",
                    "BankAddress1": null,
                    "BankAddress2": null,
                    "Country": "GB",
                    "Type": 1,
                    "PayInReference": null
                }
            ],
            "ApiStatusCode": 100,
            "ApiStatus": "IsValid",
            "ApiStatusDescription": "Valid Operation"
        },
        "ExpectedResponses": [
            "IsValid"
        ]
    },
    "AuthorisedClientModel": {
        "ClientId": "<clientid>",
        "ClientRef": "<clientref>",
        "ApiStatusCode": 100,
        "ApiStatus": "IsValid",
        "ApiStatusDescription": "Valid Operation"
    },
    "AuthorisedUserModel": {
        "UserId": "<userid>",
        "AppVersion": null,
        "TokenStartDate": "2023-11-13T00:00:00",
        "TokenEndDate": "2023-12-13T00:00:00",
        "LoginTimestamp": "2023-12-06T11:05:59.255352",
        "ApiLoginType": 0,
        "ApiStatusCode": 100,
        "ApiStatus": "IsValid",
        "ApiStatusDescription": "Valid Operation"
    }
}

🚧

Beware

In addition to the above, all Users are assigned a PaymentReference when their accounts are first opened. To check this, call the Get - User Details endpoint. This payment reference must be added to the request in order to associate a transfer and deposit funds into the account successfully.

Updated 8 months ago