Skip to main content

Query Partner Policy

POST 
/api/entry/policy

Through this API, institutions can query the current effective commission policy of a registered partner (agent), including the policy method (Buy Rate or Revenue Share), the revenue share allocation between the partner and the institution, the policy template information, and the fee rates of each payment product grouped by payment channel.

Precautions for Using This API:

  1. The query is scoped to the institution identified by institution_no. The partner identified by partner_no must belong to the same institution, otherwise the request will be rejected.
  2. policy_method indicates the commercial model between the partner and the institution: 1 - Buy Rate (the partner purchases payment services at the defined sale price); 2 - Revenue Share (revenue is split between the partner and the institution by the configured ratio).
  3. When policy_method = 1 (Buy Rate), partner_share_percent and institution_share_percent are returned as null. When policy_method = 2 (Revenue Share), the two values are percentage numbers that always add up to 100 (for example 60.00 + 40.00).
  4. Fee rates are returned in a three-level structure: pay_channel_infos (payment channels) → product_infos (payment products under the channel) → rate_infos (fee rate rows of the product). Multiple rows may exist under one product to describe rates for different card types and issuer regions (for example domestic Visa debit vs. international Visa credit).
  5. fee_rate is a percentage string (for example "3.6" means 3.6%). flat_fee is an additional fixed fee charged per transaction on top of the rate (a decimal number with up to 4 decimal places). The charged fee is bounded by fee_min (floor) and fee_capping (capping) when they are configured.
  6. pay_mode_name is a localized JSON string keyed by locale (for example {"en-US":"Visa","zh-CN":"Visa"}). Parse it as JSON and pick the value by the desired locale.
  7. Products without any configured rate row return fee_type = 0 and an empty rate_infos array.
  8. If the partner has no effective policy version yet, the request fails with error code E02710.
  9. The HTTP path is a gateway alias for display purposes. The actual business routing is determined by method=partner.policy.inquiry in the request body together with the configured service_url.
Here is a Java code example
// Build the request with the PayCloud OpenAPI SDK
PartnerPolicyQueryRequest request = new PartnerPolicyQueryRequest();
request.setInstitution_no("100012278");
request.setPartner_no("A2200000184");

// Execute the request through the OpenAPI client; the client fills in the
// gateway envelope (app_id, format, charset, sign_type, sign, version,
// timestamp, method) and verifies the response signature automatically.
// PartnerPolicyQueryResponse response = client.execute(request);

Request​

Responses​

success

Response Headers