{"info":{"_postman_id":"b7accec9-1c93-45d1-a4ca-88892c720762","name":"Apollo Finvest: Repayment Webhooks","description":"

Repayment Webhooks

\n

Webhooks are server callbacks to your server from Apollo's System. Webhooks are event-based and are sent when specific events related to the Repayments happen.

\n
The list below shows the Webhook events available for repayments.
\n
    \n
  1. repayment_status : accepted
    2. \n
\n

When a repayment status is accepted, this means all validations including Amount and Payment details are correct. The repayments provided will be then recorded into Apollo’s system.

\n

2. repayment_status : rejected

\n

If repayment status is rejected through Webhook - This means Partner Requested payment id or amount doesn’t match with the Payment gateway data.
Partners have to retry with the correct payment id/amount.

\n

3. repayment_status : refunded

\n

When a repayment status is refunded, this means a particular payment either part or full has been refunded due to a certain issue.

\n

Overview

\n
\n

The Callback URLs will help Fintech to get to know the current status of the repayments that are created in Apollo's System. Once a repayment request is hit by partner it's important to communicate the status to function smoothly and be in sync with Apollo's servers. Fintechs have to integrate a Callback URL or Webhook to fetch the status to avoid hitting the APIs frequently.

\n

*Kindly Request Apollo over mail to add/update the repayment callback URL to get the repayment statuses.

\n

Sample Response when Repayment is Accepted

\n
\n

If a Repayment was successfully created in Apollo's system, the following response will be provided:

\n
{\n    \"partner_tag\": \"test\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"test123\",\n    \"customer_payback_date\": \"01/06/2023\",\n    \"amount_received_exclusive_of_charges\": 500,\n    \"penal_interest\": 0,\n    \"other_charges\": 0,\n    \"gst_on_other_charges\": 0,\n    \"order_id\": \"184045\",\n    \"payment_id\": \"19744\",\n    \"created_at\": 1993848923,\n    \"is_prepayment\": true,\n    \"repayment_status\": \"accepted\",\n    \"error_message\": \"\",    \n    \"afil_repayment_id\": \"rpy_qwerty123\",\n    \"refund_amount\": 0,\n    \"refund_id\":null\n}\n\n
\n

Sample Response when Repayment is Rejected

\n
\n

If a Repayment was rejected due to certain validation error, the following response will be provided:

\n
{\n   \"partner_tag\": \"test\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"test123\",\n    \"customer_payback_date\": \"01/06/2023\",\n    \"amount_received_exclusive_of_charges\": 500,\n    \"penal_interest\": 0,\n    \"other_charges\": 0,\n    \"gst_on_other_charges\": 0,\n    \"order_id\": \"184045\",\n    \"payment_id\": \"19744\",\n    \"created_at\": 1993848923,\n    \"is_prepayment\": true,\n    \"repayment_status\": \"rejected\",\n    \"error_message\": \"unique identifier mismatch, please check order_id and payment_id again\", \n    \"afil_repayment_id\": \"rpy_jahjhahh\",\n    \"refund_amount\": 0,\n    \"refund_id\": null,\n}\n\n
\n

Sample Response when Repayment is Refunded

\n
\n

If a Repayment was refunded due to certain issue and has been captured by Apollo, the following response will be provided:

\n
{\n   \"partner_tag\": \"test\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"test123\",\n    \"customer_payback_date\": \"01/06/2023\",\n    \"amount_received_exclusive_of_charges\": 500,\n    \"penal_interest\": 0,\n    \"other_charges\": 0,\n    \"gst_on_other_charges\": 0,\n    \"order_id\": \"184045\",\n    \"payment_id\": \"19744\",\n    \"created_at\": 1993848923,\n    \"is_prepayment\": true,\n    \"repayment_status\": \"refunded\",\n    \"error_message\": \"\",  \n    \"afil_repayment_id\": \"rpy_jahjhahh\",\n    \"refund_amount\": 300,\n    \"refund_id\": \"jsdjsjdkwj\"\n}\n\n
\n
\n

Delivery Attempts and Retries

\n
\n
    \n
  1. Every event that receives a non-200 response will be considered an event delivery failure by Apollo's servers. If there is a delivery failure, we retry the delivery in exponential backoff policy for the next 15 mins after the event creation timestamp.
    2. \n
  2. If the partner API responds with 200, we assume that the delivery is successful and stop the notification of that particular event.
    3. \n
\n

Rate Limit

\n
\n

Throttling

\n

:10000 requests per second.

\n

Quota

\n

:Unlimited total number of API calls

\n

SLA breakdown

\n
\n\n

Apollo will provide standard technical support twenty-four (24) hours per day, five (5) days per week, excluding weekends and national Indian holidays. Standard Support will be offered via email.

\n\n

Uptime is the percentage of total possible minutes API was available during a fiscal year. Our commitment is to maintain at least 99.99% uptime

\n\n

Sometimes we need to perform maintenance to keep API working smoothly. If scheduled downtime is necessary, we’ll give you at least 48 hours advance notice. In a year, scheduled downtime won’t exceed 12 hours.

\n

Updates

\n

As our business evolves, we may change our service level agreement. Customers can review the most current version of the service level agreement at any time by visiting this page.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Repayment Webhooks","slug":"repayment-webhooks"},{"content":"Delivery Attempts and Retries","slug":"delivery-attempts-and-retries"},{"content":"Rate Limit","slug":"rate-limit"},{"content":"SLA breakdown","slug":"sla-breakdown"},{"content":"Updates","slug":"updates"}],"owner":"16291369","collectionId":"b7accec9-1c93-45d1-a4ca-88892c720762","publishedId":"2s93zB5M9s","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-30T06:30:06.000Z"},"item":[]}