How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Currencycloud Reference API

Easy access to view important data relevant to your Currencycloud account including beneficiary details, conversion dates, available currencies, payer required details, payment dates and settlement details.

Currencycloud Reference API is one of 27 APIs that Currencycloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reference. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 9 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 3 base URLs: /onboarding, https://api.currencycloud.com/onboarding, https://devapi.currencycloud.com/onboarding.

9 operations 9 paths 21 schemas 8 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.currencycloud.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Currencycloud Reference API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (AuthToken).

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 8 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reference 9

Easy access to view important data relevant to your Currencycloud account including beneficiary details, conversion dates, available currencies, payer required details, payment da…

POST
/reference/bank_details/find
Find Bank Details
FinfBankDetailsPost 3 params → 200400401429500503default
GET
/reference/beneficiary_required_details
Get Beneficiary Requirements
GetBeneficiaryRequirements 5 params → 200400401404429500503default
GET
/reference/conversion_dates
Get Conversion Dates
GetConversionDates 4 params → 200400401404429500503default
GET
/reference/currencies
Get Available Currencies
GetAvailableCurrencies 1 param → 200400401404429500503default
GET
/reference/payer_required_details
Get Payer Requirements
GetPayerRequirements 5 params → 200400401404429500503default
GET
/reference/payment_dates
Get Payment Dates
GetPaymentDates 3 params → 200400401404429500503default
GET
/reference/payment_fee_rules
Get Payment Fee Rules
GetPaymentFeeRules 4 params → 200400401404429500503default
GET
/reference/payment_purpose_codes
Get Payment Purpose Codes
GetPaymentPurposeCodes 4 params → 200400401404429500503default
GET
/reference/settlement_accounts
Get Settlement Accounts
GetSettlementAccounts 3 params → 200400401404429500503default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BeneficiaryRequirements (19 properties), SettlementAccount (14 properties), BankDetails (13 properties), ConversionDates (7 properties). Each schema is shown below with its type and property counts.

PaymentPurposeCodes
object
Payment purpose codes.
5 properties
AvailableCurrencies
object
Available currencies
6 properties
PayerRequirements
object
Payer requirements.
3 properties
BankDetails
object
Bank Details
13 properties 2 required
BeneficiaryRequirements
object
Beneficiary requirements.
19 properties
ConversionDates
object
Conversion dates.
7 properties
GetPaymentFeeRulesError
object
Client error information for the Get Payment Fee Rules endpoint.
2 properties 2 required
GetPayerRequirementsError
object
Client error information for the Get Payer Requirements endpoint.
2 properties 2 required
GetAvailableCurrenciesError
object
Client error information for the Get Available Currencies endpoint.
2 properties 2 required
SettlementAccount
object
Settlement accounts.
14 properties
GetBeneficiaryRequirementsError
object
Client error information for the Get Beneficiary Requirements endpoint.
2 properties 2 required
UnauthorizedError
object
Authorization error.
2 properties 2 required
RateLimitError
object
Too many requests.
2 properties 2 required
PaymentFeeRule
object
Payment fee rule.
6 properties 6 required
NotFoundError
object
Resource not found.
2 properties 2 required
PaymentDates
object
Payment dates.
2 properties
GetConversionDatesError
object
Client error information for the Get Conversion Dates endpoint.
2 properties 2 required
GetPaymentPurposeCodesError
object
Client error information for the Get Payment Purpose Codes endpoint.
2 properties 2 required
GetPaymentDatesError
object
Client error information for the Get Payment Dates endpoint.
2 properties 2 required
GetSettlementAccountsError
object
Client error information for the Get Settlement Accounts endpoint.
2 properties 2 required
GetBankDetailsError
object
Client error information for the Get Bank Details endpoint.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

currencycloud-reference-api-openapi.yml Raw ↑

Other APIs Currencycloud publishes across the network.

Currencycloud Account Usage API
Currencycloud Accounts API
Currencycloud Authenticate API
Currencycloud Balances API
Currencycloud Beneficiaries API
Currencycloud Business Information API
Currencycloud Contacts API
Currencycloud Conversions API
Currencycloud Country API
Currencycloud Currency API
Currencycloud Demo API
Currencycloud Document Images API
Where this information came from

This is an independent, third-party profile of Currencycloud Reference API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.