Payment Gateway's integration, primary purpose is to handle requests created through manual and automatic processes in CRM.COM to ensure payments and refunds from and to customer's online accounts and CRM.COM are possible.
Requests are created either whenever a payment, refund or payment cancellation of supported methods and types defined in the provider, is manually created through Financial Transactions; additionally requests are created whenever the Payment Gateway Run is executed in the system which will create requests in 2 occasions:
- Whenever a bill (whose account's payment preference is associated with a generic gateway) is unsettled and must be paid
- Whenever a wallet reaches a threshold (set in CRM.COM) and must be topped up, so that there are enough funds in the wallet for paying for prepaid subscriptions
Payment gateway requests must then be further processed using WEB APIs in order to be sent to the specific Payment Gateway and updated accordingly. i.e. completed or rejected.
All requests are available through a dedicated Summary page. No further manual handling is allowed, and therefore requests do not have a Data Entry page
Payment Gateway Requests fields
The table describes the fields of Summary page, and explains how the fields are used
Number | An auto-generated number that uniquely identifies each payment gateway request. |
|---|---|
| Payment Gateway Provider | The payment gateway provider that will process the payment gateway request. |
| Type | The type of the request which can be any between: 'Payment', 'Refund' or 'Payment Cancellation' |
| Payment Gateway Run | The payment gateway processing run that created the request, if it was created automatically. |
| Payment | The payment number of the refund created in CRM.COM |
| Payment Cancellation | The payment cancellation number of the payment cancellation created by CRM.COM This information is applicable only if the payment gateway provider is a generic payment gateway provider |
| Payment Gateway Reference Number | The payment gateway request reference number as provided by the payment gateway. This information is set while rejecting or posting the payment gateway request, so if the request is in any other Life Cycle State, the information will not be available. |
| Account Number | The accounts receivable number associated with the payment gateway request. |
| Paid Bill | The bill that was paid or is intended to be paid. |
| Topped-up Wallet | The wallet that was topped-up. Wallet information is always set even if a payment is not created and available only if the payment was created in order to top up a Wallet.
|
| Execution Date | The date on which the request was posted or rejected by the payment gateway provider. |
| Life Cycle State | The life cycle state of the payment gateway request which can be:
'Pending' or 'Under Processing' payment gateway requests can be rejected or posted through WEB APIs |
| Error Code | The error code received by the payment gateway provider, in case of an error. |