Widget SDK Reference
Examples
Paysight API
Email Services
Payment API
- Card
Customer Service API
- API Reference
Admin API
Mitigation API
- API for Chargeback Mitigation Providers
MerchantAccounts
CreateMerchantAccount
POST
/
api
/
admin
/
merchantaccounts
Copy
curl --request POST \
--url https://test.paysight.io/api/admin/merchantaccounts \
--header 'Authorization: <api-key>' \
--header 'ClientId: <clientid>' \
--header 'Content-Type: application/json' \
--header 'UserEmail: <useremail>' \
--data '{
"id": 123,
"mid": "<string>",
"title": "<string>",
"companyId": 123,
"agent": "<string>",
"acquiringBank": "<string>",
"gatewayId": 123,
"enabledMastercard": true,
"enabledVisa": true,
"descriptor": "<string>",
"mcc": "<string>",
"acquirerBINVisa": "<string>",
"acquirerBINMastercard": "<string>",
"psp": "<string>",
"maxPrice": 123,
"verticalId": 123,
"monthlyCap": 123,
"reservePercentage": 123,
"discountRatePercentage": 123,
"gatewayTransactionFee": 123,
"chargebackFee": 123,
"routingNumber": "<string>",
"accountNumber": "<string>",
"brandId": 123,
"allowPremiumProgram": true,
"fullyLive": true,
"shorthandSuffix": "<string>",
"defaultCurrency": "<string>",
"rdrFee": 123,
"ethocaFee": 123,
"cdrnFee": 123,
"allowRetriesFromOtherMids": true,
"allowInsufficientFundsRetries": true,
"capLimited": "2023-11-07T05:31:56Z",
"forceAllowRefunds": true,
"dynamicDescriptorEnabled": true,
"dynamicDescriptorPrefix": "<string>",
"dynamicDescriptorPrefix_MC": "<string>",
"dynamicDescriptorFormat": 123,
"bankAuthFee": 123,
"bankDeclineFee": 123,
"bankAVSFee": 123,
"customFee": 123,
"customFeeApprovedOnly": 123,
"notes": "<string>",
"caid": "<string>",
"chargebackMitigationProviderId": 123,
"chargebackMitigationNotes": "<string>",
"processorPortalAccessId": 123,
"rowVersion": 123,
"merchantDefinedField1": "<string>",
"merchantDefinedField2": "<string>",
"merchantDefinedField3": "<string>",
"customField1": "<string>",
"customField2": "<string>",
"customField3": "<string>",
"midOwnerId": 123,
"currencies": [
{
"currency": "<string>",
"gatewayCredentials": {
"apiKey": "<string>",
"username": "<string>",
"password": "<string>",
"emailAddress": "<string>"
}
}
],
"company": "<string>",
"gateway": "<string>",
"vertical": "<string>",
"brand": "<string>",
"chargebackMitigationProvider": "<string>",
"processorPortalAccess": "<string>",
"parentCompanyId": 123,
"parentCompany": "<string>"
}'
Copy
{
"success": true,
"message": "<string>",
"returnVal": {
"id": 123,
"mid": "<string>",
"title": "<string>",
"companyId": 123,
"agent": "<string>",
"acquiringBank": "<string>",
"gatewayId": 123,
"enabledMastercard": true,
"enabledVisa": true,
"descriptor": "<string>",
"mcc": "<string>",
"acquirerBINVisa": "<string>",
"acquirerBINMastercard": "<string>",
"psp": "<string>",
"maxPrice": 123,
"verticalId": 123,
"monthlyCap": 123,
"reservePercentage": 123,
"discountRatePercentage": 123,
"gatewayTransactionFee": 123,
"chargebackFee": 123,
"routingNumber": "<string>",
"accountNumber": "<string>",
"brandId": 123,
"allowPremiumProgram": true,
"fullyLive": true,
"shorthandSuffix": "<string>",
"defaultCurrency": "<string>",
"rdrFee": 123,
"ethocaFee": 123,
"cdrnFee": 123,
"allowRetriesFromOtherMids": true,
"allowInsufficientFundsRetries": true,
"capLimited": "2023-11-07T05:31:56Z",
"forceAllowRefunds": true,
"dynamicDescriptorEnabled": true,
"dynamicDescriptorPrefix": "<string>",
"dynamicDescriptorPrefix_MC": "<string>",
"dynamicDescriptorFormat": 123,
"bankAuthFee": 123,
"bankDeclineFee": 123,
"bankAVSFee": 123,
"customFee": 123,
"customFeeApprovedOnly": 123,
"notes": "<string>",
"caid": "<string>",
"chargebackMitigationProviderId": 123,
"chargebackMitigationNotes": "<string>",
"processorPortalAccessId": 123,
"rowVersion": 123,
"merchantDefinedField1": "<string>",
"merchantDefinedField2": "<string>",
"merchantDefinedField3": "<string>",
"customField1": "<string>",
"customField2": "<string>",
"customField3": "<string>",
"midOwnerId": 123,
"currencies": [
{
"currency": "<string>",
"gatewayCredentials": {
"apiKey": "<string>",
"username": "<string>",
"password": "<string>",
"emailAddress": "<string>"
}
}
],
"company": "<string>",
"gateway": "<string>",
"vertical": "<string>",
"brand": "<string>",
"chargebackMitigationProvider": "<string>",
"processorPortalAccess": "<string>",
"parentCompanyId": 123,
"parentCompany": "<string>"
}
}
Authorizations
Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account
Headers
Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight
The email address of the party or group making the request
Body
application/json
Response
200 - application/json
Merchant account created
The response is of type object
.
Copy
curl --request POST \
--url https://test.paysight.io/api/admin/merchantaccounts \
--header 'Authorization: <api-key>' \
--header 'ClientId: <clientid>' \
--header 'Content-Type: application/json' \
--header 'UserEmail: <useremail>' \
--data '{
"id": 123,
"mid": "<string>",
"title": "<string>",
"companyId": 123,
"agent": "<string>",
"acquiringBank": "<string>",
"gatewayId": 123,
"enabledMastercard": true,
"enabledVisa": true,
"descriptor": "<string>",
"mcc": "<string>",
"acquirerBINVisa": "<string>",
"acquirerBINMastercard": "<string>",
"psp": "<string>",
"maxPrice": 123,
"verticalId": 123,
"monthlyCap": 123,
"reservePercentage": 123,
"discountRatePercentage": 123,
"gatewayTransactionFee": 123,
"chargebackFee": 123,
"routingNumber": "<string>",
"accountNumber": "<string>",
"brandId": 123,
"allowPremiumProgram": true,
"fullyLive": true,
"shorthandSuffix": "<string>",
"defaultCurrency": "<string>",
"rdrFee": 123,
"ethocaFee": 123,
"cdrnFee": 123,
"allowRetriesFromOtherMids": true,
"allowInsufficientFundsRetries": true,
"capLimited": "2023-11-07T05:31:56Z",
"forceAllowRefunds": true,
"dynamicDescriptorEnabled": true,
"dynamicDescriptorPrefix": "<string>",
"dynamicDescriptorPrefix_MC": "<string>",
"dynamicDescriptorFormat": 123,
"bankAuthFee": 123,
"bankDeclineFee": 123,
"bankAVSFee": 123,
"customFee": 123,
"customFeeApprovedOnly": 123,
"notes": "<string>",
"caid": "<string>",
"chargebackMitigationProviderId": 123,
"chargebackMitigationNotes": "<string>",
"processorPortalAccessId": 123,
"rowVersion": 123,
"merchantDefinedField1": "<string>",
"merchantDefinedField2": "<string>",
"merchantDefinedField3": "<string>",
"customField1": "<string>",
"customField2": "<string>",
"customField3": "<string>",
"midOwnerId": 123,
"currencies": [
{
"currency": "<string>",
"gatewayCredentials": {
"apiKey": "<string>",
"username": "<string>",
"password": "<string>",
"emailAddress": "<string>"
}
}
],
"company": "<string>",
"gateway": "<string>",
"vertical": "<string>",
"brand": "<string>",
"chargebackMitigationProvider": "<string>",
"processorPortalAccess": "<string>",
"parentCompanyId": 123,
"parentCompany": "<string>"
}'
Copy
{
"success": true,
"message": "<string>",
"returnVal": {
"id": 123,
"mid": "<string>",
"title": "<string>",
"companyId": 123,
"agent": "<string>",
"acquiringBank": "<string>",
"gatewayId": 123,
"enabledMastercard": true,
"enabledVisa": true,
"descriptor": "<string>",
"mcc": "<string>",
"acquirerBINVisa": "<string>",
"acquirerBINMastercard": "<string>",
"psp": "<string>",
"maxPrice": 123,
"verticalId": 123,
"monthlyCap": 123,
"reservePercentage": 123,
"discountRatePercentage": 123,
"gatewayTransactionFee": 123,
"chargebackFee": 123,
"routingNumber": "<string>",
"accountNumber": "<string>",
"brandId": 123,
"allowPremiumProgram": true,
"fullyLive": true,
"shorthandSuffix": "<string>",
"defaultCurrency": "<string>",
"rdrFee": 123,
"ethocaFee": 123,
"cdrnFee": 123,
"allowRetriesFromOtherMids": true,
"allowInsufficientFundsRetries": true,
"capLimited": "2023-11-07T05:31:56Z",
"forceAllowRefunds": true,
"dynamicDescriptorEnabled": true,
"dynamicDescriptorPrefix": "<string>",
"dynamicDescriptorPrefix_MC": "<string>",
"dynamicDescriptorFormat": 123,
"bankAuthFee": 123,
"bankDeclineFee": 123,
"bankAVSFee": 123,
"customFee": 123,
"customFeeApprovedOnly": 123,
"notes": "<string>",
"caid": "<string>",
"chargebackMitigationProviderId": 123,
"chargebackMitigationNotes": "<string>",
"processorPortalAccessId": 123,
"rowVersion": 123,
"merchantDefinedField1": "<string>",
"merchantDefinedField2": "<string>",
"merchantDefinedField3": "<string>",
"customField1": "<string>",
"customField2": "<string>",
"customField3": "<string>",
"midOwnerId": 123,
"currencies": [
{
"currency": "<string>",
"gatewayCredentials": {
"apiKey": "<string>",
"username": "<string>",
"password": "<string>",
"emailAddress": "<string>"
}
}
],
"company": "<string>",
"gateway": "<string>",
"vertical": "<string>",
"brand": "<string>",
"chargebackMitigationProvider": "<string>",
"processorPortalAccess": "<string>",
"parentCompanyId": 123,
"parentCompany": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.