Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 instructions below for the multi-step update process:

...

This guide will walk you through the update and validation process required to update the information for

...

your existing bank account

...

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}

...

.

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 are required to 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 on file to receive deposits from Available Balance funds.

  • Account for Debits - A required bank account on file to be debited to cover Negative Balances 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.

...

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 as the result of due to a typo or invalid information.

...

Note

Warning: 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

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.

...

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

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

  2. 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
titleStep 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 /accounts/{id} HTTP/1.1
Accept: application/json
Host: api-test.payrix.com
APIKEY:{{private_api_key}}

Example Request Body

Code Block
languagejson
{
    "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
languagejson
{
    "account": {
        "id": "t1_pmt_xxxxxxxxxxxxxxxxx",
        "method": "8",
        "number": "1234567890123456",
        "routing": "123456789",
        "bin": "123456789",
        "payment": null,
        "lastChecked": null,
        "last4": "1111"
    },
    "id": "t1_act_xxxxxxxxxxxxxxxxx",
    "created": "2023-08-18 15:37:56.9284",
    "modified": "2024-08-18 15:37:56.9284",
    "creator": "t1_log_xxxxxxxxxxxxxxx",
    "modifier": "t1_log_xxxxxxxxxxxxxxxx",
    "entity": "t1_ent_xxxxxxxxxxxxxxxxx",
    "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
}

...

Expand
titleStep 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
languagejson
{
  "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.

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

...