跳到主要内容

Register Partner

POST 
/api/entry/addpartner

Register a new partner for an institution.

Precautions for Using This API:

  1. partner_name is unique within an institution. Leading and trailing spaces are removed before the uniqueness check.
  2. This API only creates partners. Repeating a successful request with the same institution_no and partner_name returns a duplicate-name error instead of updating the existing partner.
  3. template_id is the source partner policy template. PayCloud creates an initial policy version for the new partner from this template.
  4. When is_create_superadmin is 1, contact_name, contact_phone and contact_email are all required. contact_phone and contact_email are sensitive data and are hashed (SHA-256) before storage. contact_email doubles as the login-account email of the created Partner Portal super administrator.
  5. settlement_info is required when allow_settlement_service is 1. It must be sent as a JSON string that parses to a non-empty object containing settlement_params (settlement account fields keyed by the institution template, e.g. account_no / account_holder / account_branch / immediate_payment) and an optional settlement_currency (defaults to ZAR; only ZAR is currently accepted). acc_template_params is generated server-side from the trusted institution template; caller-supplied values with this name are ignored.
  6. Sensitive settlement_params fields flagged by the account template (encrypt_type > 0) must pass the template validation rules and are then transport-encrypted; submit them in the encrypted form required by PayCloud.
  7. fee_vat defaults to the institution configuration partner.vat.default.enable (falls back to 0 when not configured). settlement_cycle defaults to M004 when omitted.
  8. The HTTP path is a documentation-friendly gateway alias. Business routing is determined by method=partner.register and the configured service_url.

Request​

Responses​

success

Response Headers