KOkoin
Payment Services

Get Payment

Changed on

Payment details service.

get/v1/payment/orders/{order_id}

Request

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

Payment details response

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBXSTORE",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    },
    "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"
    }
  },
  "locations": [
    {
      "url": "pix.example.com/qr/9d36b84f-c70b-478f-b95c-12729b90ca25"
    }
  ],
  "payment_method": {
    "expiration_date": "2021-01-01T00:00:00.000Z",
    "payment_key": "sbx@paymentKey"
  },
  "payer": {
    "document": {
      "nationality": "BR"
    },
    "first_name": "Jhon",
    "last_name": "Box",
    "full_name": "Box Jhon",
    "email": "example@dominio.com"
  },
  "provider": {
    "code": "ITAU",
    "payer": {
      "full_name": "Box Jhon",
      "account": {
        "code": "0123456789",
        "type": "CC"
      }
    }
  },
  "refunds": [
    {
      "amount": {
        "currency_code": "BRL",
        "value": 1500.56
      },
      "status": {
        "error": {
          "code": "G01",
          "message": "Gateway, payment method not supported"
        }
      }
    }
  ]
}

Changes

  • 1e3734785750Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

      added the new BNPL enum value to the // response property for the response status

    • info

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

    • info

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

    • info

      removed the CARD enum value from the // response property for the response status

    • info

      removed the PIX enum value from the // response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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