Versions Compared

Key

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

...

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
GET /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": "20232024-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 2 - Create a new note associated with the entity (Merchant).

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
languagejson
{
  "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
languagejson
{
  "id": "t1_not_xxxxxxxxxxxxxxxxxx",
  "created": "2023-10-25T19:10:44.278Z",
  "modified": "20232024-10-25T19:10:44.278Z",
  "creator": "stringt1_log_xxxxxxxxxxxxxxxx",
  "modifier": "stringt1_log_xxxxxxxxxxxxxxxx",
  "login": "stringt1_log_xxxxxxxxxxxxxxxx",
  "holdentity": "stringt1_ent_xxxxxxxxxxxxxxxxx",
  "txntype": "stringnote",
  "terminalTxndata": "string",ABC Company Bank "entity": "string",
  "type": "noteAccount Change Request",
  "note": "string",Supporting documents for "data": "stringaccount change.",
  "inactive": "0",
  "frozen": "0"
}

Expand
titleStep 3 - Submit supporting bank account documentation.

Submit Bank Account Supporting Documents using the API

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

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

Manually Update in the Portal

...