Smart Collect 2.0Use Smart Collect 2.0to collect payments using UPI and other banking modes.
Smart Collect 2.0 APIs
Use Smart Collect 2.0 APIs to create and manage Customer Identifiers of the typeVPA (UPI). You can use the Smart Collect APIs to manage Customer Identifiers of the type Bank Account.
List of Smart Collect 2.0 APIs
Refer to the list of Smart Collect 2.0 APIs to create and manage Customer Identifiers of the typeVPA (UPI).
API | Description
Create a Customer Identifier With VPA Receiver | API to create a Customer Identifier with VPA receiver.
Create a Customer Identifier With VPA and Bank Account Receivers | API to create a Customer Identifier with VPA and bank account receivers.
Fetch Payments Using UPI | API to retrieve details of a UPI payment using the Payment id.
Add Receiver to an Existing Customer Identifier With VPA | API to add receiver to an existing Customer Identifier.
Add Receiver to an Existing Customer Identifier With Bank Account | API to add receiver to an existing Customer Identifier.List of Smart Collect 2.0 API for TPV
Refer to the list of Smart Collect 2.0 APIs to create and manage Customer Identifiers of the typeVPA (UPI)with TPV.
API | Description
Add VPA Receiver to an Existing Customer Identifier | API to add receiver to an existing Customer Identifier.
Add Bank Account Receiver to an Existing Customer Identifier | API to add receiver to an existing Customer Identifier.
Smart Collect APIs
List of Smart Collect APIs
API | Description
Create Customer Identifier With Bank Account Receiver | API to create a Customer Identifier with bank account receiver.
Fetch a Customer Identifier With ID | API to Fetch a Customer Identifier by ID.
Fetch all Customer Identifiers | API to fetch all Customer Identifiers.
Fetch Payments for a Customer Identifier| API to fetch payments made against a particular Customer Identifier.
Fetch Payment Details using ID and Transfer Method | API to retrieve details of a payment using the Payment ID and transfer method.
Fetch Payments Using Bank Transfer via UTR | API to retrieve details of a payment using bank transfer method via UTR.
Update a Customer Identifier | API to update a Customer Identifier.
Close a Customer Identifier | API to close a Customer Identifier.API-wise Integration Checklist for Smart Collect
- Use Create a Customer API if a Customer Identifier/UPI ID will be mapped to a unique customer.
-
You can use the fail_existing (set to
"1") API parameter to create a customer. This helps you avoidcustomer_idbeing created multiple times for the same customer and will help in your reconciliation process. -
We request you to create a single
customer_idrather than making multiple IDs for the same customer. If their details change, you can use the Edit Customer Details API. Duplicate validation is done based on the combination of email ID and phone number. - UPI Customer Identifiers are supported only in Live mode.
- The combination of merchant prefix and descriptor must be 20 characters. The length of the merchant prefix can vary between 4-10 characters and the length of the descriptor from 10-16 characters.
- Payments made to the Customer Identifiers must be within the transaction limits.
- We recommend that you use Fetch APIs to make a GET call for any downstream dependencies. Webhooks are just a recommended layer on top of this.
- We recommend you Close the Customer Identifier once the payment is received.
List of APIs for Smart Collect TPV
To know more about Third Party Validation (TPV), click here.API | Description
Create Customer Identifier | API to create a Customer Identifier.
Add an Allowed Payer Account | API to add allowed payers account details to a Customer Identifier.
Fetch a Customer Identifier by ID | API to Fetch a Customer Identifier by ID.
Fetch all Customer Identifiers | API to fetch all Customer Identifiers.
Fetch Payments for a Customer Identifier| API to fetch payments made against a particular Customer Identifier.
Fetch Payment Details using ID and Transfer Method | API to retrieve details of a payment using the Payment ID and transfer method.
Delete an Allowed Payer Account | API to delete allowed payers account details added to a Customer Identifier.
Close a Customer Identifier | API to close a Customer Identifier.API-wise Integration Checklist for Smart Collect TPV
- Use Create a Customer API if a Customer Identifier is mapped to a unique customer.
-
You can use the fail_existing (set to
"1") API parameter to create a customer. This helps you avoidcustomer_idbeing created multiple times for the same customer and will help in your reconciliation process. -
We request you to create a single
customer_idrather than making multiple IDs for the same customer. If their details change, you can use the Edit Customer Details API. Duplicate validation is done based on the combination of email ID and phone number. - Smart Collect with TPV is supported only for Netbanking.
- The combination of merchant prefix and descriptor must be 20 characters. The length of the merchant prefix can vary between 4-10 characters and the length of the descriptor from 10-16 characters.
-
Avoid ambiguous account numbers. Consider the following:
- When displaying a bank account number to a customer, the font may cause the customer to misread the alphanumeric characters (if any) in the number. Customers can commit typos while entering the beneficiary account number. Misreading the letter
Oin an account number as the numeral0, for example, is extremely common. - Payments made to such mistyped accounts are considered invalid. They are refunded to the customer’s account within 1 working day. However, this is still a massive inconvenience for the customer, who now has to wait 24 hours to receive a refund for what is often a rather large payment.
- We strongly advise against using the following characters in your descriptor for alphanumeric accounts, as they may appear ambiguous in specific fonts.
0orO1orI5orS8orB2orZ
- When displaying a bank account number to a customer, the font may cause the customer to misread the alphanumeric characters (if any) in the number. Customers can commit typos while entering the beneficiary account number. Misreading the letter
- You can add up to 10 allowed payers while creating the Customer Identifier.
- The allowed payer can be deleted or added later using the Add an Allowed Payer and the Delete an Allowed Payer APIs.