For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Card tokenization

Create, update, retrieve, and delete a payment token.

Important: For authentication, you must include the required HTTPS headers in each request. For more information about the authentication HTTPS headers, see Authenticating Your Requests.

Create a payment token

Endpoints

Environment	HTTP Method	URL
Sandbox	POST	https://api.pit.paygateway.com/tokenization/cardtokens
Production	POST	https://api.paygateway.com/tokenization/cardtokens

Sample request

Content-Type: application/json
Authorization: AuthToken {AuthTokenV2}
X-GP-Request-Id: {request_id}
X-GP-Version: 2021-04-08
X-GP-Api-Key: {API Key}
X-GP-Source-App-Version: {Version of integrating application}
X-GP-Source-App-Name: {Name of integrating application}
{
  "card": {
    "card_number": "4012888888881881",        
    "expiry_month": "03",
    "expiry_year": "23"  
  }
}

Sample response

{
    "transaction_id": "000000002271",
    "status": "Approved",
    "card": {
        "masked_card_number": "401288XXXXXX1881",
        "expiry_month": "03",
        "expiry_year": "23",
        "token": "11nhqBgdJm",
        "type": "Visa"
    },
    "payment": {
        "type": "Credit"
    }
}

Update a payment token

Endpoints

Environment	HTTP Method	URL
Partner Integration Test	PATCH	https://api.pit.paygateway.com/tokenization/cardtokens/{token}
Production	PATCH	https://api.paygateway.com/tokenization/cardtokens/{token}

Sample request

Content-Type: application/json
Authorization: AuthToken {AuthTokenV2}
X-GP-Request-Id: {request_id}
X-GP-Version: 2021-04-08
X-GP-Api-Key: {API Key}
X-GP-Source-App-Version: {Version of integrating application}
X-GP-Source-App-Name: {Name of integrating application}
{
  "card": {
    "card_number": "4012888888881881",        
    "expiry_month": "03",
    "expiry_year": "23"  
  }
}

Sample response

{
    "transaction_id": "000000002271",
    "status": "Approved",
    "card": {
        "masked_card_number": "401288XXXXXX1881",
        "expiry_month": "03",
        "expiry_year": "23",
        "token": "11nhqBgdJm",
        "type": "Visa"
    },
    "payment": {
        "type": "Credit"
    }
}

Retrieve a payment token

Endpoints

Environment	HTTP Method	URL
Partner Integration Test	GET	https://api.pit.paygateway.com/tokenization/cardtokens/{token}
Production	GET	https://api.paygateway.com/tokenization/cardtokens/{token}

Sample request

GET /tokenization/cardtokens/11nhqBgdJm

Sample response

{
    "transaction_id": "000000002273",
    "status": "Approved",
    "card": {
        "masked_card_number": "401288XXXXXX1881",
        "expiry_month": "03",
        "expiry_year": "23",
        "type": "Visa"
    },
    "payment": {
        "type": "Credit"
    }
}

Delete a payment token

Endpoints

Environment	HTTP Method	URL
Partner Integration Test	DELETE	https://api.pit.paygateway.com/tokenization/cardtokens/{token}
Production	DELETE	https://api.paygateway.com/tokenization/cardtokens/{token}

Sample request

DELETE /tokenization/cardtokens/11nhqBgdJm

Sample response

{
    "transaction_id": "000000002274",
    "status": "Approved"
}