Simulate an incoming collection to one of your existing Fincra virtual accounts.
Sandbox only: This operation is available through
https://sandboxapi.fincra.com. It does not create a real transfer or move real funds.
The payee must identify an existing virtual account belonging to your authenticated business in the same currency as the simulation. Use accountNumber for bank-account rails or interacEmail for CAD Interac collections. Replace the placeholder payee details in the examples before using Try It.
The simulator always processes the collection as a virtual-account payment. You do not need to send a payment-method field.
Simulation outcomes
| Outcome | Request value | Response status | Webhook event |
|---|---|---|---|
| Successful | Any amount other than 999, unless the RFI rule below applies | successful | collection.successful |
| Failed | amount: 999 | failed | collection.failed |
| Request for information (RFI) | amount of 10000 or more for an additional virtual account in CAD, GBP, EUR, USD, ZAR or ZMW | pending | collection.additional-info-requested |
A
200response with top-levelsuccess: truemeans the simulation request was processed. Always inspectdata.statusfor the simulated transaction outcome.
If you supply reference, Fincra returns it as data.metadata.customerId. The value in data.reference is the collection reference generated by Fincra.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint is used for simulation purposes only. The response you receive is the same response you will get from the collection.successful webhook event.
Fields you need to pay attention to are:
| Field | Description |
|---|---|
| senderAccountName | The name of the sender as seen on their account |
| senderAccountNumber | The sender's bank account number |
| senderBankName | The name of the sender's bank |
| sourceAmount | The source amount of the transaction |
| destinationAmount | The destination amount that will be settled to you |
| metadata.customerId | The unique identifier for your customer. This will be provided in the description / narration when the customer is making payment. You can use this field to determine which customer a payment is for and post the transaction on your end |
| reference | Unique transaction reference generated by Fincra |
| status | The status of the transaction. Will always be successful for pool account collections |
| description | The descriptive text of the transaction |
| initiateAt | DateTime when transaction was done |
| createdAt | DateTime when transaction record was created and settled to XTransfer |