Page Comparison

...

The processes outlined below will outline how to submit a Change Request to update your or your Merchant’s bank account information.

Using the Portal

Submitting a change request using the Portal can be completed in a few simple steps along with easy upload of the supporting documents in a single process:

Click here to see steps to Submit

Expand

title	Click here to see steps to Submit a Change Request in the Portal

While Merchants can submit their Change Requests, Referrers have the unique ability to log in as the Merchant and submit Change Requests on behalf of a Merchant.

Submit a Change Request for bank account information by following the steps below:

Step 1: Navigate to the Banking tab and click the ADD NEW ACCOUNT button using one of the Portal pages below:

Your primary Referrer or Merchant Portal Account Profile page (located on the Dashboard), or;
Your desired Merchant’s profile page.

Step 2: If Plaid is unavailable for any reason, click ADD ACCOUNT MANUALLY. This will display the message below. Then, click Continue.

Info

“Adding a new bank account will take up to 5 business days 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 3: Upload any supporting document(s) and click Save.

The bank account change request process requires a valid document upload to add a new account or change account and routing numbers for existing accounts.

Valid supporting documents include:

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

Step 4: Once the change is made the Merchant or Referrer is provided the below message. Click Done to finish submitting the Change Request.

Info

“Your changes have been made.

Your changes are currently being validated for review.”

Expand

title

Using the API

Submitting a Change Request

...

using the

...

API

...

Step 1: Create a new account or update an existing account.

URL & Method

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

Tip
Alternatively, you can use endpoint with a `PUT` request method to update an existing account's information using the same parameters below.

Headers

...

is a multi-part process. Follow each expandable step below for each applicable step to submit a change request for a bank account with supporting documentation:

A user-provided description for this bank account.

0- No reserve.1- Account withheld.3- Account usage pending manual review.4- Move all funds from this Account into a reserve.

Example Request Body

Expand

title	Step 1: Create a new account or update an existing account.

Visit our API Documentation for parameter descriptions and valid values.

Request URL & Headers

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

Request Parameters

Parameters

Type

Required

Description

Valid Values

entity

string

Required

The alphanumeric Entity ID associated with this Account.

name

string

A user-provided name for this bank account.

This field is stored as a text string and must be between 0 and 100 characters long.

description

string

This field is stored as a text string and must be between 0 and 100 characters long.

primary

integer

Required

Indicates whether the Account is the 'primary' Account for the associated Entity.

Only one Account associated with each Entity can be the 'primary' Account.

type

string

Required

The type of financial account, debit, credit or both.

all - Debit/Checking + Credit

credit - Credit-Only

debit - Debit/Checking-Only

status

integer

Required

The status of the Account being ready to be added.

0 - Not Ready. Account holder is not ready to verify the account.

1 - Ready. Account is ready to be verified.

2 - Challeneged. The account has processed the challenge.

3 - Verified. The account has been verified.

4 - Manual. Issue during verification, required manual verification.

reserved

integer

Required

Indicates whether the Account will have a reserved placed on its funds.

checkStage

integer

The last stage completed for risk assessment.

createAccount - The final stage for review, add the account.

currency

integer

Required

The currency type for the account.

Any 3-digit currency symbol.

Default Value: USD

expiration

string

The expiration date of the related credit or debit account.

Format: MMYY

Example: February, 2025 = 0225

inactive

integer

Required

Whether this bank account is marked as ‘inactive’.

0 - Active

1 - Inactive

frozen

integer

Required

Whether this bank account is marked as ‘frozen’.

0 - Not Frozen

1 - Frozen

Code Block

language	json

{
  "primary": 1,
  "type": "all",
  "status": 1,
  "reserved": 1,
  "currency": "USD",
  "inactive": "0",
  "frozen": "0",
  "entity": "string",
  "name": "string",
  "description": "string",
  "checkStage": "createAccount",
  "expiration": "0529"
}

Note: The parameter descriptions above apply to the data object parameters in the response as well.

Example Response

{ "response": { "data": [

Code Block

language	json

Tip

Alternatively, you can use endpoint with a PUT request method using the Account ID as a path parameter to update an existing account's information using the same parameters below.

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

Example Request Body

Code Block

language	json

{
  "primary": 1,
  "type": "all",
  "status": 1,
  "reserved": 1,
  "currency": "USD",
  "inactive": "0",
  "frozen": "0",
  "entity": "string",
  "name": "string",
  "description": "string",
  "checkStage": "createAccount",
  "expiration": "0529"
}

Note: The parameter descriptions above apply to the data object parameters in the response as well.

Example Response

Code Block

language	json

{
    "response": {
        "data": [
          {
            "account": {
              "method": 8,
              "number": 2345,
              "routing": 3924,
              "payment": null
            },
            "id": "p1_act_5a1ef5e55656698eefaf8b6",
 {             "accountcreated": {
 "2017-11-28T01:02:57.000Z",
            "methodmodified": 8,
"2017-11-28T01:02:57.000Z",
             "numbercreator": 2345"p1_log_5a1ef5e55653ed720159d53",
              "routingmodifier": 3924"p1_log_5a1ef5e55653ed720159d53",
             "entity": "payment": nullp1_ent_5a1ef5e5565631155c95344",
             }"token": "ae1abb3aaa18e4c374ca83fa75a7fff6",
            "idname": "p1_act_5a1ef5e55656698eefaf8b6",
            "createddescription": "2017-11-28T01:02:57.000Z",
 ",
            "modifiedprimary": "2017-11-28T01:02:57.000Z"1,
            "creatorstatus": "p1_log_5a1ef5e55653ed720159d53"0,
            "modifiercurrency": "p1_log_5a1ef5e55653ed720159d53USD",
            "entityinactive": "p1_ent_5a1ef5e5565631155c95344"0,
            "tokenfrozen": "ae1abb3aaa18e4c374ca83fa75a7fff6",0
          }
 "name": "",             "description": "",
            "primary": 1,
            "status": 0,
            "currency": "USD",
            "inactive": 0,
            "frozen": 0
          }
        ],
        "details": {
            "requestId": 1
        },
        "errors": [],
        "messages": [
            "Change request p1_chr_6513a1e2144ac0c8219c231 was created. This request may need to be reviewed and approved before taking effect."
        ]
    }
}

Step 2: Upload Supporting Documentation

URL & Method

Code Block
POST https://apiv2.stage.payrix.com/entities/{entityType}/{entityId}/documents

Path Parameters

Parameter

Description

Valid Values

{entityType}

The type of entity adding a new bank account or editing an existing one.

merchant
referrer
facilitator

{entityId}

The entity ID of the business submitting the Change Request.

IDs beginning with t1_ent’s License, etc)

Response Parameters

Parameter

Type

Description

Valid Values

uuid

string

Unique identifier of the document

name

string

The name of the document

description

string

A custom description of the document

type

string

The document type (Driver’s License, Bank Document, etc.)

ownership

string

The owner of the document.

merchant
referrer
facilitator

status

integer

Whether or not the uploaded document was reviewed by a risk analyst.

Reviewed
Not reviewed

createdAt

number

Timestamp of when the Document is created.

expiresAt

number

Timestamp for the Upload URL expiration.

],
        "details": {
            "requestId": 1
        },
        "errors": [],
        "messages": [
            "Change request p1_chr_6513a1e2144ac0c8219c231 was created. This request may need to be reviewed and approved before taking effect."
        ]
    }
}

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
}

After submitting your Change Request, risk analysts from the Payrix platform (or your associated platform Facilitator) will conduct a review of the submitted account information and supporting documentation.

...

Versions Compared

Old Version 9

New Version 10

Key

Using the Portal

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