Managing Bank Account Change Requests

Change Requests are vital to managing and updating your account information within the Payrix Pro portal. The term Change Requests refers to an entity adding or updating their bank account information. This entity must submit relevant documentation to support the validity of its new bank account information.

This guide provides an overview of Change Requests, their importance, and how they impact different user levels.

Change Request Capabilities

Partners and Merchants often need to make changes to their bank account information. The Change Request process allows added or changed account information to be submitted with documentation to support the change during risk analysis.

Partners and Merchants can do the following:

• Submit a Change Request

• View or Cancel a Pending Change Request

• View Your Change Request History

Partners can submit Change Requests on behalf of Merchants. This includes the following:

• Updating bank account information from the Banking tab of the Merchant Profile page.

• While logged in as the Merchant, updating bank account information from the Banking tab of the Merchant’s Portal Account Profile.

• Submitting an API call to the /changeRequests endpoint associated with the Merchant’s Login ID.

Prevent Funding to an Existing Bank Account

You can prevent funds from being sent to an existing account while the change request is being reviewed and approved, either as an optional feature for merchants to choose when submitting the bank change or as the default process for your software.

Reasons that a Partner might want to prevent funds from being disbursed to or withdrawn from a Merchant’s existing bank account include, but are not limited to, the following:

• The Merchant’s bank account has been closed by their bank due to reported fraudulent activity.

• The Merchant’s bank account was closed by the merchant before the change request being approved.

• The Merchant added incorrect bank account information by mistake that they do not want to use.

PUT /accounts/{id} HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY: {private_api_key}

Request Body Example

The following example changes the bank account's status parameter from 3 - [Fully] Verified to 1 - Ready [for verification] to remove the verification required to fund a bank account. In addition, you can optionally choose to change the inactive parameter to 1 - Inactive to also achieve a similar result.

Note

All other previous bank account information will remain the same in the request body. If you are unsure about the information of an existing account, you can make an API call to GET /accounts/{id} endpoint using the same path parameter to return the needed information in the response.

{
  "id": "p1_act_5a1ef5e55656698eefaf8b6,",
  "name": "TD Bank"
  "primary": "0",
  "type": "all",
  "reserved": "0",
  "inactive": "1",
  "frozen": "0",
  "status": "1",
}

Change Request Management Flow

See the flowchart below for a visual understanding of the Change Request Management process flow:

Submit a Change Request

As a Partner or Merchant, you might encounter instances where you need to update your bank account information or add a new bank account.

To learn more about the specifics of adding or updating a bank account, see the Bank Account Maintenance articles:

• Adding a Bank Account

• Updating a Bank Account

The processes below outline how to submit a Change Request to update your or your Merchant’s bank account information.

See Test Bank Account Change Requests in the Sandbox Environment for parameters that can be used to review the outcome of various Change Request results.

Using the Portal

Submitting a change request using the Portal can be completed in a few simple steps along with easy upload of the supporting documents in a single process:

While Merchants can submit their Change Requests, Partners have the unique ability to log in as the Merchant and submit Change Requests on behalf of a Merchant.

Submit a Change Request for bank account information by following the steps below:

1. Navigate to the Banking tab and click ADD NEW ACCOUNT using one of the Portal pages below:

   • Your primary Partner or Merchant Portal Account Profile page (located on the Dashboard)

   • Your desired Merchant’s profile page

2. If Plaid is unavailable for any reason, click ADD ACCOUNT MANUALLY. This will display the message below. Then, click Continue.
   Adding a new bank account will take up to 5 business days to verify, you can continue to use your current bank account until your new account is confirmed.
   You will be required to upload a void check, bank statement, or bank letter to verify your account. Thank you for helping to keep your account safe.

3. Upload any supporting documents and click Save.

   Note

   The bank account change request process requires a valid document upload to add a new account or change account and routing numbers for existing accounts. Valid supporting documents include the following:

   • A void check

   • A bank letter

   • A bank statement

4. After the change is made, the Merchant or Partner is provided the below message. Click Done to finish submitting the Change Request.
   Your changes have been made.
   Your changes are currently being validated for review.

Using the API

Submitting a Change Request using the API is a multi-part process. Follow each expandable step below for each applicable step to submit a change request for a bank account with supporting documentation:

Step 1: Create a new account or update an existing account.

Visit the Payrix Pro API Documentation for parameter descriptions and valid values.

Request URL and Headers

