Skip to main content
API docs by Redocly

Wallet API (v3)

Download OpenAPI specification:Download

License: Purse

Customer's wallet

Wallet API V3

Get tokens of a customer

Authorizations:
purse_oauth2
path Parameters
merchant_id
required
string
customer_reference
required
string
query Parameters
status
string
Enum: "ACTIVE" "INACTIVE" "ARCHIVED"
origin
string
Enum: "partner" "pci_proxy" "purse"

Responses

Response samples

Content type
application/json
{
  • "tokens": [
    ],
  • "shared_wallet_user": true,
  • "total_elements": 0
}

Add a token to the customer's wallet

Authorizations:
purse_oauth2
path Parameters
merchant_id
required
string
customer_reference
required
string
header Parameters
x-idempotency-key
string
Default:
Authorization
string
Request Body schema: application/json
required
token
required
string non-empty
fingerprint
string
pin_code
string
expiration_date
required
string <date-time>
required
object (TokenDescription)
required
object (TokenScopeV3)

Scope of the token

reason
string
label
string^[a-zA-Z0-9 ]{0,25}$

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "fingerprint": "string",
  • "pin_code": "string",
  • "expiration_date": "2019-08-24T14:15:22Z",
  • "description": {
    },
  • "scope": {
    },
  • "reason": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fingerprint": "string",
  • "pin_code": "string",
  • "expiration_date": "2019-08-24T14:15:22Z",
  • "customer_reference": "string",
  • "merchant_id": "string",
  • "status": "ACTIVE",
  • "description": {
    },
  • "scope": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "value": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "favorite": true,
  • "label": "string",
  • "source": "MERCHANT",
  • "savable_to_shared_wallet": true
}

Delete all tokens of a customer

Authorizations:
purse_oauth2
path Parameters
merchant_id
required
string
customer_reference
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Update the status of a token

Authorizations:
purse_oauth2
path Parameters
merchant_id
required
string
customer_reference
required
string
id
required
string <uuid>
Request Body schema: application/json
required
status
required
string
Enum: "ACTIVE" "INACTIVE" "ARCHIVED"
reason
string

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "reason": "string"
}

Get token count of a customer

Authorizations:
purse_oauth2
path Parameters
merchant_id
required
string
customer_reference
required
string
query Parameters
status
string
Enum: "ACTIVE" "INACTIVE" "ARCHIVED"

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Delete one single token of a customer

Authorizations:
purse_oauth2
path Parameters
merchant_id
required
string
customer_reference
required
string
id
required
string <uuid>
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"