Skip to navigation
TIANKII API - API KeyPayment RequestsGeneral Operations

Complete payment request

View as Markdown

Complete payment request

Transitions payment request :id to the COMPLETED status (numeric 1). This is only allowed when the request is currently in an updatable state — ACTIVE (3) or PENDING (0). If the request is in any other state, the API responds with 400 Bad Request (Payment Request <id> cannot be marked as completed because it is not in a valid state.). The request must belong to the store resolved from the API key.

Authentication

Send the merchant API key in x-api-key. Requires scope Merchant.payment_link.update.

Path parameters

  • id — payment request id.

There is no request body. Returns the updated payment request shaped by its type.

Notas: Handler: lifecycleService.markAsComplete. Only valid from ACTIVE or PENDING; otherwise 400. Accepts deprecated aliases PATCH /v1/payment-links/:id/complete and PATCH /v1/payment-link/:id/completed.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the payment request to mark as complete.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.