Skip to main content

Onboard a new trading partner

Outcome

A new clearinghouse, state Medicaid MMIS, or commercial payer is registered in the gateway with its ISA08, connection details, capabilities, companion guides, and routing rules — and the first end-to-end test transaction makes a clean round trip.

Prerequisites

ScopeWhat it lets you do
edi.partner.readView the partner list and detail
edi.partner.writeCreate / edit partners
edi.partner.credentials.writeSet / rotate credentials

A signed trading-partner agreement with the counterparty in hand — crucially, the agreed-upon ISA06 / ISA08 qualifier and ID pair for both directions, and the submission window the partner expects.

What a trading partner record carries

FieldNotes
Display nameHuman label.
ISA08The receiver ID we put on outbound interchanges.
ISA07 qualifierMost commonly ZZ (mutually defined) or 01 (DUNS).
Connection typeOne of SFTP, AS2, REAL_TIME.
CapabilitiesWhich transactions this partner accepts inbound and produces outbound.
Companion guidesBound guides per transaction (see 7.1 — The editor).
CredentialsHeld in the vault; UI shows last-rotated dates only.
ActiveToggle; disabling a partner stops new outbound traffic but does not block parsing of already-received inbound.

Steps

  1. Open /trading-partners in the edi-app. Click + New trading partner. The form takes display name, connection type, ISA08, and ISA07 qualifier.

  2. Save. The partner record exists; it is inactive until you set credentials and capabilities.

  3. Open the detail page at /trading-partners/:id. The page has tabs:

    TabWhat you do here
    OverviewIdentity, ISA08, status.
    ConnectionTransport-specific fields (SFTP host, AS2 URL, real-time endpoint).
    CapabilitiesToggle which transactions this partner supports.
    CredentialsVault — set / rotate; UI shows last-rotated dates.
    Companion GuidesBind guides per transaction; resolver chain order.
    RoutingInbound / outbound routing rules referencing this partner.
    ActivityRecent transaction history.
  4. Set the connection under the Connection tab. The form depends on type — see 2.2 — Connection types.

  5. Set credentials under the Credentials tab. Submit-only; the UI never reflects secrets back. See 2.3 — Credential vault & rotation.

  6. Toggle capabilities under the Capabilities tab. Match what the partner agreement specifies. See 2.4 — Capabilities.

  7. Bind companion guides under the Companion Guides tab. For every transaction capability, pick the guide(s) that apply.

  8. Activate the partner with the Overview tab's Active toggle.

  9. Probe the connection (see 2.5 — Probe & test connection). The partner is not "ready" until probe succeeds.

  10. Submit a test transaction. The exact flow depends on transaction type — see the relevant transaction-category chapter (Claims, Eligibility, Authorizations, Remittance). Use usageIndicator = T on ISA15 for the test envelope.

Routing implications

Adding a partner does not by itself route any traffic to it. You must add a submission routing rule that picks this partner for some combination of payer / program / transaction (see Submission routing rules under Claims). Until then, the partner record exists but receives no outbound traffic.

Validation

CheckExpected
Partner appears on /trading-partnersYes.
Probe (Test connection) returns successYes.
First test transaction completes the full round trip (outbound + ack chain)Yes — tracked under /transactions filtered to this partner.
Audit log carries a partner.create rowYes.

Troubleshooting

SymptomCauseFix
Probe fails with auth errorWrong credentialsRotate via Credentials tab.
Probe succeeds but outbound stallsNo routing rule has been added that picks this partnerAdd a routing rule (Routing tab).
First test acknowledged but STC01 = A8:nnn (relational error)Identifiers in the test envelope mismatch what the partner expectsConfirm ISA06/ISA08 and submitter NPI match the agreement.
Test rejected with TA104 = R and TA105 = 003Sender/receiver not authorized at the partnerThe partner's intake team has not registered our ISA06 yet. Escalate to them.

Next

2.2 — Connection types