Payout
When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.
| Countries and regions | India |
| Payment currencies | INR |
| Payment amount limits | Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard. |
| Payment processing time | Contact your key account manager at Monetix for details. |
| Currency conversion | On the Monetix side |
| Refund |  |
| Onboarding and access fee | Contact your key account manager at Monetix for details. |
Operations support
| Interfaces | |||
|---|---|---|---|
| Payment Page | Gate | Dashboard | |
| Payout | |  | |
You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.
The following sections provide more information about the payment processing flow and the analysis of completed payments.
Payout by using Gate
General information
To perform a payout by using Gate with the UPI payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Accept the callback with the payout result from the payment platform.
The following picture provides the details of the payout processing flow in the UPI payment method.
- The customer initiates a payout in your system.
- Your system sends the payout request to the Monetix payment platform.
- The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service informs the payment platform about the payout result.
- The payment platform sends a callback with the payout result to your system.
- Your system sends the payout result to the customer.
Request
This section provides the instructions on how to build the request for payout with the UPI payment method.
| HTTP request method | POST |
| Request body format | JSON |
| API endpoint | /v2/payment/bank-transfer/upi/payout |
| Full API endpoint specification | /v2/payment/bank-transfer/{payment_method}/payout |
|
|||
|---|---|---|---|
| Object | Parameter | Description | |
general | project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | ||
signature | Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer | id | Unique ID of the customer within your project. Example: | |
ip_address | IP address of the customer's device. Example: | ||
first_name | Customer's first name. Example: | ||
last_name | Customer's last name. If the customer doesn't have a last name, set this parameter to the customer's first name. Example: | ||
email | Customer's email. Example: | ||
phone | Customer's phone number, 10 digits without a plus sign (+), country code, spaces, and punctuation. Example: | ||
address | Customer's address (street, building number, apartment number, etc.). The address must contain only letters, numbers and whitespace characters. Example: | ||
account | number | Customer's virtual payment address (VPA). Example: | |
payment | currency | Code of the payment currency in the ISO-4217 alpha-3 format. Example: | |
amount | Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units. If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes. Example: 1500.00 INR must be sent as | ||
| You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference. | |||
Here is an example of the data from a request to initiate a payout with the UPI payment method:
{
"general": {
"project_id": 1234,
"payment_id": "payment_47",
"signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
},
"customer": {
"id": "customer_123",
"ip_address": "198.51.100.47",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com",
"phone": "2212345678",
"address": "Delhi Main st 20"
},
"account": {
"number": "johndoe@upi"
},
"payment": {
"currency": "INR",
"amount": 150000
}
}
Callback
In the UPI payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.
The following is an example of a callback body with the information about a successfully completed payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "UPI",
"sum": {
"amount": 150000,
"currency": "INR"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "payout",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"created_date": "2024-12-07T19:08:05+0000",
"request_id": "1a23456bc7890de",
"sum_initial": {
"amount": 150000,
"currency": "INR"
},
"sum_converted": {
"amount": 150000,
"currency": "INR"
},
"code": "0",
"message": "Success",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"account": {
"number": "johndoe@upi"
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
The following is an example of a callback for a declined payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "UPI",
"sum": {
"amount": 150000,
"currency": "INR"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "payout",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"created_date": "2024-12-07T19:08:05+0000",
"request_id": "1a23456bc7890de",
"sum_initial": {
"amount": 150000,
"currency": "INR"
},
"sum_converted": {
"amount": 150000,
"currency": "INR"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"account": {
"number": "johndoe@upi"
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Payout by using Dashboard
- single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
- as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.
Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.
For more information about payout processing by using Dashboard, see Performing payouts.