...
| Expand |
|---|
| title | Tips: Front-End User Interface API Integration for Change Requests |
|---|
|
We recommend Facilitators that use the Change Requests workflow above with an API integration to incorporate the following into your front-end user interface development: Tip: Display Change Request Messages When you submit or receive a Change Request using our API, consider incorporating a user-friendly notification system on your front-end interface. This system can display the important messages related to that user’s change, such as Change Request Creation, Approval, or Decline status update notifications. These messages help users understand the progress of their Change Request(s) and stay informed about potential required actions.
Tip: Real-Time Status Updates Implement real-time status updates within your UI to enhance transparency and user confidence. When Change Requests undergo status changes, whether pending, approved, or declined, promptly reflect these updates in your front-end interface. This allows your users to track the progress of their Change Request without manually checking or calling your API.
Tip: Communicate Decline Reasons When Change Requests are declined, ensure that the reason and reason type are communicated to your users. Design UI elements that can display the Reason Type and Reason in a user-friendly manner. This provides transparency and empowers the users to take corrective actions if needed.
| Tip |
|---|
We recommend you configure Web Alerts and Email Alerts to pass “Declined”, “Approved”, or “Pending Review” Change Request statuses to your front-end interface for whitelabeled end-user communication. |
|
Prevent Funding to an Existing Bank Account
To prevent funds from being sent to an existing account while the change request is being reviewed and approved, either as an optional feature for merchants to choose when submitted the bank change or as the default process for your software
Reasons that a Referrer or Facilitator may want to prevent funds from being disbursed to or withdrawn from a Merchant’s existing bank account include but are not limited to:
The Merchant’s bank account being closed by their bank due to reported fraudulent activity.
The Merchant’s bank account was closed by the merchant prior to the change request being approved.
The Merchant added incorrect bank account information by mistake that they do not want to use.
Request URL & Headers | | Code Block |
|---|
PUT /accounts/{id} HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api-test.payrix.com
APIKEY: {private_api_key} |
|
Path Parameter | {id} - The account ID for the bank account you want to deactivate.
|
| Expand |
|---|
| title | Request Body Example |
|---|
|
The following example changes the bank account's status parameter from 3 - [Fully] Verified to 1 - Ready [for verification] to remove the verification required to fund a bank account. In addition, you can optionally choose to change the inactive parameter to 1 - Inactive to also achieve a similar result. Note: All other previous bank account information will remain the same in the request body. If you are unsure about the information of an existing account, you can make an API call to GET /accounts/{id} endpoint using the same path parameter to return the needed information in the response. | Code Block |
|---|
{
"id": "p1_act_5a1ef5e55656698eefaf8b6,",
"name": "TD Bank"
"primary": "0",
"type": "all",
"reserved": "0",
"inactive": "1",
"frozen": "0",
"status": "1",
} |
|
...
Change Request Management Flow
...
| Lucidchart |
|---|
| pageCount | 1 |
|---|
| autoUpdate | true |
|---|
| align | center |
|---|
| type | rich |
|---|
| align | center |
|---|
| autoSize | 1 |
|---|
| macroId | 3dc6b808-6c75-4706-bc2d-2515fa4ca4f9 |
|---|
| pages | instanceId | 688e8386-c18b-322a-9462-f6b823009213 |
|---|
| pages | |
|---|
| width | 700 |
|---|
| documentId | 513a5c38-aa06-430d-bdba-125c043b6547 |
|---|
| documentToken | v2_6229db14502e61f8c2b608c90548ae2c8139cb954e1b2ffa29ff9efaaf008464-a=129560282&c=688e8386-c18b-322a-9462-f6b823009213&d=513a5c38-aa06-430d-bdba-125c043b6547&p=23427711020 |
|---|
| documentId | 513a5c38-aa06-430d-bdba-125c043b6547 |
|---|
| updated | 1701460135846 |
|---|
| height | 500 |
|---|
|
...