Acquirer connections

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.
post/merchants/{username}/acquirers

Request

  • Base URL
    https://gateway.pmnts.io/v2/partners
  • URL
    https://gateway.pmnts.io/v2/partners/merchants/{username}/acquirers
  • Auth
    HTTP basic

Request body

acquirerstring required

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

merchant_idstring required

The acquirer-assigned MID. Required.

terminal_idstring

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.

currenciesstring[]

Optional. Defaults to every currency the acquirer supports.

Example request

{
  "acquirer": "nab",
  "merchant_id": "MID0012345",
  "terminal_id": "12345678",
  "currencies": [
    "AUD"
  ]
}

Response

The boarded connection.

acquirer_namestring nullable required

The acquirer's display name (e.g. NAB).

merchant_idstring nullable

The acquirer-assigned MID (e.g. ent_a1b2c3d4).

terminal_idstring nullable

The acquirer-assigned TID (e.g. T0001), or a Fat Zebra-generated 8-character placeholder (e.g. ACMEC001) if none was supplied at board time. Immutable once set.

currenciesstring[]

Currencies the connection can transact.

schemesstring[]

Networks the merchant can transact for this acquirer.

modesstring[]

Transaction modes the connection supports.

walletsstring[]

Wallets the connection accepts.

three_ds_enabledboolean

Whether a boarded processor for this acquirer supports 3DS.

status'enabled' | 'disabled' required

Routing toggle across the underlying links — disable to turn the connection off without deleting it.

Changes

No recorded changes to this operation across all 1 revision of this API.