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

...

Upload supporting documentation for the change:

...

Create the new Note Resource - POST /notes

...

Create a Document Resource to associate with the upload - POST /noteDocuments

...

your existing bank account.

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

...

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
}

...