POST /accounts HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}

Alternatively, you can use the endpoint with a PUT request method using the Account ID as a path parameter to update an existing account's information using the same parameters below.

PUT /accounts/{id} HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}

Example Request Body

{
  "primary": 1,
  "type": "all",
  "status": 1,
  "reserved": 1,
  "currency": "USD",
  "inactive": "0",
  "frozen": "0",
  "entity": "string",
  "name": "string",
  "description": "string",
  "checkStage": "createAccount",
  "expiration": "0529"
}

Note

The parameter descriptions above apply to the data object parameters in the response as well.

Example Response

{
    "response": {
        "data": [
          {
            "account": {
              "method": 8,
              "number": 2345,
              "routing": 3924,
              "payment": null
            },
            "id": "p1_act_5a1ef5e55656698eefaf8b6",
            "created": "2017-11-28T01:02:57.000Z",
            "modified": "2017-11-28T01:02:57.000Z",
            "creator": "p1_log_5a1ef5e55653ed720159d53",
            "modifier": "p1_log_5a1ef5e55653ed720159d53",
            "entity": "p1_ent_5a1ef5e5565631155c95344",
            "token": "ae1abb3aaa18e4c374ca83fa75a7fff6",
            "name": "",
            "description": "",
            "primary": 1,
            "status": 0,
            "currency": "USD",
            "inactive": 0,
            "frozen": 0
          }
        ],
        "details": {
            "requestId": 1
        },
        "errors": [],
        "messages": [
            "Change request p1_chr_6513a1e2144ac0c8219c231 was created. This request may need to be reviewed and approved before taking effect."
        ]
    }
}

Step 2 - Create a new note associated with the entity (Merchant).

Create a Note Resource to Associate with an Entity and Documents - Example Code Snippet

Visit the Payrix Pro API Documentation for parameter descriptions and valid values.

Request URL and Header

POST /notes HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}

Example Request Body

{
  "login": "t1_log_xxxxxxxxxxxxxxxx"
  "entity": "t1_ent_xxxxxxxxxxxxxxxx",
  "type": "note",
  "data": "ABC Company Bank Account Change Request",
  "note": "Supporting documents for account change.",
}

Example Response

{
  "id": "t1_not_xxxxxxxxxxxxxxxxxx",
  "created": "2023-10-25T19:10:44.278Z",
  "modified": "2024-10-25T19:10:44.278Z",
  "creator": "t1_log_xxxxxxxxxxxxxxxx",
  "modifier": "t1_log_xxxxxxxxxxxxxxxx",
  "login": "t1_log_xxxxxxxxxxxxxxxx",
  "entity": "t1_ent_xxxxxxxxxxxxxxxxx",
  "type": "note",
  "data": "ABC Company Bank Account Change Request",
  "note": "Supporting documents for account change.",
  "inactive": "0",
  "frozen": "0"
}

Step 3 - Create a new document (noteDocument) associated with the new Note.

Create a Document Resource to Associate with the Note - Example Code Snippet

Visit the Payrix Pro API Documentation for parameter descriptions and valid values.

Request URL and Header

POST /noteDocuments HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}

Example Request Body

{
  "note": "t1_not_xxxxxxxxxxxxxxxxxx",
  "type": "png",
  "documentType": "voidCheck",
  "description": "Updating Existing Bank Account.",
  "name": "Voided Bank Check for ABC Company",
  "status": "created",
  "inactive": "0",
  "frozen": "0"
}

voidCheck is used in the example above, but any of the following documents can be used in this process:

• voidCheck: A voided check for bank account verification

• bankStatement: A bank statement

• bankLetter: A bank letter for verification

Important!

Submitting the wrong documentType (for example, submitting a bank letter when voidCheck is selected) can cause significant delays in underwriting approval.

Example Response

{
  "id": "t1_ntd_xxxxxxxxxxxxxxxxxx",
  "created": "2024-08-18 13:22:51.2252",
  "modified": "2024-08-18 13:22:51.2252",
  "creator": "t1_log_xxxxxxxxxxxxxxxxxx",
  "modifier": "t1_log_xxxxxxxxxxxxxxxxxx",
  "note": "t1_not_xxxxxxxxxxxxxxxxxx",
  "type": "png",
  "documentType": "voidCheck",
  "name": "Voided Bank Check for ABC Company",
  "description": "Updating Existing Bank Account",
  "status": "created",
  "inactive": "0",
  "frozen": "0"
}

