Skip to content

/meds/{medId}/evidence-requirements Endpoint ​

Background ​

/meds/{medId}/evidence-requirements returns the evidence requirement list currently applied to a MED and its upload completion state.

Adopay identifies the industry and merchant type the MED belongs to from medId, then matches the corresponding requirement list (common materials + industry-specific materials; platform/PSP merchants additionally receive the platform-related materials below). Each MED uses exactly one requirement list; the merchant does not need to, and cannot, specify the industry or merchant type in the request.

Endpoint ​

ItemValue
MethodGET
Path/meds/{medId}/evidence-requirements
Content-Typeapplication/json
PurposeRetrieve the evidence requirement list and completion state for a MED

Authentication ​

Use ES256 request signing and include all five required headers: X-Merchant-Id, X-Timestamp, X-Nonce, Digest, and Authorization. Set X-Merchant-Id to the merchant number and keyId to the key version, v1 by default. The signature is the DER-encoded ECDSA signature encoded with standard Base64. See Request Signing.

Generate the timestamp, nonce, digest, and signature placeholders for each actual request. The canonical string includes the actual path and raw query; sign again when pagination or filter parameters change.

Request Fields ​

FieldLocationTypeRequiredDescription
medIdPathstringYesUnique identifier of the MED infraction report (the platform case number, medc prefix + digits), maximum length 64 characters.

Request Example ​

http
GET /meds/medc2874510938274639021/evidence-requirements HTTP/1.1
Accept: application/json
X-Merchant-Id: <MERCHANT_ID>
X-Timestamp: <UNIX_TIMESTAMP_SECONDS>
X-Nonce: <UNIQUE_NONCE>
Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
Authorization: Signature keyId="v1",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="<ES256_SIGNATURE_BASE64>"

Response Fields ​

The endpoint uses the standard status, msg, and data response envelope. The evidence requirements are returned in data; the template codes and versions used internally by Adopay are not returned.

FieldTypeReturnedDescription
statusintYesResponse code
msgstringYesResponse message corresponding to status.
dataobjectOn successEvidence requirements for the MED; may be omitted when signature or protocol parsing fails.
data.medIdstringYesUnique identifier of the MED.
data.industrystringYesThe industry the MED belongs to: ADVERTISING, DIGITAL_CONTENT, ECOMMERCE, EDUCATION, FINANCIAL_SERVICES, GAMING, LOGISTICS, OTHER, PROFESSIONAL_SERVICES, or SAAS.
data.completebooleanYesWhether every required (REQUIRED) item for the current MED already has a corresponding uploaded file; CONDITIONAL items are not counted.
data.requirementsarrayYesEvidence requirements currently applied to the MED (common materials + industry-specific materials; platform/PSP merchants additionally receive the platform-related materials).
data.requirements[].evidenceTypestringYesEvidence type; see Industries and Evidence below.
data.requirements[].requirementLevelstringYesRequirement level: REQUIRED, CONDITIONAL, RECOMMENDED, or OPTIONAL.
data.requirements[].requirementDescriptionstringYesRequirement description returned by the API in Chinese, such as “必填” (required), “建议” (recommended), or “如发生退款则应提供,可上传截图” (provide if a refund occurred; screenshots acceptable).
data.requirements[].requiredbooleanYesWhether the item must be submitted this time: true when requirementLevel is REQUIRED; CONDITIONAL items are informational only and not enforced, always false.
data.requirements[].uploadedFileCountintYesNumber of valid files uploaded so far and classified under this evidence type.

Response Example ​

json
{
  "status": 200,
  "msg": "sucesso",
  "data": {
    "medId": "medc2874510938274639021",
    "industry": "GAMING",
    "complete": false,
    "requirements": [
      {
        "evidenceType": "TRANSACTION_AUTHENTICITY_STATEMENT",
        "requirementLevel": "REQUIRED",
        "requirementDescription": "必填",
        "required": true,
        "uploadedFileCount": 1
      },
      {
        "evidenceType": "MERCHANT_ORDER_RECORD",
        "requirementLevel": "REQUIRED",
        "requirementDescription": "必填",
        "required": true,
        "uploadedFileCount": 0
      }
    ]
  }
}

