¶ IngoPay API
¶ Overview
Straight-thru processing to any endpoint in the Ingo Payments Gateway for PCI-certified platforms.
¶ API Authentication
The IngoPay API utilizes HMAC Authentication. HMAC Authentication is a mechanism for calculating a message authentication code using a hash function in combination with a shared secret key between the two parties involved in sending and receiving the data (Front-end client and Back-end HTTP service). The main use for HMAC is to verify the integrity, authenticity, and identity of the message sender.
¶ The following is required to authenticate to any of the Ingo Instant Payments API methods.
Valid participant ID provided by Ingo Payments
Valid Secret provided by Ingo Payments
An HMAC signature must be generated and sent in the Authorization header; the data in the Authorization header will contain the username, signing algorithm, headers, and the signature
- A comprehensive packet of information on creating your HMAC authentication will be provided with the credentials listed above.
¶ Request Management Policy
Ingo Payments is steadfast in ensuring the reliability and security of our platform for the benefit of our partners and their customers. As part of our network management, we implement rate limits to mitigate any detected risks to our service's stability.
We advise our clients to limit their actions to, at most five simultaneous requests per second to prevent system overload. This recommendation is in place to help maintain seamless service performance and to avoid activating our rate-limiting measures.
However, we understand that certain business operations may require a higher throughput rate. If your integration necessitates a greater volume of requests, or if you encounter any constraints due to our rate limiting, we encourage you to reach out directly to Ingo Payments's Partner Technical Support. Our team is ready to assist in evaluating your needs and exploring options to support your higher request volumes while continuing to protect the platform's integrity for all users.
¶ Abstracts
| Abstract | Summary |
|---|---|
| Search the Ingo Payments Biller/Payee database for support of a given customer account to be funded. | |
| Verify support for customer account data provided on a selected payment request. | |
| The risk platform supports two methods, Session & Score. The Session Method provides clients with session identifiers which enable risk assessment. | |
| Submit a request to push funds to a customer's account. | |
| Submit a request to pull funds from a customer's account. | |
| Receive status codes & descriptions by applicable API Method(s) to aid in definng & supporting your customer's experience. | |
| Receive timely detailed information regarding IngoPay API payment update activities. Only subscribe to events of interest for your program. |
¶ Permitted Character Set