Step 4 - Upload the document file to the associated new document (noteDocument).

Upload the Image or Document File Associated with the Entity’s Note - Example Code Snippet

Visit the Payrix Pro API Documentation for parameter descriptions and valid values.

Request URL and Header

POST /files/noteDocuments/{id} HTTP/1.1
Accept: application/json
Content-Type: multipart/form-data
Body: form-data
Host: api-test.payrix.com
APIKEY:{apiKey}

Example Request Body (form-data)

name: Document Name
filename: <Selected File>

Example Request Body (JSON)

{
  "credential": "string",
  "type": "png",
  "integration": "PAYRIX",
  "direction": "upload",
  "status": "pending",
  "retries": 0,
  "name": "Voided Bank Check for ABC Company",
  "inactive": 0,
  "frozen": 0
}

Example Response

{
  "id": "t1_fil_xxxxxxxxxxxx",
  "created": "2023-10-25T19:10:44.278Z",
  "modified": "2023-10-25T19:10:44.278Z",
  "creator": "t1_log_xxxxxxxxxxxxx",
  "modifier": "t1_log_xxxxxxxxxxxxx",
  "credential": "string",
  "integration": "PAYRIX",
  "name": "Voided Bank Check for ABC Company",
  "file": "string",
  "type": "png",
  "status": "pending",
  "retries": 0,
  "direction": "upload",
  "inactive": 0,
  "frozen": 0
}

After submitting your Change Request, Payrix Pro risk analysts will conduct a review of the submitted account information and supporting documentation.

This submission will be Approved, meaning a manual review was conducted and the information submitted was validated and accepted; or Declined, followed by:

• A note added to the Partner or Merchant account.

• An email to the user that submitted the Change Request with more detail explaining the review result and reason.

Decline Responses

When a submission is Declined, a reason and accompanying note will be added to your entity account by the reviewer. Declines can occur for one of the following reasons:

View Your Pending Change Requests

As a Partner or Merchant, having a validated and ready-to-use bank account is critical to the operations of any business.

When submitting a Change Request for your existing bank account (or adding a new bank account), the waiting period can take up to 5 business days.

To provide clarity into the risk analysis process, the Pending Change Requests queue ensures you’re constantly informed about the status of your Change Request.

View or Cancel Pending Change Requests in the Portal

1. Navigate to the Banking tab using one of the Portal pages below:

   • Your primary Partner or Merchant Portal Account Profile page

   • Your desired Merchant’s Profile page

2. Look for your previously submitted Change Request to be listed under Pending Change Requests.

The Status field will display the current risk analysis review step in the process.

Note

You can cancel your Change Request at any time while in Manual Review status by clicking the cancel button (red “X”) on the right side of any Pending Change Request listing.

View or Cancel Pending Change Requests using the API

Use the following API call to retrieve a pre-existing Change Request and view its status:

Request:

GET /changeRequests HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}
SEARCH: entity[equals]={entityId}&deleted[exact]=null&model[equals]=accounts&status[in]=pending,manualReview

You can also cancel a change request using the same API call above, by changing the HTTP method from GET to DELETE.

View Your Change Request History

As a Partner or Merchant, there may be scenarios where validating previously submitted Change Requests may be helpful for auditing purposes.

The processes outlined below will demonstrate how to view or retrieve information about your previous Change Requests:

View Change Request History

1. Click the Profile tab on the Portal Dashboard.

2. Click the Change Request History tab to see all listed Change Requests.

The Change Request History tab will display a list of all Change Requests submitted, whether pending, approved, or declined.

The Status field will display the current risk analysis review step in the process.

View All Change Request History

Use the following API call to retrieve a complete list of all Change Requests for your login:

URL and Method

GET /changeRequests HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}
SEARCH: entity[equals]={entityId}&deleted[exact]=null&model[equals]=accounts

View All Change Requests Associated with a Login

URL and Method

GET /logins/{loginId}?expand[analyzedChangeRequests][] HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY:{apiKey}

Test Bank Account Change Requests in the Sandbox Environment

Using the following bank account information, you can submit a manual change request that will be treated as a sandbox test when submitted in the Sandbox environment.

The routing numbers provided below will generate a specific automated risk decision for each type of Change Request result to help you better understand the process.

Note

You can use any 10 to 12-digit account number for US-based entities and 8 to 12-digit account number for Canada-based entities.