Page Comparison

...

Expand

title	Click here to see steps to Submit a Change Request with the Payrix API

Step 1: Create the Change Request

URL & Method

Code Block
POST https://apiv2.stage.payrix.com/changeRequests

Headers

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

Example Request Body

Code Block

language	json

{ 
  "changes": { 
    "account": {
        "payment": { 
          "number": "{{new valuenewAccountNumber}}", 
          "routing": "{{new valuenewRoutingNumber}}"
        } 
      },
  }, 
  "verifications": { 
    "entity": { 
      "id": "{{assoicated entity's ID}}", 
    }, 
    "accounts": [ 
      { 
        "id": "1234",  
        "payment": { 
          "method": "method", 
          "number": "{existing account number}}", 
          "routing": "{{existing routing number}}", 
        } 
      } 
    ] 
  } 
}

Example Response

Code Block

{
    "response": {
        "data": [],
        "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 for the business submitting the Change Request.	ID’s beginning with `t1_ent` or `t1_mer`.

Headers

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

Body Parameters

Parameter	Type	Required	Description	Valid Values
`name`	string	Required	Custom name for your document upload.
`description`	string		Custom string description for your document upload.
`type`	string	Required		`Drivers License` `Bank Document` `Citizenship Document`
`documentType`	string	Required		`image/jpeg` `image/gif` `image/png` `application/pdf` `image/tiff`

Example Request Body

Code Block

language	json

{
  "documentType": "image/jpeg",
  "name": "Void Check",
  "Description": "Void Check for bank account change - 9/30/23",
  "type": "Bank Document"
}

Response Parameters

Parameter	Type	Required	Description
uuid	string	Required	Unique identifier of the document
name	string	Required	The name of the document
description	string		A random description of the document
type	string	Required	The document type (Driver License, etc)
ownership	string	Required	The owner of the document (facilitator, referrer or merchant)
status	Enum	Required	Reviewed / Not reviewed
CreatedAt	number	Required	Timestamp of when the Document is created
ExpiresAt	number		Timestamp for the S3 Upload URL and the database item TTL

Example Response Body

Code Block

language	json

{
 "uuid": "{{UUID}}",
 "name": "Void Check",
 "description": "Void Check for bank account change - 9/30/23",
 "type": "Bank Document",
 "status": "Not Reviewed",
 "ownership": "referrer",
 "createdAt": "createdAt",
 "downloadUrl": "<<Presigned Download URL>>"
}

...

Versions Compared

Old Version 1

New Version 2

Key