Allows a registered partner to create or update merchant participation details

POST {{baseUrl}}/merchants/participations

Allows registered partners to submit merchant participation details. Merchant participation states that a merchant has opted in or opted out from Buy Now Pay Later. This endpoint allows the client to create a merchant with participation. A unique merchant will be a combination of acquirerICA, merchantLegalName, and countryCode. This endpoint also allows the updating of existing merchant participation information like adding more mids in a merchant object, changing the value of the opt-In flag, updating address fields, and updating wallet information. The acquirerICA, merchantLegalName, and countryCode fields are used to identify an existing merchant. If the merchant is already present, the mids provided in the request will be appended to the existing set of mids. The duns, dbaNames and websiteUrl fields cannot be updated hence these fields either must be null or empty or they must be the same as existing one in the update request otherwise this API will throw a 400 bad request error. Once the request is validated and accepted, this API returns the ID of this request in the 'requestid' response header, and the request will be processed asynchronously. Use the GET /merchants/participation endpoint to check the status of the request by using the requestid. When submitting a participation request, the end user can initiate calls with various numbers of merchants and MIDs. However, it's crucial to ensure that the total payload size remains under 700 KB, as the API will generate an error otherwise. In the case of countries where merchant data is classified as PII, the data pertaining to merchantLegalName, dbaNames, and address must be encrypted, and the encrypted values should be assigned to the 'sensitiveData' field. For countries where merchant data is not classified as PII, there is no need to populate the 'sensitiveData' field. Instead, populate the individual fields, namely merchantLegalName, dbaNames, and address.

Please refer to request and response specification for more details. The encryption needs to be performed using JWE payload encryption. Please refer to the Securing Sensitive Data Using Payload Encryption sections for implementation details.

Request Body

{"0"=>{"merchantLegalName"=>"Example Mart", "countryCode"=>"USA", "acquirerICA"=>"00689425761", "dbaNames"=>["ACME"], "mids"=>["987123456789124", "123123456789124", "567123456789124"], "nonMerchantNegotiatedParticipation"=>"Y", "duns"=>"879847426", "websiteUrl"=>"https://www.example.com", "wallets"=>[{"walletId"=>1, "walletAcceptance"=>"Y", "walletMerchantId"=>"235346356234 | 125346356236 | 125446356237"}, {"walletId"=>2, "walletAcceptance"=>"Y", "walletMerchantId"=>"235346356234 | 125346356236 | 125446356237"}, {"walletId"=>3, "walletAcceptance"=>"Y", "walletMerchantId"=>"235346356234 | 125346356236 | 125446356237"}], "address"=>{"addressLine1"=>"600 WEST", "addressLine2"=>"SECTOR 5", "addressLine3"=>"SUITE 775", "city"=>"St Peters", "state"=>"QLD", "postalCode"=>"85001"}}, "1"=>{"merchantLegalName"=>"Example Mart 1", "countryCode"=>"USA", "acquirerICA"=>"00689425762", "dbaNames"=>["ACME"], "mids"=>["387123456789124", "223123456789124", "167123456789124"], "nonMerchantNegotiatedParticipation"=>"Y", "duns"=>"879847421", "websiteUrl"=>"https://www.example2.com", "wallets"=>[{"walletId"=>1, "walletAcceptance"=>"Y", "walletMerchantId"=>"235346356234 | 125346356236 | 125446356237"}, {"walletId"=>2, "walletAcceptance"=>"Y", "walletMerchantId"=>"235346356234 | 125346356236 | 125446356237"}, {"walletId"=>3, "walletAcceptance"=>"Y", "walletMerchantId"=>"235346356234 | 125346356236 | 125446356237"}], "address"=>{"addressLine1"=>"600 WEST", "addressLine2"=>"SECTOR 5", "addressLine3"=>"SUITE 775", "city"=>"St Peters", "state"=>"QLD", "postalCode"=>"85001"}}}

HEADERS