Currencycloud Payers API
View information relating to the 'payer' for a payment that has been initiated through the platform.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/currencycloud-payers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: The Currencycloud API is a robust, predictable, easy-to-use API for converting money between currencies and making payments around the world. Dynamically register sub-accounts to provide white labeled money transfer services to your own customers.
version: 2.43.0
title: Currencycloud Payers API
termsOfService: https://www.currencycloud.com/terms-and-conditions/
contact:
name: support
email: support@currencycloud.com
servers:
- url: https://devapi.currencycloud.com/v2
tags:
- name: Payers
description: View information relating to the 'payer' for a payment that has been initiated through the platform.
paths:
/payers/{id}:
get:
tags:
- Payers
x-api-group: pay
summary: Get Payer
description: Get a payer record.
operationId: GetPayer
parameters:
- name: X-Auth-Token
in: header
required: true
description: Authentication token
schema:
type: string
minLength: 32
- name: id
in: path
required: true
description: Payer UUID.
schema:
type: string
format: uuid
- name: on_behalf_of
in: query
required: false
description: A contact UUID for the sub-account you're acting on behalf of.
schema:
type: string
format: uuid
responses:
'200':
description: Success.
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Payer'
'400':
description: Client error.
x-errors:
- code: payer_not_found
category: id
message: Payer was not found for this id
params: ''
- code: contact_not_found
category: on_behalf_of
message: Contact was not found for this id
params: ''
- code: id_is_not_valid_uuid
category: id
message: id should be in UUID format
params: ''
- code: on_behalf_of_self
category: on_behalf_of
message: You cannot act on behalf of your own Contact
params: ''
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/GetPayerError'
'401':
description: Unauthorized.
x-errors:
- code: invalid_supplied_credentials
category: username
message: Authentication failed with the supplied credentials
params: ''
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'404':
description: Resource not found.
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too many requests.
x-errors:
- code: too_many_requests
category: base
message: Too many requests have been made to the api. Please refer to the Developer Center for more information
params: ''
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitError'
'500':
description: Internal server error
x-errors:
- code: internal_server_error
category: base
message: Internal server error
params: ''
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
'503':
description: Service is temporary unavailable
x-errors:
- code: service_unavailable
category: base
message: Service is temporarily unavailable
params: ''
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
default:
description: Unexpected error.
headers:
X-Request-Id:
description: A unique reference for the request.
schema:
type: string
components:
schemas:
NotFoundError:
type: object
description: Resource not found.
required:
- error_code
- error_messages
properties:
error_code:
type: string
description: A high-level error code for the whole request.
error_messages:
type: object
additionalProperties:
type: array
items:
type: object
description: An object that represents one of the reasons why the input parameter failed.
required:
- code
- message
properties:
code:
type: string
description: A unique code that identifies this error. It can be used for translations.
message:
type: string
description: An explanation of the error in English.
params:
type: object
default: {}
description: Relevant validation rules that failed. This can be used for translations.
example:
minlength: 1
maxlength: 255
RateLimitError:
type: object
description: Too many requests.
required:
- error_code
- error_messages
properties:
error_code:
type: string
description: A high-level error code for the whole request.
error_messages:
type: object
description: Detailed error information for individual input parameters that failed validation. Object keys are the names of the invalid input parameters. Each parameter may have one or more reasons why it failed.
additionalProperties:
type: array
items:
type: object
description: An object that represents one of the reasons why the input parameter failed.
required:
- code
- message
properties:
code:
type: string
description: A unique code that identifies this validation/error.
message:
type: string
description: An explanation of the error in English.
params:
type: object
default: {}
description: Relevant validation rules that failed. This can be used for translations.
example:
minlength: 1
maxlength: 255
GetPayerError:
type: object
description: 'Client error information for the Get Payer endpoint.
'
required:
- error_code
- error_messages
properties:
error_code:
type: string
description: A high-level error code for the whole request.
error_messages:
type: object
description: Detailed error information for individual input parameters that failed validation. Object keys are the names of the invalid input parameters. Each parameter may have one or more reasons why it failed.
additionalProperties:
type: array
items:
type: object
description: An object that represents one of the reasons why the input parameter failed.
required:
- code
- message
properties:
code:
type: string
description: A unique code that identifies this error. It can be used for translations.
message:
type: string
description: An explanation of the error in English.
params:
type: object
default: {}
description: Relevant validation rules that failed. This can be used for translations.
example:
minlength: 1
maxlength: 255
Payer:
type: object
description: Payer
properties:
id:
type: string
description: Unique UUID for the payer.
legal_entity_type:
type: string
description: Payer's entity type - company or individual.
enum:
- company
- individual
company_name:
type: string
description: The name of the company (if the payer is a company).
first_name:
type: string
description: Payer's first name.
last_name:
type: string
description: Payer's last name.
address:
type: array
items:
type: string
description: Line of address.
city:
type: string
state_or_province:
type: string
country:
type: string
description: Two-letter ISO country code.
identification_type:
type: string
description: The legal document used to verify the identity of the payer (e.g. passport).
identification_value:
type: string
description: A unique reference code for the identification document, such as a passport number.
postcode:
type: string
date_of_birth:
type: string
created_at:
type: string
updated_at:
type: string
example:
id: 543477161-91de-012f-e284-1e0030c7f3123
legal_entity_type: company
company_name: Acme Corporation
first_name: ''
last_name: ''
address:
- 164 Bishopsgate
- London
city: London
state_or_province: ''
country: GB
identification_type: incorporation_number
identification_value: 123123
postcode: EC2M 4LX
date_of_birth: '2023-12-31T23:59:59.000Z'
created_at: '2023-12-31T23:59:59.000Z'
updated_at: '2023-12-31T23:59:59.000Z'
UnauthorizedError:
type: object
description: Authorization error.
required:
- error_code
- error_messages
properties:
error_code:
type: string
description: A high-level error code for the whole request.
enum:
- auth_failed
error_messages:
type: object
description: Detailed error information for individual input parameters that failed validation. Object keys are the names of the invalid input parameters. Each parameter may have one or more reasons why it failed.
additionalProperties:
type: array
items:
type: object
description: An object that represents one of the reasons why the input parameter failed.
required:
- code
- message
properties:
code:
type: string
description: A unique code that identifies this error. It can be used for translations.
message:
type: string
description: An explanation of the error in English.
params:
type: object
default: {}
description: Relevant validation rules that failed. This can be used for translations.
example:
minlength: 1
maxlength: 255
example:
error_code: auth_failed
error_messages:
api_key:
- code: invalid_supplied_credentials
message: Authentication failed with the supplied credentials
params: {}
externalDocs:
description: API overview
url: https://www.currencycloud.com/developers/