Qodex.ai

Merchant Self Services API - Alerts

Number of APIs: 15

These API endpoints are used by merchants to onboard their sub-merchants onto the Alerts product suite.

Getting Started

  1. After updating the consumerKey and privateKey for an environment, set the environment as active
  2. To get the member_id, send request to GET /alerts/merchants/org-profiles

  3. Get the member_id from the response and update the collection variable memberId

  4. To add Acquirer Reference Id values for the member, send request to POST /alerts/merchants/{member_id}/acquirer-reference-ids. The acquirerReferenceId and merchantIdentifierConfigId from the response will be automatically copied over to the collection variables with the same names. These collection variables' values will be used by the other acquirer-reference-ids endpoints.

  5. To create a sub-merchant, send request to POST /alerts/merchants/{member_id}/sub-merchants. The subMerchantId from the response will be automatically copied over to the collection variable with the same name. This collection variable's value will be used by the other sub-merchants endpoints.

  6. To add card acceptor id for a sub-merchant, send request to POST /alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-ids. The merchantIdentifierConfigId from the response will be automatically copied over to the collection variable with the same name. This collection variable's value will be used by the other card-acceptor-ids endpoints.

  7. To add card acceptor name for a sub-merchant, send request to POST /alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-names. The merchantIdentifierConfigId from the response will be automatically copied over to the collection variable with the same name. This collection variable's value will be used by the other card-acceptor-names endpoints.

  1. alerts-merchants-{member_id}-sub-merchants-{sub_merchant_id}-status-changes - Change sub-merchant status. PUT {{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/status-changes

  2. alerts-merchants-{member_id}-sub-merchants-{sub_merchant_id}-card-acceptor-ids - Create sub-merchant card acceptor id config. POST {{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-ids

  3. alerts-merchants-org-profiles - Get details of organization profiles. GET {{baseUrl}}/alerts/merchants/org-profiles

  4. alerts-merchants-{member_id}-acquirer-reference-ids - Create acquirer reference id config. POST {{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-ids

  5. alerts-merchants-{member_id}-acquirer-reference-ids - Get acquirer reference id configs. GET {{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-ids?acquirer_reference_id=121212&card_scheme=VISA&offset=25&page_number=1

  6. alerts-merchants-{member_id}-acquirer-reference-ids - Delete acquirer reference id config. DELETE {{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-ids?merchant_identifier_config_id={{merchantIdentifierConfigId}}

  7. alerts-merchants-{member_id}-sub-merchants-{sub_merchant_id}-card-acceptor-ids - Get sub-merchant card acceptor id configs. GET {{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-ids?acquirer_reference_id={{acquirerReferenceId}}&card_acceptor_id=card&offset=25&page_number=1

  8. alerts-merchants-{member_id}-sub-merchants-{sub_merchant_id}-card-acceptor-ids - Delete sub-merchant card acceptor id config. DELETE {{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-ids?merchant_identifier_config_id={{merchantIdentifierConfigId}}

  9. alerts-merchants-{member_id}-sub-merchants-{sub_merchant_id}-card-acceptor-names - Get sub-merchant card acceptor name configs. GET {{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-names?card_acceptor_name=card&offset=25&page_number=1

  10. alerts-merchants-{member_id}-sub-merchants-{sub_merchant_id}-card-acceptor-names - Create sub-merchant card acceptor name config. POST {{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-names