KOkoin
Payment Services

Cancel Payment

Changed on

Cancellation payment. Card, Pix and BNPL payment method can be cancelled, for Pix payment method, you can only cancel dynamic QR payments; for the card payment method, you can cancel Opened or Authorized payments, which will remain with the status Canceled or Voided respectively.

put/v1/payment/orders/{order_id}/cancel

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/orders/{order_id}/cancel
  • Auth
    none declared. Required headers: Content-Type, Accept

Path parameters

order_idstring required

Order ID returned by create payment service

Headers

Content-Typestring required

The Media type of the body of the request. Default value for payment provider protocol is application/json

Acceptstring required

Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json

Response

Cancel payment response

order_idstring required

Order ID returned by create payment service

codestring

Standardized error code (applies only for error cases)

messagestring

Message associated with the error code (applies only for error cases)

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "provider_reference": {
      "order_id": "6a5f5159-c5dc-43b2-b3d4-34471d9be94c",
      "payment_id": "82106789179776-1"
    }
  },
  "order_id": "9dd3f765-a51a-49d8-b6af-a51d5a0b3f7f",
  "status": {
    "error": {
      "code": "G01",
      "message": "Gateway, payment method not supported"
    }
  }
}

Changes

  • 1e3734785750Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status