---
title: "Get BEP"
method: GET
path: "/bep/{bepKey}"
tags: ["BEP Authentication"]
---

# Get BEP

`GET /bep/{bepKey}`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/bep/{bepKey}`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/bep/:bepKey/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a BEP entity. If it is authenticated, it will contain the authentication information necessary 
to create charges with Bancontact.

Requires the `bep:Get` permission.

## Path parameters

- `bepKey` string, required: Uniquely identifies a BEP authentication request flow.

## Response `200`

The BEP entity

- union
  - BepInitiatedResponse: BEP data which does not include sensitive information.
    - `authenticationStatus` 'initiated', required
    - `key` string, required: Uniquely identifies a BEP authentication request flow.
    - `amount` SchemasAmount, required: An amount encoded as an object with a `value` in minor units and a `currency` code.
      - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero.
      - `currency` 'EUR', required: The three-letter ISO code of the currency. For Bancontact only transactions with currency code `EUR` are allowed.
    - `authenticationMethod` 'bancontactIntent' | 'qrCode', required
    - `created` string, iso-8601-date-time, required: The date and time this BEP authentication was created.
    - `version` integer, required: The version of this object
  - BepSuccessResponse: BEP data which includes the sensitive authentication information.
    - `authenticationStatus` 'authenticated', required
    - `key` string, required: Uniquely identifies a BEP authentication request flow.
    - `amount` SchemasAmount, required: An amount encoded as an object with a `value` in minor units and a `currency` code.
      - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero.
      - `currency` 'EUR', required: The three-letter ISO code of the currency. For Bancontact only transactions with currency code `EUR` are allowed.
    - `card` object, required: Necessary card information to be used in Bancontact authorizations.
      - `expiryMonth` integer, required: The month the card expires. January is 1.
      - `expiryYear` integer, required: The year the card expires including the century.
      - `number` string, password, required: Full digits of a card
    - `bepaf` string, byte, required: BEP authentication factor in base64; the value that is generated upon a successful authentication. The entire bepaf is returned for 45 days after the BEP authentication was created. After that only the part of the bepaf that is required for WIP transactions (the last 5 bytes, base64 encoded) is returned. In both cases the value is in this same field.
    - `authenticationMethod` 'bancontactIntent' | 'qrCode', required
    - `created` string, iso-8601-date-time, required: The date and time this BEP authentication was created.
    - `version` integer, required: The version of this object
  - BepFailResponse: BEP data which does not include sensitive information.
    - `authenticationStatus` 'non-authenticated', required
    - `key` string, required: Uniquely identifies a BEP authentication request flow.
    - `amount` SchemasAmount, required: An amount encoded as an object with a `value` in minor units and a `currency` code.
      - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero.
      - `currency` 'EUR', required: The three-letter ISO code of the currency. For Bancontact only transactions with currency code `EUR` are allowed.
    - `authenticationMethod` 'bancontactIntent' | 'qrCode', required
    - `created` string, iso-8601-date-time, required: The date and time this BEP authentication was created.
    - `version` integer, required: The version of this object

## Other responses

- `400`: Bad Request
- `401`: Authentication Required
- `403`: Forbidden
- `404`: Entity Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)