Temporarily store customer details

Production Environment

https://api.lopay.com

POST

/api/1/partner/customer/tokenise

Customers

Securely stores customer details and returns an ephemeral token that can be passed within payment/subscription link URLs. Tokens cannot be shared between merchants.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

x-merchant-id

string <uuid>

Merchant ID

required

If acting on behalf of a merchant, you will need to specify their merchant ID.

Body Params application/json

name

string

optional

string <email>

optional

Examples

Store name and email addressStore email address

{
    "name": "John Smith",
    "email": "johnsmith@example.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Store name and email addressStore email address

curl --location --request POST 'https://api.lopay.com/api/1/partner/customer/tokenise' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "name": "John Smith",
    "email": "johnsmith@example.com"
}'

Responses

🟢200OK

application/json

OK response

Body

token

string

required

Example

{
    "token": "cdt_632be4213fd45c3641864d26a2220da02bf5b9f0"
}

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-06-04 16:00:16

List all statement activity

Create a new subscription plan