CyberSource Merchant Boarding API
Manage Boarding Registrations
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/cybersource-merchant-boarding-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: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
version: 0.0.1
title: CyberSource Merged Spec bankAccountValidation Merchant Boarding API
servers:
- url: https://apitest.cybersource.com/
tags:
- name: Merchant Boarding
description: Manage Boarding Registrations
paths:
/boarding/v1/registrations:
post:
tags:
- Merchant Boarding
x-devcenter-metaData:
categoryTag: Merchant_Boarding
isJstreeExpansionLimited: true
disableProcessorDropDown: true
authorizationType:
- Json Web Token
overrideMerchantCredential: apitester00
developerGuides: https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html
summary: Create a boarding registration
description: 'Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems.
The Boarding API is designed to simplify and streamline the onboarding process of merchants by enabling administrators and developers to:
1. Enable and Configure Products: The API helps in adding new products to an existing organization and configuring them to suit specific needs.
2. Update Merchant Information: The API allows for updating an organization''s information efficiently.
3. Manage Payment Integration: It provides templates for secure payment integration and management.
'
operationId: postRegistration
parameters:
- in: header
name: v-c-idempotency-id
description: defines idempotency of the request
required: false
schema:
type: string
responses:
'201':
description: Created
headers:
v-c-correlationid:
description: Unique identifier for this request
schema:
type: string
content:
application/json:
schema:
type: object
properties:
id:
type: string
maxLength: 60
example: '12351234'
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
readOnly: true
description: "The status of Registration request\nPossible Values:\n - 'INITIALIZED'\n - 'RECEIVED'\n - 'PROCESSING'\n - 'SUCCESS'\n - 'FAILURE'\n - 'PARTIAL'\n"
registrationInformation:
type: object
properties:
boardingPackageId:
type: string
maxLength: 30
example: 1004001
readOnly: true
mode:
type: string
description: "In case mode is not provided the API will use COMPLETE as default\nPossible Values:\n - 'COMPLETE'\n - 'PARTIAL'\n"
salesRepId:
type: string
maxLength: 60
example: Rep1
integrationInformation:
type: object
properties:
tenantConfigurations:
type: array
description: tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with.
items:
type: object
properties:
solutionId:
type: string
maxLength: 8
minLength: 8
pattern: ^[0-9a-zA-Z_]+$
description: 'The solutionId is the unique identifier for this system resource.
Partner can use it to reference the specific solution through out the system.
'
example: YumSolution1
tenantConfigurationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
description: 'The tenantConfigurationId is the unique identifier for this system resource.
You will see various places where it must be referenced in the URI path, or when
querying the hierarchy for ancestors or descendants.
'
status:
type: string
description: 'Possible values:
- LIVE
- INACTIVE
- TEST'
submitTimeUtc:
type: string
description: Time of request in UTC.
format: date-time
organizationInformation:
type: object
properties:
organizationId:
type: string
maxLength: 30
example: merch-test1
parentOrganizationId:
type: string
example: merch-test1-acct
childOrganizations:
type: array
items:
type: string
example: transactional-org
description: child Organizations is an array of strings. The values returned will be in array format ['string1','string2']
productInformationSetups:
type: array
items:
type: object
properties:
organizationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z]+$
example: merch-test1
setups:
type: object
properties:
payments:
type: object
properties:
cardProcessing:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
alternativePaymentMethods:
type: object
properties:
configurationStatus:
type: object
properties:
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
message:
type: string
subscriptionStatus:
type: object
properties:
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
message:
type: string
status:
type: string
description: 'Possible values:
- PROCESSED
- PARTIAL_PROCESSED'
submitTimeUtc:
type: string
format: date-time
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example: 2024-09-08T09:37:38+0000
'
cardPresentConnect:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
eCheck:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payerAuthentication:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
digitalPayments:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
# --- truncated at 32 KB (1450 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cybersource/refs/heads/main/openapi/cybersource-merchant-boarding-api-openapi.yml