1. Appendix
Onboarding API
  • Onboarding API EN Version
    • Group Info
      • New Group Info
      • Edit Group Info
      • Query Group Info
    • Merchant Info
      • New Merchant Info
      • Edit Merchant Info
      • Enable Merchant Info
      • Disable Merchant Info
      • Batch Disable Merchant Info
      • Delete Merchant Info
      • Query Merchant Info
      • Query Merchant Info List
    • Store Info
      • New Store Info
      • Delete Store Info
      • Query Store Info
      • Update PaymentBrand
      • Enable Store Info
      • Delete PaymentBrand
      • Batch Disable Store Info
      • Edit Store Info
      • Disable Store Info
      • Add PaymentBrand
      • Query Store Info List
    • Terminal Info
      • New Terminal Info
      • Edit Terminal Info
      • Enable Terminal Info
      • Disable Terminal Info
      • Query Terminal Info
      • Query Terminal Info List
      • Delete Terminal Info
      • Check POS
    • MDR Plan
      • New MDR Plan
      • Edit MDR Plan
      • Enable MDR Plan
      • Disable MDR Plan
      • Query MDR Plan
      • Query Merchant MDR Plan
      • Delete MDR Plan
      • Batch Set MDR Plan
    • Transaction Limit Plan
      • New Transaction Limit Plan
      • Edit Transaction Limit Plan
      • Enable Transaction Limit Plan
      • Disable Transaction Limit Plan
      • Delete Transaction Limit Plan
      • Query Transaction Limit Plan
      • Query Transaction Limit Plan List
      • Set Transaction Limit Plan
      • Batch Set Transaction Limit Plan
      • Query Merchant Transaction Limit Plan
  • Appendix
    • MCC
    • Payment Brand
    • Payment Method Variant
    • Payment Brand, PSP Name and PSP Version
    • Card Class
    • Product ID
    • Country/Region
    • Result Code
    • Group Status
    • Merchant Status
    • Store Status
    • Terminal Status
    • MDR Plan Status
    • Transaction Limit Plan Status
    • Blended Billing Model Calculation Rules
  1. Appendix

Result Code

Result Code#

EVO Payment use result object in the response message to show the result of the API call, which contains a code for onboarding caller to handle programmatically and a message - a short string with a brief explanation - as a value for code.
A S0000 result.code indicates that the API call is successful, and here is the category for codes that showing an API call is rejected.
CategoryDescription
VxxxxIndicates an error because the validation for the information provided in the request message fails (for example, a required parameter is omitted). By receiving this type of result, caller should check the request message according to result.code and result.message.
OxxxxIndicates an error because the request is inconsist with some business rules setup in EVO Payment. By receiving this type of result, merchant should check the request message according to result.code and result.message, and may need to refer to acquirer/group/merchant/store profile setup in EVO Payment.
ExxxxIndicates an error with EVO Payment servers. Although EVO Payment work to make this type of error as rare as possible, the caller should be able to handle them when these types of error do arise.

Category S#

result.coderesult.message
S0000Success

Category V#

result.coderesult.message
V0000Field {} invalid format
V0001Missing field {}
V0002Field {} invalid value
V0004Field {xxx} decrypted failed
V0005Request body is not a valid JSON
V0006HTTP method not supported
V0010Signature error, please check your signature key or algorithm

Category O#

result.coderesult.messageNote
O0001The request has been denied.
O0002The store doesn't exist, acquirerID={acquirerID}, storeID={storeID}.
O0003The terminal doesn't exist, acquirerID={acquirerID}, storeID={storeID}, terminalID={terminalID}.
O0004The terminal exists, acquirerID={acquirerID}, storeID={storeID}, terminalID={terminalID}.
O0005The {XXX} is under review, so the {YYY} can't be {ZZZ}.XXX can be group/merchant/store., YYY can be merchant/store/terminal., ZZZ can be created/edited/disabled/enabled.
O0006The {XXX} status is disabled, it can't be edited.XXX can be terminal/store.
O0007The {XXX} status is not disabled, it can't be enabledXXX can be terminal/store.
O0008The terminal status is disabled, it can't be disabled.
O0009The terminal exceeds the maximum number {XXX} of terminals that can be created for a store, please check your profile setup in portal.
O0010The accountID {accountID} doesn't exist.
O0011The user level {user level} can't access to the API.
O0012The {XXX} is under review, it can't be {YYY}.XXX can be group/merchant/store/terminal., YYY can be edited/disabled/enabled.
O0013The merchant doesn't exist, acquirerID={acquirerID}, merchantID={merchantID}.
O0014The store exists, acquirerID={acquirerID}, storeID={storeID}.
O0015The user level {user level} can't set field {field}.
O0016There is at least a pending PSP in the store, so the field {field} can't be edited.
O0017The store status is {store status}, so it can't be disabled.
O0018The group doesn't exist, acquirerID={acquirerID}, groupID={groupID}.
O0019The merchant exists, acquirerID={acquirerID}, merchantID={merchantID}.
O0020The group exist, acquirerID={acquirerID}, groupID={groupID}.
O0021The acquirer doesn't exist, acquirerID={acquirerID}.
O0022The MDR plan doesn't exist, {ZZZ}ID={XXX}, planID={YYY}{ZZZ}ID={XXX}, planID={YYY}, {YYY} = planID / null
O0023The acquirer {acquirerID} is disabled, so it can't be {XXX}.{acquirerID} = User-related acquirer ID, {XXX} = created/edited/disabled/enabled
O0024The {XXX} status is not enabled, it can't be disabled.
O0025The externalPlanID doesn't exist, acquirerID={XXX}, externalPlanID={YYY}.
O0026The store can not be found.
O0027Unsupported function ({function name}). Please check your profile setup in the portal.
O0028Field {fieldName}={fieldValue} is not applied with field {fieldName}={fieldValue}
O0029Batch Failed
O0030Partial Success
O0031The {AAA} status is {BBB}, so {CCC} can't {DDD}.AAA:acquirer/group/merchant/store/transaction limit plan, BBB: Get the value of status field, CCC: group/merchant/store/transaction limit plan, DDD: be created/be edited/be enabled/be disabled/be deleted
O0032The {AAA} status is not {BBB}, so {CCC} can't {DDD}.AAA: acquirer/group/merchant/store/transaction limit plan, BBB: Get the value of status field, CCC: group/merchant/store/transaction limit plan, DDD: be created/be edited/be enabled/be disabled/be deleted
O0033{field} is duplicated, {XXX}ID already exists. Duplicate creation is not allowed.
O0034{AAA} is in use by {BBB}, so {CCC} can't {DDD}.
O0035The {XXX} doesn't exist, {YYY}
O0036{XXX} must be greater than or equal to both the {YYY} and the current date.
O0037The period between {XXX} and {YYY} cannot exceed {ZZZ}.
O0038{field} cannot be later than the current date.
O0039The validity period must be the same.
O0040The {XXX} can not exceed {YYY}.
O0041The validity period of the MDR plan conflicts with another MDR plan, {AAA}={BBB}, planID={CCC}.
O0042{XXX} must be greater than or equal to {YYY}.
O0043The {XXX} not support the {YYY}
O0045The {XXX} and {YYY} mismatch
O0046The limit level of the planID is not equal to the level in the request.
O0047The userID {userID} doesn't exist.

Category E#

result.coderesult.message
E0006{XXX} configuration can not be found, trace ID: {xxx}, error ID: {xxx}
Previous
Country/Region
Next
Group Status
Built with