Test Case Simulation
The ReadyRemit API employs a proxy that operates on top of the REST API. This proxy can be utilized to obtain pre-determined responses for a variety of real world use cases. These use cases can be expected to occur during live production use that are otherwise difficult to simulate organically.
Using the Test Case Simulator
All endpoint calls to the POST /Create Sender and POST /Create Transfer endpoints pass through the test case simulator in our Sandbox environment. Each test case has a triggered condition that when used will cause the simulator to return a simulated response. If a call to an endpoint is made with no trigger invoked, the request will pass through to the API.
When running a test case through the simulator, when a trigger is used, compare the response received to the outcome code. The Sub-Test Case column shows the expected test case/error to be returned in the response.
Example
Here is an example of simulating the POST /Create Sender test case for Address Component Missing. Address_Line_1 is a required field for creating a sender. If we send a request with Address_Line_1 we will expect to see a missing required field error for the Address with a 400 - Bad Request response code
Simulated Use Cases
The table below contain a list of all the available simulated test cases supported. Not every possible error is listed below. For example, missing any required field in a call to the endpoints will result in a missing required field error for the given field.
| Service | Test Case | Sub-Test Case | Outcome | Trigger |
|---|---|---|---|---|
| POST/Create Transfer | Success | Bank Account | 201 - Created | N/A - A valid bank account transfer will bypass the proxy |
| POST/Create Transfer | Success | Push to Card | 201 - Created | N/A - A valid push to card transfer will bypass the proxy |
| POST/Create Transfer | Unauthorized | N/A | 401 - Unauthorized | Sender First Name: John, Sender Last Name: Doe |
| POST/Create Transfer | Validation Errors | Missing Required Field - Recipient ID for Bank Account | 400 - Bad Request | N/A - triggered when no recipientId is included is included in request |
| POST/Create Transfer | Validation Errors | Missing Required Field - Invalid Amount | 400 - Bad Request | N/A - triggered when no amount is included in request |
| POST/Create Transfer | Validation Errors | Missing Required Field - Quote History ID | 400 - Bad Request | N/A - triggered when no quoteHistoryId is included in request |
| POST/Create Transfer | Validation Errors | Min/Max Limit Validation on Corridor | 400 - Bad Request | Amount: 1000000000 |
| POST/Create Transfer | Validation Errors | Insufficient Funds in FBO Account | 400 - Bad Request | Sender First Name: Rose, Sender Last Name: Doe |
| POST/Create Transfer | Validation Errors | Invalid NONCE | 400 - Bad Request | NONCE Value: 11111111-1111-1111-1111-111111111111 |
| POST/Create Transfer | Validation Errors | Quote Change (within same session) | 400 - Bad Request | Sender First Name: James, Sender Last Name: Doe |
| POST/Create Transfer | Validation Errors | Sender ID Expired on Transfer (existing sender) | 400 - Bad Request | Sender First Name: Jeffrey, Sender Last Name: Doe |
| POST/Create Transfer | Validation Errors | Invalid Card during Push to Card | 400 - Bad Request | Sender First Name: Jay, Sender Last Name: Doe |
| POST/Create Transfer | Timeout | Timeout | 504 - Gateway Timeout | Sender First Name: Jennifer, Sender Last Name: Doe |
| POST/Create Transfer | Timeout | Timeout | No Response | Sender First Name: Jamie, Sender Last Name: Doe |
| POST/Create Sender | Success | Create Person Sender | 201 - Created | N/A - A valid sender will bypass the proxy |
| POST/Create Sender | Unauthorized | N/A | 401 - Unauthorized | Sender First Name: John, Sender Last Name: Doe |
| POST/Create Sender | Validation Errors | Missing Required Field - Address Component Missing | 400 - Bad Request | Do not include ADDRESS_LINE_1 |
| POST/Create Sender | Validation Errors | Missing Required Field - Phone Number | 400 - Bad Request | Do not include PHONE_NUMBER |
| POST/Create Sender | Validation Errors | Regex Validation - SSN has letters | 400 - Bad Request | ID Number: TSTIDNMBR, ID Type: SSN |
| POST/Create Sender | Validation Errors | Regex Validation - Name has unsupported special character | 400 - Bad Request | Sender First Name: Joh:n |
| POST/Create Sender | Validation Errors | CHAR Count Validation - Sender First Name with 1 CHAR | 400 - Bad Request | Sender First Name: X |
| POST/Create Sender | Validation Errors | DoB Validation - Sender younger than 18 | 400 - Bad Request | Date of Birth: 2025-01-01 |
| POST/Create Sender | Timeout | Timeout | 504 - Gateway Timeout | Sender First Name: Mark, Sender Last Name: Henry |
| POST/Create Sender | Timeout | Timeout | No Response | Sender First Name: Felix, Sender Last Name: Oblac |
| GET/Nonce | Success | N/A | 200 - OK | N/A |
| GET/Nonce | Validation Errors | N/A | 504 - Gateway Timeout | N/A |
| GET/Nonce | N/A | No Response | N/A | N/A |
Updated about 1 month ago