Deactivate token
DELETE /v3/token/:tokenId
Deactivate 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)>"
- 200
- 204
- 400
- 403
- application/json
- Schema
- Example (from schema)
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 stringPossible values: [
payment
,signup
]Type of Briqpay product.
id stringProvide this if you have created an alternate product 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 stringname stringcategory stringpspDisplayName stringchargeSessions object[]
Array [sessionId stringcompletedAt stringorder object
amountIncVat integeramountExVat integercurrency string]data
company object
cin cinCompany identification number. Example formats:
Sweden: Orgnr
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: EINname stringCompany name.
consumer object
dateOfBirth stringDate of birth (YYYY-MM-DD).
name stringName of the person.
billing object
companyName stringB2B only.
cin cinCompany identification number. Example formats:
Sweden: Orgnr
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: EINstreetAddress stringstreetAddress2 stringzip stringcity stringregion stringState / region. Example: "CA" for California in the US.
firstName stringlastName stringemail stringphoneNumber stringcountry countryCountry code in ISO 3166-1 alpha-2 format.
shipping object
companyName stringB2B only.
cin cinCompany identification number. Example formats:
Sweden: Orgnr
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: EINstreetAddress stringstreetAddress2 stringzip stringcity stringregion stringState / region. Example: "CA" for California in the US.
firstName stringlastName stringemail stringphoneNumber stringcountry countryCountry code in ISO 3166-1 alpha-2 format.
{
"tokenId": "string",
"initialSessionId": "string",
"state": "active",
"country": "SE",
"locale": "sv-se",
"product": {
"type": "payment",
"id": "a8a7acb2-4c65-4a91-a8e5-d8125bf64fd4"
},
"customerType": "business",
"expiryDate": "string",
"createdAt": "string",
"paymentMethod": {
"pspId": "string",
"name": "string",
"category": "string",
"pspDisplayName": "string"
},
"chargeSessions": [
{
"sessionId": "string",
"completedAt": "string",
"order": {
"amountIncVat": 0,
"amountExVat": 0,
"currency": "string"
}
}
],
"data": {
"company": {
"cin": "0123456789",
"name": "Example Company"
},
"consumer": {
"dateOfBirth": "1970-01-01",
"name": "John Smith"
},
"billing": {
"companyName": "string",
"cin": "0123456789",
"streetAddress": "string",
"streetAddress2": "string",
"zip": "string",
"city": "string",
"region": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"country": "SE"
},
"shipping": {
"companyName": "string",
"cin": "0123456789",
"streetAddress": "string",
"streetAddress2": "string",
"zip": "string",
"city": "string",
"region": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"country": "SE"
}
}
}
- application/json
- Schema
- Example (from schema)
Schema
error object
code stringPossible values: [
INVALID_CREDENTIALS
,INVALID_DATA
,OPERATION_NOT_SUPPORTED
,UNKNOWN
]message string
{
"error": {
"code": "INVALID_CREDENTIALS",
"message": "string"
}
}
- application/json
- Schema
- Example (from schema)
Schema
error object
code stringPossible values: [
INVALID_CREDENTIALS
,INVALID_API_KEY
,AUTH_SECRET_EXPIRED
]message string
{
"error": {
"code": "INVALID_CREDENTIALS",
"message": "string"
}
}