Skip to main content
Version: 3.0.0 (current)

Get token

GET /v3/token/:tokenId

Get a tokenized payment method.

Path Parameters
  • tokenId string required

    Format: UUID. The tokenId is retrieved from data.tokenization.tokenId on a completed session with intent: "payment_tokenize" or "payment_tokenize_and_charge".

    Example: c5674f4f-7e84-405c-a44b-c83736bb7209
Header Parameters
  • Accept string

    Possible values: [application/json]

  • Authorization string

    Format: "Basic <base64(username:secret)>"

Responses
Schema
  • tokenId string
  • initialSessionId string
  • state string

    Possible values: [active, inactive]

  • country country

    Country code in ISO 3166-1 alpha-2 format.

  • locale locale

    Locale in "sv-se" / "en-gb" format.

  • product object
  • type string

    Possible values: [payment, signup]

    Type of Briqpay product.

  • id string deprecated

    Provide this if you have created an alternate variant configuration in the backoffice that you want to use.

  • variantId string

    Provide this if you have created an alternate variant configuration in the backoffice that you want to use.

  • customerType customerType

    Possible values: [business, consumer]

    Which type of customer this session is for.

  • expiryDate string
  • createdAt string
  • paymentMethod object
  • pspId string
  • name string
  • category string
  • pspDisplayName string
  • chargeSessions object[]
  • Array [
  • sessionId string
  • completedAt string
  • order object
  • amountIncVat integer
  • amountExVat integer
  • currency string
  • ]
  • data
  • company object
  • cin cin

    Company identification number. Example formats:
    Sweden: Orgnr / VAT
    Norway: Orgnr / VAT
    Denmark: CVR / VAT
    Finland: Business ID / VAT
    Germany: HRB / VAT
    Netherlands: KVK / VAT
    France: SIREN / SIRET / VAT
    United Kingdom: CRN
    United States: EIN

  • name string

    Company name.

  • consumer object
  • dateOfBirth string

    Date of birth (YYYY-MM-DD).

  • name string

    Name of the person.

  • billing object
  • companyName string

    B2B only.

  • cin cin

    Company identification number. Example formats:
    Sweden: Orgnr / VAT
    Norway: Orgnr / VAT
    Denmark: CVR / VAT
    Finland: Business ID / VAT
    Germany: HRB / VAT
    Netherlands: KVK / VAT
    France: SIREN / SIRET / VAT
    United Kingdom: CRN
    United States: EIN

  • streetAddress string
  • streetAddress2 string
  • zip string
  • city string
  • region string

    State / region. Example: "CA" for California in the US.

  • firstName string
  • lastName string
  • email string
  • phoneNumber string
  • country country

    Country code in ISO 3166-1 alpha-2 format.

  • shipping object
  • companyName string

    B2B only.

  • cin cin

    Company identification number. Example formats:
    Sweden: Orgnr / VAT
    Norway: Orgnr / VAT
    Denmark: CVR / VAT
    Finland: Business ID / VAT
    Germany: HRB / VAT
    Netherlands: KVK / VAT
    France: SIREN / SIRET / VAT
    United Kingdom: CRN
    United States: EIN

  • streetAddress string
  • streetAddress2 string
  • zip string
  • city string
  • region string

    State / region. Example: "CA" for California in the US.

  • firstName string
  • lastName string
  • email string
  • phoneNumber string
  • country country

    Country code in ISO 3166-1 alpha-2 format.

Loading...