Partner Connections

Merchants an admin approved that you have not collected yet

The other half of the review flow.

When a merchant connects a business they already had, the link waits for a SwiftPayIQ admin. That decision happens out of band, days after the merchant consented, so there is no redirect to carry a code back to you. This is where your server finds out.

Each entry carries a fresh one-time code. Swap it at /partner/connections/exchange exactly as you would one that arrived by redirect.

Codes are minted per call and live five minutes, so call this when you are ready to exchange rather than on a slow timer. An entry disappears once you hold a key for that merchant, so a run that fails halfway is safe to repeat — you will simply be offered the ones you did not finish.

An empty array means nothing is waiting. Poll it a few times a day, or when the PARTNER_CONNECTION_READY notification reaches your SwiftPayIQ inbox.

get/partner/connections/pending

Request

  • Base URL: https://api.swiftpayiq.com/api/v1
  • URL: https://api.swiftpayiq.com/api/v1/partner/connections/pending
  • Auth: HTTP bearer

Response

Approved merchants awaiting collection. Empty when there are none.

businessIdstring required
businessNamestring required

English trading name where there is one, otherwise Arabic.

codestring required

One-time code. Swap it at /partner/connections/exchange.

scopesstring[] required

What the merchant granted, frozen at consent.

expiresAtstring date-time required

Five minutes out. Ask again if you miss it — nothing is lost.

Changes

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