processingAccounts

Retrieve processing account

Changed on

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.
get/processing-accounts/{processingAccountId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-accounts/{processingAccountId}
  • Auth
    HTTP bearer

Path parameters

processingAccountIdstring required

Unique identifier that we assigned to the processing account.

Response

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

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 2365ff7cb3a5Revision changes
    • breaking

      added subschema #10 to the / response property oneOf list for the response status