Board a merchant onto an acquirer (synchronous)

Boards the merchant onto an acquirer synchronously and returns the
resulting connection with 201. There is no pending state.

You name an acquirer (your bank relationship) and the
acquirer-assigned merchant_id (MID), plus the
terminal_id (TID) when the acquirer needs one. Fat Zebra validates the MID/TID and currencies
against its config and boards the merchant onto every processor behind
that acquirer that can carry a requested currency — you never name a
processor. Omit currencies to board everything the acquirer supports.

Boarding is idempotent: re-posting the same acquirer returns the
existing connection rather than creating a duplicate.

Failures are reported inline:

  • 422 validation_error — an unsupported currency, a missing
    merchant_id, or no
    processor supports the acquirer for the requested currencies. The
    offending fields are listed under error.fields.
  • 422 processor_error — an underlying processor board was rejected or
    errored upstream.
  • 404 not_found — the acquirer is unknown or not available to this
    partner.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The merchant's username (e.g. acme-store).

Body Params

Board onto an acquirer. Name the acquirer and send the acquirer-assigned
merchant_id (MID); terminal_id (TID) is optional. Fat Zebra validates
the MID/TID and currencies against its config and boards the merchant
onto every supporting processor behind the acquirer — you never name a
processor.

string
required

Required. Acquirer code (e.g. nab).

string
required

The acquirer-assigned MID. Required.

string

The acquirer-assigned TID. Optional. If omitted, Fat Zebra generates
a deterministic 8-character placeholder from the merchant's trading
name (e.g. ACMEC001) and uses it across every processor behind
this acquirer. The generated value is returned on subsequent reads,
and once set — supplied or generated — it is immutable.

currencies
array of strings

Optional. Defaults to every currency the acquirer supports.

currencies
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json