Merchant Applications

🚧

In development

A legacy version of the Merchant Boarding API is live currently, however a new enhanced version is in development. For new consumers, it is highly recommended to use the new version of the API expected in Q3 2022.

Please note the API specification may change while it's in development

Merchant Applications Resource

A merchant application has to be created before creating any other resource(s), as other resources are connected to the merchantApplicationId used in the path parameter. While the application is still being updated, the applicationStatusCode will remain as OPEN.

Mandatory Fields

AttributeTypeDescriptionExample / ENUMS
agentBankCodestringAn ID assigned by Fiserv to our customers and partners. This needs to be obtained from Fiserv before the integration.123123456456
allianceCodestringThis code is assigned by Fiserv and must be obtained before integration into the boarding API. An alliance is typically an organization holding an acquiring licence issued by card schemes (just like Visa, MasterCard etc).ABC
applicationStatusCodestringIndicates the overall status of the application and determines further actions of the internal systemsOnce you submit the application, the value will change to APPLICATION_READY_FOR_BOARDING and no more updates will be allowed.
applicationReferencestringYour unique reference ID allocated to the request by you777000001570
applicationTypeCodestringIndicates the type of requestMust be NEW_MERCHANT when creating a new merchant.
businessEntityIdstringIndicates the ID of the parent/root business entity resource1d886985-ee9b-4d8b-ac80-1a634f3f33e8
ownershipEntityIdstringIndicates the ID of the parent/root business entity resource1ac4af3cc-e42a-4267-90e6-15d91657c273

Optional Fields

AttributeTypeDescriptionExample / ENUMS
underwritingStatusstringStatus of the underwriting process for this requestOptional only in case of adding a new store to an existing merchant
amlStatusstringStatus of the AML process for this requestOptional only in case of adding a new store to an existing merchant
documentsarrayContains the id and type of the document(s) that are part of the application. This id and type is obtained after using the Documents API[{"id": "83c41dbe-85ba-47b0-83cd-13388a298807","type": "FINANCIAL"}]
crmOpportunityIdstringThe CRM (Customer Relationship Management system, e.g. salesforce) opportunity ID that the customer request is linked to.0061D000003KfikQAC
sellerInformationarrayContains the id, firstName, lastName and email of the sales representative who owns the relationship and/or may receive commission"sellerInformation": {"firstName": "John", "lastName": "Smith", "email": "[email protected]", "id": "0135998"}

Additional Mandatory Fields for Boarding Merchants of Partners

If you are not an organization holding an acquiring licence then you may have a Partner status. Partners are typically companies (such as Payment Facilitators, Independent Software Vendors, Independent Sale Organisations ...) who can contract merchants for card acceptance but they must always be authorized by an Alliance.
Thus you need to provide an additional attribute in the payload:

AttributeTypeDescriptionExample / ENUMS
partnerCodestringThis code is assigned by Fiserv and must be obtained before integration into the boarding APIDIGI_PMNTS

Conditional Fields

AttributeTypeDescriptionExample / ENUMS
salesContractDatestringDate the customer signs the contract (yyyy-mm-dd format). This only needs to be provided if you are boarding to RMW directly and not using Diligence2021-11-02

Examples

Example Request

{
     "allianceCode": "TEST",
     "partnerCode": "DIGI_PMNTS",
     "applicationStatusCode": "OPEN",
     "interventionReasonCode": "TURNOVER_EXCEEDED",
     "interventionReasonDescription": "The turnover 150 000 EUR was exceeded",
     "businessId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "ownershipEntityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "documents": [
          {
               "id": "83c41dbe-85ba-47b0-83cd-13388a298807",
               "type": "FINANCIAL"
          }
     ],
     "crmOpportunityId": "0061D000003KfikQAC",
     "salesContractDate": "2022-04-07",
     "sellerInformation": {
          "id": "0135998",
          "firstName": "John",
          "lastName": "Smith",
          "email": "[email protected]"
     }
}

Example Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "allianceCode": "TEST",
  "partnerCode": "DIGI_PMNTS",
  "applicationStatusCode": "OPEN",
  "interventionReasonCode": "TURNOVER_EXCEEDED",
  "interventionReasonDescription": "The turnover 150 000 EUR was exceeded",
  "businessId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ownershipEntityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documents": [
    {
      "id": "83c41dbe-85ba-47b0-83cd-13388a298807",
      "type": "FINANCIAL"
    }
  ],
  "underwritingStatus": "AWAITING_UNDERWRITING",
  "amlStatus": {
    "overall": "AWAITING_AML",
    "individuals": [
      {
        "firstName": "John",
        "middleName": "Adam",
        "lastName": "Smith",
        "dateOfBirth": "2022-04-07",
        "status": "AWAITING_AML"
      }
    ]
  },
  "crmOpportunityId": "0061D000003KfikQAC",
  "salesContractDate": "2022-04-07",
  "sellerInformation": {
    "id": "0135998",
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]"
  }
}

Did this page help you?