Industries and Evidence ​

A requirement list consists of common materials and industry-specific materials; platform (platform) and PSP (psp) merchants additionally receive platform-related materials (see below). Materials are returned in the platform-configured order; the Requirement column in each table corresponds to requirementLevel and requirementDescription in the response.

Requirement Levels ​

requirementLevelDescriptionAffects data.complete
REQUIREDRequired materials.Yes
CONDITIONALRecommended to submit when the scenario described by requirementDescription applies; the platform cannot automatically determine the trigger condition, so it is informational only and not enforced.No
RECOMMENDEDRecommended to submit; helps Adopay's review.No
OPTIONALOptional materials.No

Common Materials (All Merchants) ​

evidenceTypeMaterialRequirement
TRANSACTION_AUTHENTICITY_STATEMENTTransaction authenticity statementRequired
MERCHANT_ORDER_RECORDMerchant order / business order recordRequired
CUSTOMER_IDENTIFIERCustomer identifierRequired
PRODUCT_SERVICE_CONTENTProduct or service contentRequired
DELIVERY_PROOFFulfillment / service delivery proofRequired
OTHERSOther evidenceOptional; use when no category fits

The Advertising (ADVERTISING), Education (EDUCATION), Financial Services (FINANCIAL_SERVICES), Logistics (LOGISTICS), Other (OTHER) industries only require the common materials above.

Physical Goods / E-commerce (PHYSICAL GOODS / ECOMMERCE) ​

Industry-specific materials:

evidenceTypeMaterialRequirement
FULFILLMENT_RECORDFulfillment (shipment) recordRequired
LOGISTICS_TRACKINGLogistics tracking number / tracking infoRequired (screenshots acceptable)
DELIVERY_CONFIRMATIONDelivery confirmation (proof of receipt)Recommended
USER_COMMUNICATION_RECORDUser communication recordRecommended
RETURN_REFUND_RECORDReturn / refund recordConditional: provide if a return/refund occurred (screenshots acceptable)

Digital Goods / Digital Content (DIGITAL GOODS) ​

Industry-specific materials:

evidenceTypeMaterialRequirement
USER_ACCOUNT_RECORDUser account (game account / subscription account)Required
SERVICE_ACTIVATION_RECORDService activation recordRequired
CONTENT_USAGE_RECORDContent usage recordRequired
LOGIN_IP_DEVICE_RECORDLogin record / IP / deviceRecommended
SUBSCRIPTION_PERIODSubscription periodRecommended
USER_COMMUNICATION_RECORDUser communication recordRecommended
CANCELLATION_REFUND_RECORDCancellation / refund recordConditional: provide if a subscription cancellation/refund occurred (screenshots acceptable)
AUTO_RENEWAL_AUTHORIZATIONAuto-renewal authorization recordConditional: required for auto-renewal disputes (screenshots acceptable)

Gaming (GAMING) ​

Industry-specific materials:

evidenceTypeMaterialRequirement
USER_ACCOUNT_RECORDUser account (game account / subscription account)Required
TOP_UP_PURCHASE_RECORDTop-up / purchase recordRequired
VIRTUAL_ASSET_DELIVERY_RECORDVirtual currency / item entitlement delivery recordRequired
CONSUMPTION_USAGE_RECORDConsumption / usage recordRecommended
LOGIN_IP_DEVICE_RECORDLogin record / IP / deviceRecommended; required for unauthorized/fraud-type disputes
USER_TRANSACTION_HISTORYUser transaction historyRecommended

When the dispute type (originSituationType) is SCAM_FRAUD, UNAUTHORIZED_TRANSACTION, or FRAUDULENT_ACCESS_AND_AUTHORIZATION, LOGIN_IP_DEVICE_RECORD is upgraded from Recommended to Required.

