KOkoin
Payment Services

Capture Payment

Changed on

Service responsible for capturing a card payment

post/v1/payment/orders/{order_id}/capture

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/orders/{order_id}/capture
  • 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

Capture response

order_idstring required

Order ID returned by create payment service

country_codestring

Transaction country code.

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    },
    "provider_reference": {
      "order_id": "20000000000000026628140042292",
      "payment_id": "E0036030520211216092957cb99ed693"
    }
  },
  "order_id": "9dd3f765-a51a-49d8-b6af-a51d5a0b3f7f",
  "status": {
    "error": {
      "code": "G01",
      "message": "Gateway, payment method not supported"
    }
  },
  "country_code": "BR"
}

Changes

  • 1e3734785750Revision changes
    • info

      the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status