SchemaBoardingMerchant Platforms

Create processing account

Use this method to create a processing account and add it to a merchant platform.

Note: You can create and add a processing account only to an existing merchant platform. If you have not already created a merchant platform, go to Create a merchant platform.

In the response we return a processingAccountId for the processing account, which you need for the following methods.

Path parameters

merchantPlatformIdstringRequired

Unique identifier of the merchant platform that we sent to you when you created the merchant platform.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
doingBusinessAsstringRequired<=100 characters

Trading name of the business.

ownerslist of objectsRequired

Collection of individuals that are responsible for a processing account. When you create a processing account, you must indicate at least one owner as either of the following:

  • Control prong - An individual who has a significant equity stake in the business and can make decisions for the processing account. You can add only one control prong to a processing account.
  • Authorized signatory - An individual who doesn’t have an equity stake in the business but can make decisions for the processing account.
businessTypeenumRequired

Type of business.

categoryCodeintegerRequired

Category code for the type of business.

merchandiseOrServiceSoldstringRequired<=125 characters

Description of the services or merchandise sold by the business.

businessStartDatestringRequiredformat: "date"

Date that the business was established. The format of the value is YYYY-MM-DD.

timezoneenumRequired

The timezone for the processing account

addressobjectRequired
contactMethodslist of objectsRequired

Array of contactMethod objects. One contact method must be an email address.

processingobjectRequired
fundingobjectRequired
pricingobjectRequired

Object that contains pricing information.

signatureenumRequired

Method used to capture the owner’s signature.

Note: If you request the owner’s signature by email and they don’t respond, use our Reminders endpoint to create a reminder and to send another email.

Allowed values:
websitestringOptional<=128 characters

Website address of the business.

contactslist of objectsOptional

Array of contact objects.

metadatamap from strings to stringsOptional

Object that you can send to include custom data in the request.

Response

Successful request. We created the processing account.

doingBusinessAsstring<=100 characters

Trading name of the business.

ownerslist of objects

Object that contains information about the owners of the business.

businessTypeenum

Type of business.

categoryCodeinteger

Category code for the type of business.

merchandiseOrServiceSoldstring<=125 characters

Description of the services or merchandise sold by the business.

timezoneenum

The timezone for the processing account

addressobject
contactMethodslist of objects

Array of contactMethods objects for the processing account. Atleast one contactMethod must be an email address.

processingobject
fundingobject

Object that contains funding information.

pricingobject

Object that contains pricing information.

signatureobject

Object containing the method we used to capture the owner’s signature.

processingAccountIdstringOptional

Unique identifier of the processing account.

createdDatestringOptionalformat: "date-time"

Date and time that we received your request to create the processing account in our system.

lastModifiedDatestringOptionalformat: "date-time"

Date and time that the processing account was last modified.

statusenumOptional

Status of the processing account.

  • entered - We have received information about the account, but we have not yet reviewed it.
  • pending - We have reviewed the information about the account, but we have not yet approved it.
  • approved - We have approved the account for processing transactions and funding.
  • subjectTo - We have approved the account, but we are waiting on further information.
  • dormant - Account is closed for a period.
  • nonProcessing - We have approved the account, but the merchant has not yet run a transaction.
  • rejected - We rejected the application for the processing account.
  • terminated - Processing account is closed.
  • cancelled - Merchant withdrew the application for the processing account.
websitestringOptional<=128 characters

Website address of the business.

businessStartDatestringOptionalformat: "date"

Date that the business was established. The format of the value is YYYY-MM-DD.

contactslist of objectsOptional

Array of contact objects.

metadatamap from strings to stringsOptional

Object that you can send to include custom data in the request.

Errors