Skip to main content
Institution APIs include dedicated institution endpoints and a full set of institution merchant APIs exposed under institution-prefixed paths. For the signature algorithm and verification rules, see Security and Signature.

Request headers

Endpoints that do NOT require X-GatePay-On-Behalf-Of

The following dedicated institution APIs are institution master-account–scoped. Do not send X-GatePay-On-Behalf-Of in the request header; the first four common headers are sufficient: Accounts
  • Create sub-account
  • Query sub-account
  • List sub-accounts (paginated)
Charge APIs, transfer APIs, and institution merchant APIs must include X-GatePay-On-Behalf-Of. Institution merchant APIs typically use the target sub-account ID; charge and transfer APIs can use the initiating account ID for the current transaction (either an institution account ID or a sub-account ID). Account APIs and fee-setting APIs do not use this header.