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.

Tokenization

Create a payment token

Endpoints

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

Request

Object	Parameter	Type	Size	Description
card	card_number	String	13-19	Primary account number (PAN) on the payment card.
expiry_month	String	2	Month that the card expires, in MM format. If our gateway cannot return an expiry month, it returns a value of NA.
expiry_year	String	2	Year that the card expires, in YY format. If our gateway cannot return an expiry year, it returns a value of NA.

Request body example

{
  "card": {
    "card_number": "4012888888881881",        
    "expiry_month": "03",
    "expiry_year": "23"  
  }
}

Response

Object	Parameter	Type	Description
	transaction_id	String	Unique ID our gateway assigned to the original transaction.
	status	String	Indicates the status of the transaction.
card	masked_card_number	String	Masked card number of the card that the customer used for the transaction. Depending on the location of the POS, our gateway masks different parts of the card number: • For integrations in the US or Canada, our gateway masks all digits except the first six digits and the last four digits. • For integrations in Australia or New Zealand, our gateway masks all digits except the last four digits. • If our gateway cannot return a masked card number, it returns a value of NA.
expiry_month	String	Month that the card expires, in MM format. If our gateway cannot return an expiry month, it returns a value of NA.
expiry_year	String	Year that the card expires, in YY format. If our gateway cannot return an expiry year, it returns a value of NA.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.
type	String	Name of the card brand that issued the card.
payment	type	String	Type of payment for the transaction.

Response body example

{
    "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
Test	POST	https://api.pit.paygateway.com/tokenization/cardtokens/{token}
Production	POST	https://api.paygateway.com/tokenization/cardtokens/{token}

Request

Object	Parameter	Type	Size	Description
card	card_number	String	13-19	Primary account number (PAN) on the payment card.
expiry_month	String	2	Month that the card expires, in MM format. If our gateway cannot return an expiry month, it returns a value of NA.
expiry_year	String	2	Year that the card expires, in YY format. If our gateway cannot return an expiry year, it returns a value of NA.

Request body example

{
  "card": {
    "card_number": "4012888888881881",
    "expiry_month": "03",
    "expiry_year": "23"    
  }
}

Response

Object	Parameter	Type	Description
	transaction_id	String	Unique ID our gateway assigned to the original transaction.
	status	String	Indicates the status of the transaction.
card	masked_card_number	String	Masked card number of the card that the customer used for the transaction. Depending on the location of the POS, our gateway masks different parts of the card number: • For integrations in the US or Canada, our gateway masks all digits except the first six digits and the last four digits. • For integrations in Australia or New Zealand, our gateway masks all digits except the last four digits. • If our gateway cannot return a masked card number, it returns a value of NA.
expiry_month	String	Month that the card expires, in MM format. If our gateway cannot return an expiry month, it returns a value of NA.
expiry_year	String	Year that the card expires, in YY format. If our gateway cannot return an expiry year, it returns a value of NA.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.
type	String	Name of the card brand that issued the card.
payment	type	String	Type of payment for the transaction.

Response body example

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

Retrieve payment token details

Endpoints

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

Response

Object	Parameter	Type	Description
	transaction_id	String	Unique ID our gateway assigned to the original transaction.
	status	String	Indicates the status of the transaction.
card	masked_card_number	String	Masked card number of the card that the customer used for the transaction. Depending on the location of the POS, our gateway masks different parts of the card number: • For integrations in the US or Canada, our gateway masks all digits except the first six digits and the last four digits. • For integrations in Australia or New Zealand, our gateway masks all digits except the last four digits. • If our gateway cannot return a masked card number, it returns a value of NA.
expiry_month	String	Month that the card expires, in MM format. If our gateway cannot return an expiry month, it returns a value of NA.
expiry_year	String	Year that the card expires, in YY format. If our gateway cannot return an expiry year, it returns a value of NA.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.
type	String	Name of the card brand that issued the card.
payment	type	String	Type of payment for the transaction.

Response body example

{
    "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
Test	DELETE	https://api.pit.paygateway.com/tokenization/cardtokens/{token}
Production	DELETE	https://api.paygateway.com/tokenization/cardtokens/{token}

Response

Parameter	Type	Description
transaction_id	String	Unique ID our gateway assigned to the original transaction.
status	String	Indicates the status of the transaction.

Response body example

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

Create a check token

Endpoints

Environment	HTTP Method	URL
Test	POST	https://api.pit.paygateway.com/tokenization/checktokens
Production	POST	https://api.paygateway.com/tokenization/checktokens

Request

Object	Parameter	Type	Size	Description
check	account_number	String	1-17	The payer account number used for a check transaction. Maximum length is 17 for the US and 12 for Canada.
routing_number	String	9	Routing number for a check transaction.
accountholder_name	String	1-50	First and last name of the account holder.

Request body example

{
  "check": {
    "account_number": "12121",
    "routing_number": "112000066",
    "accountholder_name": "John Smith"
  }
}

Response

Object	Parameter	Type	Description
	transaction_id	String	Unique ID our gateway assigned to the transaction.
	status	String	Indicates the status of the transaction.
check	masked_account_number	String	Masked account number used for a check transaction.
routing_number	String	Routing number used for a check transaction.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.

Response body example

{
    "transaction_id": "000000002275",
    "status": "Approved",
    "check": {
        "masked_account_number": "X2121",
        "routing_number": "112000066",
        "token": "3SizZN5u0T"
    }
}

Retrieve check token details

Endpoints

Environment	HTTP Method	URL
Test	GET	https://api.pit.paygateway.com/tokenization/checktokens/{check_token}
Production	GET	https://api.paygateway.com/tokenization/checktokens/{check_token}

Response

Object	Parameter	Type	Description
	transaction_id	String	Unique ID our gateway assigned to the transaction.
	status	String	Indicates the status of the transaction.
check	masked_account_number	String	Masked account number used for a check transaction.
routing_number	String	Routing number used for a check transaction.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.

Response body example

{
    "transaction_id": "000000002278",
    "status": "Approved",
    "check": {
        "masked_account_number": "X2121",
        "routing_number": "112000066",
        "token": "5Fmc19zMCx"
    }
}

Delete a check token

Endpoints

Environment	HTTP Method	URL
Test	DELETE	https://api.pit.paygateway.com/tokenization/checktokens/{check_token}
Production	DELETE	https://api.paygateway.com/tokenization/checktokens/{check_token}

Response

Parameter	Type	Description
transaction_id	String	Unique ID our gateway assigned to the transaction.
status	String	Indicates the status of the transaction.

Response body example

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

Tokenization | Global Payments