If an entity manually submits their its bank account, they are required to submit documentation to Platform Risk for account validation.

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. This can also be achieved using the API . See using the steps provided below:.\

...

title	Click here to see API code examples for submitting supporting bank account documents.

Submit Bank Account Supporting Documents using the API

URL

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

Header

Code Block
Content-Type:application/json APIKEY:{{private_api_key}}

Request Body

Code Block

language	json

{
  "note": "{{Note_ID}}",
  "type": "PNG",
  "documentType": "voidCheck",
  "description": "Description of file"
}

Example Response

Code Block

language	json


{
    "response": {
        "data": [
            {
                "id": "{{Document_ID}}",
                "created": "2024-08-18 13:22:51.2252",
                "modified": "2024-08-18 13:22:51.2252",
                "creator": "{{createdByUserId}}",
                "modifier": "{{createdByUserId}}",
                "note": "{{Note_ID}}",
                "custom": null,
                "type": "PNG",
                "documentType": "voidCheck",
                "name": null,
                "description": "Description of File",
                "status": "created",
                "inactive": 0,
                "frozen": 0
            }
        ],
        "details": {
            "requestId": 1
        },
        "errors": []
    }
}

Qualifying Bank Account Supporting Documentation is:

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

Note

New Bank Account/Update Approval Period

For new bank accounts or existing bank accounts having account or routing numbers updated, 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

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.

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.

Link a Bank Account with Plaid

...

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
Warning: For existing bank accounts having account or routing numbers updated, manual review of the supporting document(s) is required for approval and can take up to 5 business days.

Warning

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.

...

Link a Bank Account with Plaid

With Plaid enabled Merchants or Referrers will be prompted to go through the bank account linking process as they sign up.

Warning
This process will require the Merchant to submit their confidential online banking login and should only be completed by one of the Merchant’s users directly and not by anyone else on the Merchant’s behalf.

...

Bank accounts can also be manually submitted using the API by sending a POST request to the /accounts endpoint. In the body of the request, you will include the Entity ID of the Merchant, as well as the data for the below fields.

Info
You can find the full description of this resource in our API Reference.

...

title	Click here to see API code examples for adding a new bank account.

Adding a new Bank Account - Example Code Snippet

URL

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

Header

Code Block
Content-Type:application/json APIKEY:{{private_api_key}}

Example Request Body

...

language	json

...

the data for the below fields.

Info
You can find the full description of this resource in our API Reference.

Give the bank account a custom name to differentiate it from other bank accounts on file.

Expand

title	Step 1 - Add new account information.

Manually Add a New Bank Account - Example Code Snippet

Visit our API Documentation for parameter descriptions and valid values.

Request URL & Header

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

Example Request Body

Code Block

language	json

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

{
    "account": {
        "id": "t1_pmt_xxxxxxxxxxxxxxxxx",
        "method": "10",
        "methodnumber": "101234567890123456",
        "numberrouting": "{{$randomBankAccount}}123456789",
        "routingbin": "{{Routing_Number_Sample}}"123456789",
        "payment": null,
  } }

Example Response

Code Block

language	json

{     "responselastChecked": {null,
        "datalast4": ["1111"
    },
    "id": "t1_act_xxxxxxxxxxxxxxxxx",
 {   "created": "2023-08-18 15:37:56.9284",
      "modified": "2024-08-18 15:37:56.9284",
    "accountcreator": {"t1_log_xxxxxxxxxxxxxxx",
    "modifier": "t1_log_xxxxxxxxxxxxxxxx",
    "entity": "t1_ent_xxxxxxxxxxxxxxxxx",
    "token": "ac1234cc5ae67b89101a11213d1a4e15",
    "idname": "t1_pmt_64dfc894cc34c311054a9e7",Bank Account Non-Primary",
    "description": "",
    "primary": "0",
    "status": 0,
    "methodcurrency": "8USD",
    "inactive": 0,
    "frozen": 0,
    "expiration": null,
    "numbertype": "all",
               "reserved": 0,
    "routingcheckStage": "021000021",
                    "bin": "122000661",
                    "payment": null,
                    "lastChecked": null,
                    "last4": "8025"
                },
                "id": "t1_act_64dfc894d9fe3b3be25990b",
                "created": "2023-08-18 15:37:56.9284",
                "modified": "2023-08-18 15:37:56.9284",
                "creator": "t1_log_5f875c53ed397f57c0afc90",
                "modifier": "t1_log_5f875c53ed397f57c0afc90",
                "entity": "t1_ent_644b872c814508ba0ad1147",
                "token": "ac1234cc5ae67b89101a11213d1a4e15",
                "name": "Bank Account Non-Primary",
                "description": "",
                "primary": "0",
                "status": 0,
                "currency": "USD",
                "inactive": 0,
                "frozen": 0,
                "expiration": null,
                "type": "all",
                "reserved": 0,
                "checkStage": null
            }
        ],
        "details": {
            "requestId": 1
        },
        "errors": []
    }
}

Expand

title	Click here for Request body fields and descriptions.

“Add Bank Account” API Request Body - Fields & Descriptions

Field

Required

Description

method

Required

Indicate the bank account type.

Valid Values:

Checking
Savings
Corporate Checking
Corporate Savings

Info
Please note, it is important to indicate if the bank account is a corporate or personal account.

routing

Required

Enter the 9-digit routing number associated with this bank account.

number

Required

Enter the account number associated with this bank account.

primary

Required

Is this the Merchant’s primary bank account?

Valid Values:

0 - Not Primary
1 - Primary

type

Required

Is this bank account for deposits, debits, or both (all).

Valid Values:

all - Both Deposits & Debits
credit - Deposits-only
debit - Debits-only

name

Optional

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

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.

Example Response

Code Block

language	json

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

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 Host: 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": "pending",
  "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",
  "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
}

Versions Compared

Old Version 15

New Version 16

Key

Submit Bank Account Supporting Documents using the API

New Bank Account/Update Approval Period

Payments Interrupted During Approval Period

Minor Updates to Existing Bank Accounts

Link a Bank Account with Plaid

Link a Bank Account with Plaid

Adding a new Bank Account - Example Code Snippet

Manually Add a New Bank Account - Example Code Snippet

“Add Bank Account” API Request Body - Fields & Descriptions

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

Page Comparison

Versions Compared

Old Version 15

New Version 16

Key

Submit Bank Account Supporting Documents using the API

New Bank Account/Update Approval Period

Payments Interrupted During Approval Period

Minor Updates to Existing Bank Accounts

Link a Bank Account with Plaid

Link a Bank Account with Plaid

Adding a new Bank Account - Example Code Snippet

Manually Add a New Bank Account - Example Code Snippet

“Add Bank Account” API Request Body - Fields & Descriptions

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