Authorize a transaction in a payment terminal

Before you start a sale transaction in mobile app using the transaction API endpoint, make sure you have the following:

✅ API key issued by Xplor Pay.

✅ Mobile JSON Web Token (mobilejwt) returned by the successfulTransactionToken method using the JavaScript SDK integration.

To create a multi-use or durable card token (token-id) when authorizing a transaction in a payment terminal:

1. Add the create-token field with a value of true to the request body when calling the semi-integrated transaction API endpoint to authorize a transaction in payment terminal.

{
    "type": "auth",
    "amount": "0.00",
    "create-token": "true"
}

1. Use the POST method to call the rest/v2/terminal/transactions/auth endpoint.

The API returns the following response:

{
    "code": "200",
    "status": "success",
    "exchange-id": "ID-clearent-transaction-emv-1-944b0307-7f55-4652-86c4-64def4ab9d9a",
    "links": [
        {
            "rel": "token",
            "href": "/rest/v2/tokens/1100005972788980011",
            "id": "1100005972788980011"
        }
    ],
    "payload": {
        "tokenResponse": {
            "token-id": "1100005972788980011",
            "times-used": "0",
            "status": "Active",
            "created": "2025-05-08T19:26:17.263Z",
            "updated": "2025-05-08T19:26:17.277Z",
            "exp-date": "1231",
            "last-four-digits": "0011",
            "card-type": "VISA",
            "software-vendor-name": "Token",
            "merchant-id": "YOUR MID",
            "token-status": "Open",
            "customer-first-name": "Test Card 01      ",
            "customer-last-name": "UAT USA"
        },
        "payloadType": "token"
    }
}

The API response includes payload object with the following field:

Name	Data type	Description
token-id	String	The unique identifier for the created multi-use or durable card token.

See Authorize a transaction endpoint response for more information.