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 Payments API

Create, search, manage and action all of your domestic and international payments through this API.

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

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

This API exposes 16 operations across 15 paths, and defines 30 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.

16 operations 15 paths 30 schemas 8 GET8 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 Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (AuthToken).

Paths & Operations 16

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

Payments 16

Create, search, manage and action all of your domestic and international payments through this API.

POST
/payments/create
Create Payment
CreatePayment 33 params → 200400401404429500503default
GET
/payments/find
Find Payments
FindPayments 30 params → 200400401404429500503default
GET
/payments/{id}
Get Payment
GetPayment 5 params → 200400401404429500503default
POST
/payments/{id}
Update Payment
UpdatePayment 31 params → 200400401404429500503default
GET
/payments/{id}/confirmation
Get Payment Confirmation
GetPaymentConfirmation 2 params → 200400401404422429500503
GET
/payments/{id}/submission_info
Get Payment Submission Information
GetNewPaymentSubmission 3 params → 200400401404429500503default
POST
/payments/authorise
Authorise Payment
AuthorisePayment 2 params → 200400401404429500503default
POST
/payments/{id}/delete
Delete Payment
DeletePayment 3 params → 200400401404429500503default
GET
/payments/{id}/tracking_info
Get Payment Tracking Information
GetPaymentTrackingInfo 2 params → 200400401403404429500503
POST
/payments/assign_payment_fee
Assign Payment Fee
PaymentsAssignPaymentFee 3 params → 200400401403404429500503
GET
/payments/payment_delivery_date
Get Payment Delivery Date
GetPaymentDeliveryDate 5 params → 200400401429500503default
GET
/payments/payment_fees
Get Payment Fees
GetPaymentPaymentFees 5 params → 200401403429500503default
GET
/payments/quote_payment_fee
Get Quote Payment Fee
GetQuotePaymentFee 6 params → 200400401404429500503default
POST
/payments/unassign_payment_fee
Unassign Payment Fee
PaymentsUnassignPaymentFee 2 params → 200400401403404429500503
POST
/payments/validate
Validate Payment
ValidatePayment 31 params → 200400401404429500503default
POST
/payments/{id}/notifications/retry
Resend Payment Notification
PaymentsRetryNotifications 3 params → 200400401404429500503default

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Payment (31 properties), PaymentConfirmation (9 properties), Pagination (8 properties), QuotePaymentFee (7 properties). Each schema is shown below with its type and property counts.

FindPaymentsError
object
Client error information for the Get Payments endpoint.
2 properties 2 required
PaymentAuthorisations
object
Payment Authorisations.
1 property
PaymentTrackingInfo
object
PaymentTrackingInfo
6 properties 6 required
PaymentFeeUnassignmentError
object
Client error information for the Payment Fee Unassignment endpoint.
2 properties 2 required
RetryNotificationError
object
Client error information for the retry payment notification endpoint.
2 properties 2 required
PaymentDeliveryDate
object
Payment Delivery Date
6 properties 6 required
PaymentSubmissionInformation
object
Payment submission.
4 properties
PaymentFeeUnassignment
object
Payment fee unassignment.
1 property 1 required
GetPaymentDeliveryDateError
object
Client error information for the Get Payment Delivery Date endpoint.
2 properties 2 required
Pagination
object
Pagination.
8 properties
GetPaymentSubmissionError
object
Client error information for the Get Payment Submission endpoint.
2 properties 2 required
CreatePaymentAuthorisationError
object
Client error information for the Create Payment Authorise endpoint.
2 properties 2 required
QuotePaymentFee
object
Quote payment fee.
7 properties 7 required
GetQuotePaymentFeeError
object
Client error information for the Get Quote Payment Fee endpoint.
2 properties 2 required
Payment
object
Payment
31 properties
UnauthorizedError
object
Authorization error.
2 properties 2 required
CreatePaymentError
object
Client error information for the Create Payment endpoint.
2 properties 2 required
RateLimitError
object
Too many requests.
2 properties 2 required
ForbiddenError
object
Permission error.
2 properties 2 required
UpdatePaymentError
object
Client error information for the Update Payment endpoint.
2 properties 2 required
PaymentFeeAssignment
object
Payment Fee Assignment.
2 properties 2 required
PaymentConfirmation
object
Payment confirmation.
9 properties
ValidatePaymentError
object
Client error information for the Validate Payment endpoint.
2 properties 2 required
NotFoundError
object
Resource not found.
2 properties 2 required
GetPaymentError
object
Client error information for the Get Payment endpoint.
2 properties 2 required
PaymentFeeAssignmentError
object
Client error information for the Payment Fee Assignment endpoint.
2 properties 2 required
PaymentAuthorisation
object
Payment Authorisation.
7 properties
PaymentFee
object
Payment fee.
7 properties 7 required
GetPaymentTrackingInfoError
object
Client error information for the Get Payment Tracking Info endpoint.
2 properties 2 required
DeletePaymentError
object
Client error information for the Delete Payment endpoint.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

currencycloud-payments-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 Payments 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.