There are scenarios in which you may want to update your existing account on the Platform, as opposed to adding a new bank account. This could be the result of fraudulent activity on your account where your bank provides you with a new account and/or routing number.

Follow the processes below for the two-step update process:

Update the information for the bank account - PUT /accounts/{id}

...

This guide will walk you through the update and validation process required to update the information for your existing bank account.

Note: This process and its review period apply to Merchant and Referrer-level users.

Bank Account Types and Requirements

All Merchants or Referrers boarded to the Platform must have an active U.S.-based bank account on file. A bank account serves two purposes for an entity:

Account for Deposits - Arequired bank account to receive deposits from Available Balance funds.
Account for Debits - A required bank account to be debited to cover negative balances owed.

Merchants or Referrers can use one bank account on file for both payouts and debits, individual bank accounts for deposits and debits, or multiple bank accounts with unique, individual purposes.

Bank Account Validation

As a Payment Facilitator, the Platform validates any bank account submitted by an entity. This validation includes active status, type of account, & ownership and prevents funds from being sent to an incorrect bank account due to a typo or invalid information.

To perform the validation, the Platform uses Plaid to allow Merchants or Referrers to linktheir bank account(s) for instant validation using a Portal lightbox to securely log in to their bank for integration.

Manual Bank Account Validation - Supporting Documents

If an entity manually submits its bank account information, they are required to submit documentation to Platform Risk for account validation. See Steps 2-4 of the Manually Update with the API

Tip

Qualifying Bank Account Supporting Documentation is:

A Void Check,
A Bank Letter, or;
A Bank Statement.

Info
For existing bank accounts, supporting documents are only required if the routing or account number fields are being updated. Changes to account types do not require supporting documentation.

When entering information in the Portal for a new bank account manually, like account and routing numbers, a file upload window at the bottom of the form requires a document file to be uploaded before the form can be submitted.

Note

Bank Account Update Approval Period

NoteWarning: For existing bank accounts having account or routing numbers updated, a manual review of the supporting document(s) is required for approval and can take up to 5 business days.

Warning

Payments Interrupted During Approval Period

Critical Warning: During the 5-day manual review and approval period, all payments processed will still be funded to your Portal account’s available balance and will be ready for immediate withdrawal to your bank account, once validated.

Enhancements to fund a previously approved account while you wait for a new account to be approved, coming soon.

...

Manually Update in the Portal

The Portal uses the Banking tab within the Merchant or Referrer Profile to update or add new bank account information to a specific Entity. In instances where an entity’s banking institution does not currently integrate with Plaid, or the Entity would like to manually add the account, this option is useful.

Expand

title	Click here to see Portal steps for manually updating an existing bank account.

To manually update an existing bank account in the Portal, follow the steps below:

Step 1: Navigate to the Merchants or Referrers page within the Management category.

Step 2: Click on the desired Merchant to bring up their Merchant Profile or Referrer Profile.

Step 3: Click the Banking tab on the left.

Step 4: Click the edit icon button in the upper right-hand corner.

Step 5: Click the ADD ACCOUNT MANUALLY button in the lightbox and view the prompt below:

Info

Minor Updates to Existing Bank Accounts

For existing bank accounts, supporting documents are only required if the routing or account number fields are being updated

“Adding a new bank account will take up to 5 business 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.”

Step 6: Click Continue on the prompt, then click the ENTER ACCOUNT MANUALLY button.

Step 7: Enter the Type of bank account, Routing & Account Number, and Usage Options

Click ADVANCED OPTIONS to add an optional bank account name and description.

Step 8: Upload one of the qualifying support documents into the Upload and Attach Files field.

Step 9: Click the ADD button to complete the process.

Warning
Note: You will not be able to use this manually added account for up to 5 business days from update or creation.

Manually Update with the API

See the twomulti-step process below to update an existing bank account’s information and upload supporting documentation:

