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
| Scope | What it lets you do |
|---|---|
edi.partner.read | View the partner list and detail |
edi.partner.write | Create / edit partners |
edi.partner.credentials.write | Set / 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
| Field | Notes |
|---|---|
| Display name | Human label. |
| ISA08 | The receiver ID we put on outbound interchanges. |
| ISA07 qualifier | Most commonly ZZ (mutually defined) or 01 (DUNS). |
| Connection type | One of SFTP, AS2, REAL_TIME. |
| Capabilities | Which transactions this partner accepts inbound and produces outbound. |
| Companion guides | Bound guides per transaction (see 7.1 — The editor). |
| Credentials | Held in the vault; UI shows last-rotated dates only. |
| Active | Toggle; disabling a partner stops new outbound traffic but does not block parsing of already-received inbound. |
Steps
Open
/trading-partnersin the edi-app. Click+ New trading partner. The form takes display name, connection type, ISA08, and ISA07 qualifier.Save. The partner record exists; it is inactive until you set credentials and capabilities.
Open the detail page at
/trading-partners/:id. The page has tabs:Tab What you do here Overview Identity, ISA08, status. Connection Transport-specific fields (SFTP host, AS2 URL, real-time endpoint). Capabilities Toggle which transactions this partner supports. Credentials Vault — set / rotate; UI shows last-rotated dates. Companion Guides Bind guides per transaction; resolver chain order. Routing Inbound / outbound routing rules referencing this partner. Activity Recent transaction history. Set the connection under the Connection tab. The form depends on type — see 2.2 — Connection types.
Set credentials under the Credentials tab. Submit-only; the UI never reflects secrets back. See 2.3 — Credential vault & rotation.
Toggle capabilities under the Capabilities tab. Match what the partner agreement specifies. See 2.4 — Capabilities.
Bind companion guides under the Companion Guides tab. For every transaction capability, pick the guide(s) that apply.
Activate the partner with the Overview tab's
Activetoggle.Probe the connection (see 2.5 — Probe & test connection). The partner is not "ready" until probe succeeds.
Submit a test transaction. The exact flow depends on transaction type — see the relevant transaction-category chapter (Claims, Eligibility, Authorizations, Remittance). Use
usageIndicator = TonISA15for 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
| Check | Expected |
|---|---|
Partner appears on /trading-partners | Yes. |
Probe (Test connection) returns success | Yes. |
| 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 row | Yes. |
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| Probe fails with auth error | Wrong credentials | Rotate via Credentials tab. |
| Probe succeeds but outbound stalls | No routing rule has been added that picks this partner | Add a routing rule (Routing tab). |
First test acknowledged but STC01 = A8:nnn (relational error) | Identifiers in the test envelope mismatch what the partner expects | Confirm ISA06/ISA08 and submitter NPI match the agreement. |
Test rejected with TA104 = R and TA105 = 003 | Sender/receiver not authorized at the partner | The partner's intake team has not registered our ISA06 yet. Escalate to them. |