---
title: "Create a Network Retry Signal Enrolment"
method: POST
path: "/payments/network-retry-signals/onboarding"
tags: ["Payments", "Network Retry Signals"]
---

# Create a Network Retry Signal Enrolment

`POST /payments/network-retry-signals/onboarding`

## Request

- Base URL: `https://api.evervault.com`
- URL: `https://api.evervault.com/payments/network-retry-signals/onboarding`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/evervault/apis/evervault-api/docs/payments/network-retry-signals/onboarding/post.ts> (a function with typed inputs; its response is checked against the schema)

Enrolls up to ten Merchant Identifiers (MIDs) for one Merchant with Visa, Mastercard, or both. Each identifier is either a `networkMid` or a list of `networkTransactions` that Evervault uses to locate the MID.

The response has one enrolment for each identifier, in the same order as the request.

## Request body

- object
  - `merchant` string, required: The ID of the Evervault Merchant being enrolled.
  - `identifiers` object[], required: The MIDs to enroll. Each identifier needs exactly one of `networkMid` or `networkTransactions`. A `networkMid` can appear only once for each network, and a `networkTransactionId` only once in the request.
    - `network` 'visa' | 'mastercard', required: The card network to enroll with.
    - `networkMid` string: The Merchant Identifier (MID) assigned by the merchant's acquirer. Send this when you know the MID.
    - `networkTransactions` object[]: Transactions processed on the MID you want to enroll. Send these when you don't know the MID. Evervault uses them to locate the MID.
      - `networkTransactionId` string, required: The card network transaction ID. Printable ASCII characters only, without spaces.
      - `timestamp` string, date-time: When the transaction happened. Optional. An ISO 8601 date-time with a `Z` or `±hh:mm` offset, no more than five minutes in the future.
    - `description` string: A description of the enrolment. Optional.
  - `externalCustomerReference` string: An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

## Response `201`

Returns a Network Retry Signals Onboarding object with one enrolment for each identifier.

- NetworkRetrySignalsOnboarding
  - `merchant` string, required: The ID of the Evervault Merchant being enrolled.
  - `accounts` NetworkRetrySignalsEnrolment[], required: One enrolment for each identifier in the request, in the same order as `identifiers`.
    - `id` string, required: The unique identifier of the enrolment.
    - `merchant` string, required: The ID of the Evervault Merchant being enrolled.
    - `network` 'visa' | 'mastercard', required: The card network the enrolment is for.
    - `networkMid` string, nullable: The Merchant Identifier (MID) being enrolled. Set when the enrolment was created with a `networkMid`.
    - `networkTransactions` NetworkRetrySignalsTransaction[], nullable: The transactions used to locate the MID. Set when the enrolment was created with `networkTransactions`.
      - `networkTransactionId` string, required: The card network transaction ID.
      - `timestamp` string, date-time: When the transaction happened, if it was sent.
    - `locatedMids` object[], required: The MIDs located from `networkTransactions`, each with its own status. Empty until the card network reports the MIDs that the transactions belong to, and always empty for an enrolment created with a `networkMid`.
      - `networkMid` string, required: The located Merchant Identifier (MID).
      - `description` string, nullable: The description of the enrolment.
      - `status` 'in-progress' | 'success' | 'failed', required: The enrolment status of this MID. Retry signals are sent for the MID once its status is `success`.
    - `description` string, nullable: A description of the merchant being enrolled.
    - `status` 'in-progress' | 'success' | 'failed', required: The status of the enrolment. For an enrolment created with `networkTransactions`, the status is `in-progress` while any located MID is still being enrolled, `success` when at least one located MID succeeded, and `failed` when none can be enrolled.
    - `createdAt` integer, required: The exact time, in epoch milliseconds, when this Enrolment was created.
    - `updatedAt` integer, nullable: The exact time, in epoch milliseconds, when this Enrolment was last updated.
  - `missingForBoarding` object, required: The Merchant attributes that a card network still needs to enroll the Merchant, keyed by network. Empty when nothing is missing. The enrolments are still created. Because an open enrolment can't be sent again, contact Evervault support to complete it after you update the Merchant.

## Other responses

- `400`: The request is invalid. The `fields` attribute points to each invalid attribute.
- `409`: A MID or transaction in the request is already part of an open enrolment. None of the enrolments in the request are created. The pointer shows the identifier.

## Changes

- **2026-11-06** `8d0ca833fa04`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/evervault/apis/evervault-api/changes/payments/network-retry-signals/onboarding/post.md)

---

[API](https://skmtc.dev/evervault/apis/evervault-api.md) - [All operations](https://skmtc.dev/evervault/apis/evervault-api/llms.txt) - [OpenAPI document](https://skmtc.dev/evervault/apis/evervault-api/revisions/8d0ca833fa04?raw)