Update the existing information for the bank account - PUT /accounts/{id}
Upload supporting documentation for the change:
1. Create the new Note Resource - POST /notes
2. Create a Document Resource to associate with the upload - POST /noteDocuments
3. Upload the document or image file - POST /files/noteDocuments/{id}

Expand

title	Step 1 - Update existing bank account information.

Updating an existing Bank Account - Example Code Snippet

Visit our API Documentation for parameter descriptions and valid values.

Request URL & Header

Code Block
PUT https://api.payrix.com/accounts/{id}

Header

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

Example Request Body

Code Block

language	json

{
    "entity": "{{Entity_ID}}t1_ent_xxxxxxxxxxxxxx",
    "primary": "0",
    "currency": "USD",
    "name":"Bank Account Non-Primary",
    "account": {
        "method": "10",
        "number": "{{New_Account_Number}}",
        "routing": "{{New_Routing_Number}}"
        }
}

Example Response

Code Block

language	json

{
    "response": {
   
    "data": [
            {
                "account": {
                    "id": "t1_pmt_64dfc894cc34c311054a9e7xxxxxxxxxxxxxxxxx",
                    "method": "8",
 
                  "number": "1234567890123456",
         
          "routing": "021000021123456789",
                    "bin": "122000661123456789",
          
         "payment": null,
 
                  "lastChecked": null,

                   "last4": "80251111"
                },
                "id": "t1_act_64dfc894d9fe3b3be25990bxxxxxxxxxxxxxxxxx",
  
             "created": "2023-08-18 15:37:56.9284",
   
            "modified": "20232024-08-18 15:37:56.9284",
        
       "creator": "t1_log_5f875c53ed397f57c0afc90xxxxxxxxxxxxxxx",
                "modifier": "t1_log_5f875c53ed397f57c0afc90xxxxxxxxxxxxxxxx",
    
           "entity": "t1_ent_644b872c814508ba0ad1147xxxxxxxxxxxxxxxxx",
                "token": "ac1234cc5ae67b89101a11213d1a4e15",
       
        "name": "Bank Account Non-Primary",
                "description": "",
           
    "primary": "0",
   
            "status": 0,
  
             "currency": "USD",
   
            "inactive": 0,
                "frozen": 0,
        
       "expiration": null,
    "type": "all",
    "reserved": 0,
    "typecheckStage": "all",
                "reserved": 0,
                "checkStage": null
            }
        ],
        "details": {
            "requestId": 1
        },
        "errors": []
    }

Expand

title	Step 2 - Submit supporting bank account documentation.

Submit Bank Account Supporting Documents using the API

URL

Code Block
POST https://api.payrix.com/noteDocuments

Header

Code Block
Content-Type:application/json null }

Expand

title	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 our API Documentation for parameter descriptions and valid values.

Request URL & Header

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

Example Request Body

Code Block

language	json