Services (SERVICES) ​

Industry-specific materials:

evidenceTypeMaterialRequirement
INVOICEInvoiceRequired
CONTRACT_ORDER_AGREEMENTService contract / order agreementRequired
SERVICE_DELIVERY_RECORDService delivery recordRequired
SERVICE_ACCEPTANCE_RECORDService acceptance recordRecommended
COMMUNICATION_RECORDProject communication recordRecommended
PARTNERSHIP_TRANSACTION_HISTORYPartnership historyRecommended
REFUND_REVERSAL_RECORDRefund / reversal recordConditional: provide if a refund/reversal occurred (screenshots acceptable)

SaaS / Subscription (SAAS / SUBSCRIPTION) ​

Industry-specific materials:

evidenceTypeMaterialRequirement
USER_COMPANY_ACCOUNTUser ID / company accountRequired
SERVICE_ACTIVATION_RECORDService activation recordRequired
LOGIN_USAGE_RECORDLogin / usage recordRequired
FEATURE_USAGE_LOGFeature usage logRecommended
IP_DEVICE_RECORDIP / deviceRecommended
PRODUCT_PLAN_INFORMATIONProduct plan / subscription planRecommended
CANCELLATION_REFUND_RECORDCancellation / refund recordConditional: provide if a cancellation/refund occurred (screenshots acceptable)

Platform / PSP (PLATFORM / PSP) ​

In addition to the common materials and the industry-specific materials of their industry, platform (platform) and PSP (psp) merchants must also provide the following:

evidenceTypeMaterialRequirement
ACTUAL_MERCHANT_INFOActual merchant information / Merchant IDRequired
PLATFORM_TRANSACTION_RECORDPlatform transaction recordRequired
DOWNSTREAM_MERCHANT_ORDERDownstream merchant orderRequired
SETTLEMENT_SPLIT_RECORDMerchant settlement / split recordRecommended
USER_COMMUNICATION_RECORDUser communication recordRecommended
DOWNSTREAM_TRANSACTION_HISTORYDownstream merchant transaction historyRecommended
REFUND_RECORDRefund recordConditional: provide if a refund occurred (screenshots acceptable)
OTHERSOther evidenceOptional; use when no category fits

USER_COMMUNICATION_RECORD is returned only for industries whose industry-specific materials do not already include a user communication record; it is never listed twice.

Requirement List Matching Rules ​

  1. Adopay determines the industry and merchant type the MED belongs to from medId; each MED uses exactly one requirement list, and the merchant neither needs to nor can specify them in the request.
  2. Requirement list = common materials + the industry-specific materials of the industry; platform and PSP merchants additionally receive the platform-related materials. For the gaming industry, the requirement level of individual materials is also adjusted by dispute type (see Gaming above).
  3. The list content and display order are maintained by platform configuration and may change; the response returned by the API always prevails. Template codes, template versions, and the matching process are internal Adopay information and are not returned in API responses.

Business Rules ​

  • The merchant cannot override the MED's industry through request parameters.
  • uploadedFileCount counts only files that passed file validation and have been classified under the corresponding evidenceType.
  • Use OTHERS for supplemental evidence that cannot be clearly classified; this type is optional and does not affect data.complete.
  • complete only indicates whether every required (REQUIRED) item already has a corresponding uploaded file; CONDITIONAL, RECOMMENDED, and OPTIONAL items are not counted. Evidence completeness is enforced only for REJECTED (reject) verdicts; an ACCEPTED (accept) verdict requires no evidence files. MED status, permission, concurrency, and other business validations are still performed when the analysis is submitted.
  • Evidence uploads and submissions must be completed before the evidence submission deadline (dueTime); after the deadline, both the upload and submission endpoints reject requests.
  • The final submission requirements are subject to the server-side validation result when the submit-analysis endpoint is called.

Back to MED API Overview