merchantPlatforms

Create processing account

Use this method to add an additional processing account to a merchant platform.

To add a processing account to a merchant platform, you need the merchantPlatformId. Our gateway returned the merchantPlatformId in the response of the Create Merchant Platform method.

Note: If you don't have the merchantPlatformId, use our List Merchant Platforms method to search for the merchant platform.

In the request, include the following information:

  • Business details, including its business type, time zone, and address.
  • Owners' details, including their contact details.
  • Funding, pricing, and processing information, including its pricing model and funding accounts.
  • Additional forms that you need us to send to the merchant, for example, attestations and questionnaires.

When you send a successful request, we review the information about the processing account. After we complete our review and approve the processing account, we assign a processingAccountId, which you need to perform follow-on actions.

Note: You can subscribe to our processingAccount.status.changed event to get notifications when we update the status of a processing account. For more information about how to subscribe to events, go to Events List.

post/merchant-platforms/{merchantPlatformId}/processing-accounts

Path parameters

merchantPlatformIdstring required

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

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

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 body

processingAccountIdstring

Unique identifier of the processing account.

doingBusinessAsstring required

Trading name of the business.

websitestring

Website address of the business.

businessType'retail' | 'restaurant' | 'internet' | 'moto' | 'lodging' | 'notForProfit'

Type of business.

categoryCodeinteger

Merchant Category Code (MCC) for the type of business.

processor'tsys' | 'fiserv'

Processor that authorizes and settles transactions for the processing account.

Note: We recommend that you include a value for the processor parameter and not rely on the default value.

merchandiseOrServiceSoldstring required

Description of the services or merchandise sold by the business.

businessStartDatestring date required

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

timezone'Pacific/Midway' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Phoenix' | 'America/Chicago' | 'America/Indiana/Indianapolis' | 'America/New_York' required

Time zone for the processing account.

metadataobject

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Response

Successful request. We created the processing account.

processingAccountIdstring

Unique identifier of the processing account.

createdDatestring date-time

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

lastModifiedDatestring date-time

Date and time that the processing account was last modified.

status'entered' | 'pending' | 'approved' | 'subjectTo' | 'dormant' | 'nonProcessing' | 'rejected' | 'terminated' | 'cancelled'

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.
    Note: You can subscribe to our processingAccount.status.changed event to get notifications when we change the status of a processing account. For more information about how to subscribe to events, go to Event Subscriptions.
doingBusinessAsstring required

Trading name of the business.

websitestring

Website address of the business.

businessType'retail' | 'restaurant' | 'internet' | 'moto' | 'lodging' | 'notForProfit'

Type of business.

categoryCodeinteger

Merchant Category Code (MCC) for the type of business.

processor'tsys' | 'fiserv'

Processor that authorizes and settles transactions for the processing account.

Note: We recommend that you include a value for the processor parameter and not rely on the default value.

merchandiseOrServiceSoldstring required

Description of the services or merchandise sold by the business.

businessStartDatestring date

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

timezone'Pacific/Midway' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Phoenix' | 'America/Chicago' | 'America/Indiana/Indianapolis' | 'America/New_York' required

Time zone for the processing account.

metadataobject

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Changes

No recorded changes to this endpoint across all 1 revision of this API.