{
  "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

Code Block

language	json

{
  "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"
}

Expand

title	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 our API Documentation for parameter descriptions and valid values.

Request URL & Header

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

Example Request Body

Code Block

language	json

{
  "note": "{{Note_ID}}t1_not_xxxxxxxxxxxxxxxxxx",
  "type": "PNGpng",
  "documentType": "voidCheck",
  "description": "Updating Existing Bank Account."
}

Example Response

Code Block
{, "responsename": {"Voided Bank Check for ABC Company", "datastatus": ["created", inactive: "0", frozen: { "0" }

Info

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.

Note
Warning: Submitting the wrong `documentType` (i.e. submitting a bank letter when `voidCheck` is selected) may cause significant delays in underwriting approval.

Example Response

Code Block

language	json

{
  "id": "{{Document_ID}}",
                t1_ntd_xxxxxxxxxxxxxxxxxx",
  "created": "2024-08-18 13:22:51.2252",

               "modified": "2024-08-18 13:22:51.2252",
                "creator": "{{createdByUserId}}t1_log_xxxxxxxxxxxxxxxxxx",
    
           "modifier": "{{createdByUserId}}",
            t1_log_xxxxxxxxxxxxxxxxxx",
   "note": "{{Note_ID}}t1_not_xxxxxxxxxxxxxxxxxx",
  "type": "png",
  "documentType": "voidCheck",
        "custom"name": null,"Voided Bank Check for ABC Company",
  "description": "Updating Existing Bank Account",
    "typestatus": "PNGcreated",
          
     "documentTypeinactive": "voidCheck0",
  "frozen": "0"
}

Expand

title	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 our API Documentation for parameter descriptions and valid values.

Request URL & Header

Code Block
POST /files/noteDocuments/{id} HTTP/1.1 Accept: application/json Content-Type: multipart/form-data Body: form-data "name": null, "description": "Description of FileHost: api-test.payrix.com

Example Request Body (form-data)

Code Block
name: Document Name filename: <Selected File>

Example Request Body (JSON)

Code Block

language	json

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

Example Response

Code Block

language	json

{
  "id": "t1_fil_xxxxxxxxxxxx",
    "created": "2023-10-25T19:10:44.278Z",
  "frozenmodified": 0"2023-10-25T19:10:44.278Z",
  "creator": "t1_log_xxxxxxxxxxxxx",
  "modifier": "t1_log_xxxxxxxxxxxxx",
  "credential": "string",
}         ],
     "integration": "PAYRIX",
  "detailsname": {"Voided Bank Check for ABC Company",
  "file": "string",
   "requestIdtype": 1"png",
  "status": "pending",
    }"retries": 0,
  "direction": "upload",
    "errorsinactive": []0,
    }
}

Manually Update in the Portal

The Portal uses the Banking tab within the Merchant or Referrer Profile to update or add new bank account information to a specific Entity. In instances where an entity’s banking institution does not currently integrate with Plaid, or the Entity would like to manually add the account, this option is useful.

Expand

title	Click here to see Portal steps for manually updating a new bank account.

To manually update an existing bank account in the Portal, follow the steps below:

Step 1: Navigate to the Merchants or Referrers page within the Management category.

Step 2: Click on the desired Merchant to bring up their Merchant Profile or Referrer Profile.

Step 3: Click the Banking tab on the left.

Step 4: Click the edit icon button in the upper right-hand corner.

Step 5: Click the ADD ACCOUNT MANUALLY button in the lightbox and view the prompt below:

Info

“Adding a new bank account will take up to 5 business 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.”

Step 6: Click Continue on the prompt, then click the ENTER ACCOUNT MANUALLY button.

Step 7: Enter the Type of bank account, Routing & Account Number, and Usage Options

Click ADVANCED OPTIONS to add an optional bank account name and description.

Step 8: Upload one of the qualifying support documents into the Upload and Attach Files field.

Step 9: Click the ADD button to complete the process.

Warning
Note: You will not be able to use this manually added account for up to 5 business days from update or creation. "frozen": 0 }

Versions Compared

Old Version 1

New Version Current

Key

Bank Account Types and Requirements

Bank Account Validation

Manual Bank Account Validation - Supporting Documents

Bank Account Update Approval Period

Payments Interrupted During Approval Period

Manually Update in the Portal

Minor Updates to Existing Bank Accounts

Manually Update with the API

Updating an existing Bank Account - Example Code Snippet

Submit Bank Account Supporting Documents using the API

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

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

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

Manually Update in the Portal

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Bank Account Types and Requirements

Bank Account Validation

Manual Bank Account Validation - Supporting Documents

Bank Account Update Approval Period

Payments Interrupted During Approval Period

Manually Update in the Portal

Minor Updates to Existing Bank Accounts

Manually Update with the API

Updating an existing Bank Account - Example Code Snippet

Submit Bank Account Supporting Documents using the API

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

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

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

Manually Update in the Portal