Skip to main content
POST
Report credential result
Clink uses the report to close the order and the instruction usage. A report records what the merchant page showed; it does not execute or verify the payment.
This is the payment result confirmation endpoint. It is the only entry point for confirming or reporting a transaction result; there is no separate confirm-transaction API. Use it to report the final outcome, including after an UNKNOWN report, within the 24-hour reporting window described below.

Reporting rules

  • Clink accepts a terminal result until report_deadline, 24 hours after the credential is issued. A report after the window returns 410 with code 71211018 (report_window_expired).
  • A usage that does not exist, or does not belong to the token’s customer, returns 404.
  • Clink compares terminal results in two classes: SUCCEEDED is success; FAILED and NOT_SUBMITTED are both failure. Repeating a result in the same class returns the recorded result with HTTP 200; for example, reporting FAILED after NOT_SUBMITTED does not conflict. Reporting the other class after a terminal result is recorded returns 409 with code 71211017 (result_already_reported).
  • SUCCEEDED, FAILED, and NOT_SUBMITTED close the usage and are delivered to Clink’s existing payment-result pipeline.
  • UNKNOWN records no terminal result, publishes no result message, and returns PENDING; report the final outcome before report_deadline.
  • paid_amount and currency_code must be sent together. When paid_amount differs from the authorized amount, Clink records paid_amount_mismatch: true and keeps the authorized amount.

Authorizations

Authorization
string
header
required

Portal user token from POST /agent/cwallet/platform/portal/tokens. Reads require portal:read; writes require portal:write.

Body

application/json
client_reference_id
string
required

Value used when requesting the credential. Clink finds the usage by this value for the token's customer.

Example:

"platform-ref-001"

outcome
enum<string>
required

SUCCEEDED: the merchant explicitly confirmed that the payment succeeded. FAILED: the merchant explicitly showed failure after the card was submitted. NOT_SUBMITTED: the card was never submitted. UNKNOWN: the card was submitted, but the result cannot be determined; Clink returns PENDING with report_deadline.

Available options:
SUCCEEDED,
FAILED,
NOT_SUBMITTED,
UNKNOWN
Example:

"SUCCEEDED"

paid_amount
string

Amount shown by the merchant, decimal string in major currency units. Must be paired with currency_code.

Example:

"12.50"

currency_code
string

Three-letter currency code. Must be paired with paid_amount.

Example:

"USD"

failure_reason
enum<string>

Reason for a failed or unsubmitted payment. Accepted only with FAILED or NOT_SUBMITTED.

Available options:
CARD_DECLINED,
AUTHENTICATION_REQUIRED,
AMOUNT_CHANGED,
CREDENTIAL_EXPIRED,
CREDENTIAL_LOST,
MERCHANT_ERROR,
BUYER_CANCELLED,
OTHER

Response

Success

code
integer<int32>

200 on success.

Example:

200

msg
string

Result message.

Example:

"Success"

data
object