Simulate Collection

Call this endpoint to simulate a transfer into your account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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:

FieldDescription
senderAccountNameThe name of the sender as seen on their account
senderAccountNumberThe sender's bank account number
senderBankNameThe name of the sender's bank
sourceAmountThe source amount of the transaction
destinationAmountThe destination amount that will be settled to you
metadata.customerIdThe 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
referenceUnique transaction reference generated by Fincra
statusThe status of the transaction. Will always be successful for pool account collections
descriptionThe descriptive text of the transaction
initiateAtDateTime when transaction was done
createdAtDateTime when transaction record was created and settled to XTransfer
Body Params
string
required

the currency you are simulating a payment in

int32

Amount to simulate payment inflow for

payer
object

The customer making payment

payee
object

The account information that your customer will use to make payment into

string

Use this to pass your unique identifier for your customer to simulate the webhook response with customerId

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json