[PayOut] [FTD] INR Payment Data
For shops with INR currency and FTD routing, when creating a payout (POST /api/v1/payouts) the recipient account number must be sent in the root card_number field. Use the paymentData contract that matches the shop template integration scheme.
H2H integration contract
Optional fields in paymentData
| Parameter | Type | Required | Description |
|---|---|---|---|
| mobile_number | string | No | Customer mobile number. |
| ifsc_code | string | No | Recipient IFSC code. |
| holder | string | No | Recipient account holder name. |
Example request body
{
"external_id": "PAY-INR-FTD-H2H-001",
"amount": 5000.00,
"currency": "INR",
"card_number": "4111111111111111",
"shop_code": "your_inr_ftd_h2h_shop",
"merchant_user_id": "merchant-user-001",
"merchant_user_ip": "203.0.113.10",
"paymentData": {
"mobile_number": "9876543210",
"ifsc_code": "SBIN0001234",
"holder": "Rahul Sharma"
}
}
Response fields
| Parameter | Type | Description |
|---|---|---|
| id | number | Payfield operation ID. |
| status | string | Current payout status. |
| external_id | string | Unique payout identifier from the request. |
| amount | number | Payout amount. |
| currency | string | Payout currency. |
| shop_code | string | Shop code used for routing. |
| card_number | string | Recipient account number. |
| merchant_user_id | string | Merchant user identifier from the request. |
| merchant_user_ip | string | User IP from the request. |
| paymentData | object | Shop-specific payout fields. |
| transaction_type | string | Always payout. |
| created_at | string | Creation timestamp. |
| updated_at | string | Last update timestamp. |
| finalization_date | string | Returned when the payout reaches a final status. |
Example response body
{
"id": 12345,
"status": "pending",
"external_id": "PAY-INR-FTD-H2H-001",
"amount": 5000,
"currency": "INR",
"shop_code": "your_inr_ftd_h2h_shop",
"card_number": "4111111111111111",
"merchant_user_id": "merchant-user-001",
"merchant_user_ip": "203.0.113.10",
"paymentData": {
"mobile_number": "9876543210",
"ifsc_code": "SBIN0001234",
"holder": "Rahul Sharma"
},
"transaction_type": "payout",
"created_at": "2025-12-05T10:00:00.000000Z",
"updated_at": "2025-12-05T10:00:00.000000Z"
}
If mobile_number, ifsc_code or holder is sent in paymentData, it must be a valid string value.
Payment Page contract
Fields in paymentData
| Parameter | Type | Required | Description |
|---|---|---|---|
| mobile_number | string | Yes | Customer mobile number. |
| ifsc_code | string | No | Recipient IFSC code. |
| holder | string | No | Recipient account holder name. |
Example request body
{
"external_id": "PAY-INR-FTD-PAGE-001",
"amount": 5000.00,
"currency": "INR",
"card_number": "4111111111111111",
"shop_code": "your_inr_ftd_payment_page_shop",
"merchant_user_id": "merchant-user-001",
"merchant_user_ip": "203.0.113.10",
"paymentData": {
"mobile_number": "9876543210",
"ifsc_code": "SBIN0001234",
"holder": "Rahul Sharma"
}
}
Response fields
| Parameter | Type | Description |
|---|---|---|
| id | number | Payfield operation ID. |
| status | string | Current payout status. |
| external_id | string | Unique payout identifier from the request. |
| amount | number | Payout amount. |
| currency | string | Payout currency. |
| shop_code | string | Shop code used for routing. |
| card_number | string | Recipient account number. |
| merchant_user_id | string | Merchant user identifier from the request. |
| merchant_user_ip | string | User IP from the request. |
| paymentData | object | Shop-specific payout fields. |
| transaction_type | string | Always payout. |
| created_at | string | Creation timestamp. |
| updated_at | string | Last update timestamp. |
| finalization_date | string | Returned when the payout reaches a final status. |
Example response body
{
"id": 12345,
"status": "pending",
"external_id": "PAY-INR-FTD-PAGE-001",
"amount": 5000,
"currency": "INR",
"shop_code": "your_inr_ftd_payment_page_shop",
"card_number": "4111111111111111",
"merchant_user_id": "merchant-user-001",
"merchant_user_ip": "203.0.113.10",
"paymentData": {
"mobile_number": "9876543210",
"ifsc_code": "SBIN0001234",
"holder": "Rahul Sharma"
},
"transaction_type": "payout",
"created_at": "2025-12-05T10:00:00.000000Z",
"updated_at": "2025-12-05T10:00:00.000000Z"
}
Without valid mobile_number in paymentData, the request will be rejected with a validation error (422, "Invalid paymentData"). Optional ifsc_code and holder must be valid string values when sent.