LOGPAY Token API (1.0)

Getting started

This reference is key for your comprehensive understanding of LOGPAY Token Service.

LOGPAY's APIs make use of RESTful conventions when possible and where it makes sense. All calls use the standard HTTP verbs to express access semantics, like GET, POST, PATCH, and DELETE. Other related conventions for our API can be found in the section below.

JSON Conventions

  • Resources are addressable by a UUIDv4 id property.
  • Property names are always in snake_case.
  • The API does not support empty strings. To unset a string value, use an explicit null value instead.
  • Temporal data is encoded in ISO 8601 strings.

Authentication

API keys are supported to authenticate requests.

The keys are passed in via the HTTP header x-api-key.

curl --header 'X-API-Key: <SECRET>' \
  --request POST 'https://test.token.logpay.de/...'

The keys must be handled with care and kept secure. Never hardcode the API keys in your source code, but keep them solely on your backend systems.

API Use

Pagination

Endpoints that return lists of objects support cursor-based pagination requests. By default, the API returns up to 50 objects per API call. If the number of objects in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned objects.

If an endpoint supports pagination, the response body follows this structure:

{
  "current_page": 1,
  "page_size": 50,
  "total_items": 200,
  "total_pages": 4,
  "data": [...]
}

The single pages can be requested with query parameters:

ParameterTypeDescription
limitintegerThe maximum amount of objects to be returned on a page.
pageintegerThe requested number of the page to return.

Request Errors

The API uses the standard errors to indicate the client errors on the service level.

The response payload for processing errors follows a standard format.

{
  "status": "the HTTP status code",
  "classifier": "the classifer of the error",
  "message": "interesting for humans..."
}

Business Errors

The processing errors refer to the primary functions of the LOGPAY Token Service and not necessarily to the related business logic. For example, a failed authorization due to insufficient funds will result in a 200 response, as the payment layer could successfully process the request (even though the business result is negative).

Download OpenAPI description
Overview
Languages
Servers
Sandbox

https://test.token.logpay.de/

PAYONE

Operations

Create LOGPAY Tokens

LOGPAY Tokens are powerful instrument to manage card holder data in a PCI/DSS compliant way.

Compliance as a Service

Achieve PCI / DSS compliance in almost no time using our certified managed compliance service.

No Acquirer Lock-In

Transparently use the cardholder data across all connected processors to implement a non lock-in acquiring setup.

Network Tokens

For every card which is tokenized, network-tokens can be automatically provisioned. This allows for more secure transactions, better conversion, and ultimately lower processing cost.

Operations

Token Management

All cards stored with LOGPAY can be managed via the endpoints in this section.

The CVC2 security code is only kept in an ephemeral cache for a few minutes. The API allows to manage this resource with these endpoints:

  • check if the CVC2 is still availble
  • request a new session to renew the CVC2 with our SDK
  • consume the token after a successful authorization on an external processor
Operations

Delete a token

Request

Remove a Logpay token and all associated information (e.g. network tokens).

Warning

This operation cannot be undone.

Path
idstring(uuid)required

The ID of the LOGPAY token

curl -i -X DELETE \
  'https://test.token.logpay.de/tokens/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success response (No Content)

Response
No content

Callbacks

Token Master Notification
post

Check CVC2

Request

Get an indicator if security information for a stored LOGPAY token is still available.

Path
idstring(uuid)required

The ID of the LOGPAY token

curl -i -X GET \
  'https://test.token.logpay.de/tokens/{id}/security-code' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
security_code_availableboolean

Security Data available in the system

Response
application/json
{ "security_code_available": true }

Refresh CVC2

Request

Create a session to update the Security Code from a LOGPAY Token using our SDK.

Path
idstring(uuid)required

The ID of the LOGPAY token

curl -i -X POST \
  'https://test.token.logpay.de/tokens/{id}/refresh-session' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
session_idstring(uuid)required

The ID of the session which needs to be used to initialize the SDK.

Response
application/json
{ "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82" }

Network Tokens

LOGPAY supports Network Tokens with major card schemes.

The lifecycle of network tokens is automatically managed. When activated a network token is automatically provisioned and maintained through its life-cycle.

The use of Network Tokens requires prior activation by your account manager.

Operations