SchemaBoardingProcessing Accounts

Retrieve processing account

Use this method to retrieve information about a specific processing account.

To retrieve a processing account, you need its processingAccountId. Our gateway returned the processingAccountId in the response of the Create Merchant Platform method or the Create Processing Account method.

Note: If you don’t have the processingAccountId, use our List Merchant Platform’s Processing Accounts method to search for the processing account.

Our gateway returns the following information about the processing account:

  • Business information, including the Merchant Category Code (MCC), status of the processing account, and address of the business.
  • Processing information, including the merchant’s refund policies and card types that the merchant accepts.
  • Funding information, including funding schedules, funding fees, and details for the merchant’s funding accounts.
  • Pricing information, including HATEOAS links to retrieve the pricing program for the processing account.

Path parameters

processingAccountIdstringRequired
Unique identifier that we assigned to the processing account.

Headers

AuthorizationstringRequired

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

Response

Successful request. Returns 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

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

merchandiseOrServiceSoldstring<=125 characters
Description of the services or merchandise sold by the business.
timezoneenum
Time zone for the processing account.
addressobject
contactMethodslist of objects
Array of contactMethods objects for the processing account. At least one contactMethod must be an email address.
processingobject
Object that contains information about how we process transactions for the account.
fundingobject
Object that contains funding information for the processing account, including funding schedules, funding fees, and details of funding accounts.
pricingobject
Object that HATEOAS links to the pricing information that we apply to the processing account.
signatureobject
Object that includes information about how we captured the owner's signature.
processingAccountIdstring or null
Unique identifier of the processing account.
createdDatedatetime or null
Date and time that we received your request to create the processing account in our system.
lastModifiedDatedatetime or null
Date and time that the processing account was last modified.
statusenum or null

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.
websitestring or null<=128 characters
Website address of the business.
businessStartDatedate or null

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

contactslist of objects or null
Array of contact objects.
metadatamap from strings to strings or null

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

Errors