Body
P2P to P2M migration
This API is used to migrate p2p customers to submerchants.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/sub/p2mMigration
Headers
Content-Type
String
application/json
x-merchant-id
String
Will be shared while onboarding.
x-merchant-channel-id
String
Will be shared while onboarding.
x-timestamp
String
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
x-merchant-signature
String
This is a signature over combination of headers, payload.
Request Schema: application/json
Parameter
subMerchantId
*
String
Mandatory
Merchant generated sub-merchant id value
Constraints:Alphanumeric string. Maximum length is 256.
subMerchantChannelId
*
String
Mandatory
Sub-merchant channel id
Constraints:Alphanumeric string. Maximum length is 256.
vpa
*
String
Mandatory
Vpa which is linked to QR
Constraints:Special characters allowed(.-@).Maximum length is 25.
accountNumber
optional
Account number for the sub-merchant
Constraints:Numeric string. Maximum length is 30.
ifsc
optional
Ifsc code of the sub-merchant bank account
Constraints:Alphanumeric string. Maximum length is 11.
mcc
*
String
Mandatory
Mcc code of the sub-merchant
Constraints:Numeric String (4).
callbackUrls
optional
Callback Urls are configured for each event
Constraints:Stringified Array of JSON objects.
merchantName
*
String
Mandatory
Name of sub-merchant
Constraints:Alphanumeric string. Maximum length is 100.
marketingName
*
String
Mandatory
Market name of the sub-merchant
Constraints:Alphanumeric string. Maximum length is 50.
city
*
String
Mandatory
City of sub-merchant
Constraints:Alphanumeric string. Maximum length is 50.
address
*
String
Mandatory
Address of sub-merchant
Constraints:Alphanumeric string. Maximum length is 200.
state
*
String
Mandatory
State of sub-merchant
Constraints:Alphanumeric string . Maximum length is 50.
pincode
*
String
Mandatory
Pincode of sub-merchant
Constraints:Numeric String (6).
owner
*
String
Mandatory
Owner of sub-merchant firm
Constraints:Alphanumeric string. Maximum length is 50.
partner1
*
String
Mandatory
Partner name of sub-merchant firm
Constraints:Alphanumeric string. Maximum length is 50.
partner2
*
String
Mandatory
Partner name of sub-merchant firm
Constraints:Alphanumeric string. Maximum length is 50.
mccDescription
*
String
Mandatory
Description of mcc
Constraints:Alphanumeric string. Maximum length is 256.
gstin
optional
GSTIN
Constraints:Alphanumeric string. Maximum length is 20.
panNumber
optional
PAN Number of sub-merchant
Constraints:Alphanumeric string. Maximum length is 10.
mid
*
String
Mandatory
Merchant identifier for sub-merchant
Constraints:Alphanumeric string. Maximum length is 20.
tid
*
String
Mandatory
Terminal identifier for sub-merchant
Constraints:Alphanumeric string. Maximum length is 20.
sid
*
String
Mandatory
Store id for sub-merchant
Constraints:Alphanumeric string. Maximum length is 20.
merchantType
*
String
Mandatory
Merchant type for sub-merchant
Constraints:SMALL,LARGE.
merchantGenre
*
String
Mandatory
Genre of sub-merchant
Constraints:ONLINE, OFFLINE.
onBoardingType
*
String
Mandatory
Onboarding type of sub-merchant
Constraints:BANK, AGGREGATOR
brand
*
String
Mandatory
Brand name of sub-merchant
Constraints:Alphanumeric string. Maximum length is 99.
legal
*
String
Mandatory
Legal name for sub-merchant
Constraints:Alphanumeric string. Maximum length is 99.
franchise
*
String
Mandatory
franchise name for sub-merchant
Constraints:Alphanumeric string. Maximum length is 99.
type
*
String
Mandatory
Ownership type of sub-merchant
Constraints:PROPRIETARY,PARTNERSHIP,PRIVATE,PUBLIC,OTHERS.
enabled
optional
Denotes if the sub-merchant is enabled or not
Constraints: true, false
isB2BMerchant
optional
Denotes if sub-merchant can accept payment as a B2B merchant.
Constraints: true, false.
replacementVpa
optional
Vpa that becomes primary vpa after the primary vpa is migrated.
Constraints:Special characters allowed(.-@).Maximum length is 25.
iat
*
String
Mandatory
Timestamp to be used in JWS
Constraints: As passed in the request body
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values:SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Values:Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Values:Refer error code section
merchantId
*
String
Mandatory
Unique id for parent merchant
Values:As passed in request.
merchantChannelId
*
String
Mandatory
Unique id for the channel of the parent merchant
Values:As passed in request.
subMerchantId
*
String
Mandatory
Merchant generated sub-merchant id value
Values:Merchant generated sub-merchant id value
subMerchantChannelId
*
String
Mandatory
Sub-merchant channel id
Values:As passed in request.
vpa
*
String
Mandatory
Vpa for sub-merchant
Values:As passed in request.
maskedAccountNumber
*
String
Mandatory
Masked account number for the sub-merchant
Values:XXXX123456
ifsc
*
String
Mandatory
Ifsc code of the sub-merchant bank account
Values:As passed in request.
mcc
*
String
Mandatory
Mcc code of the sub-merchant
Values:As passed in request.
enabled
*
String
Mandatory
Tells whether the sub-merchant is enabled or not
Values:As passed in request, true if not passed.
callbackUrls
*
String
Mandatory
Callback Urls configured for each event
Values:As passed in request.
Have questions?
- Need help? Contact support
- LLM? Read llms.txt