A settlement, also known as a payout, is a feature added to allow users to see money being deposited from credit card payments. In the future other payment methods, such as PayPal and offline third party payments will be supported.
Note: Some gateways do not offer the ability for RevCent to either retrieve or be notified when a settlement occurs. If your gateway does not offer either ability, please contact the gateway directly. A gateway can easily create a settlement in RevCent using the API.
Please review the supported gateways for automatic settlement retrieval, as well as gateways requiring a webhook via custom function.
A settlement can be created when either of the following occurs:
The following gateways have settlements retrieved automatically by RevCent with zero intervention on your part. If your gateway is not listed here and not listed in the webhook gateways section below, contact us to see if we can automate it or create a custom function template for it.
The following gateways require either a direct API call from the gateway, or have a pre made function template ready. You will need to follow the instructions on creating the custom function specific to the gateway, as well as set up the webhook notification at the gateway itself. If your gateway is not listed here and not listed in the automated gateways section above, contact us to see if we can automate it or create a custom function template for it.
Important: If a gateway is listed as a webhook gateway, it cannot be automated. RevCent has already tried to automate the settlement retrieval and the gateway does not support retrieving settlements programatically. I.e. a custom function webhook is required.
| Gateway | Function Template | Notes |
|---|---|---|
| NMI | NMI Settlement Create | NMI does not support automated settlement retrieval. You will need to create a settlement webhook notification in your NMI portal. Make sure your merchant account ID is provided when editing the gateway in RevCent. RevCent will match the NMI settlements' mid with the appropriate gateway in RevCent via the merchant account ID. More info on NMI webhooks |
Note: If you not already requested Functions be enabled for your RevCent account, please contact us before following the instructions below.
A settlement can be created in RevCent via the API. This is useful if you are a gateway and wish to assist your clients that use RevCent. Read more at our API Docs. View the API section on Settlement Create.
Example API request
{
"request": {
"type": "settlement",
"method": "create",
"merchant_account_id": "12345",
"amount": 100.34,
"gateway_settlement_id": "stl_343339",
"gateway_settlement_date": "2023-07-19T14:41:54"
}
}
Important: