API iCredit Identifiers

📘

All system identifiers are in unique GUID format

GroupPrivateToken -

Payment page ID, used for creating a new payment page URL.

Methods -

• GetUrl request
• SaleChargeToken request
• CreateSale request
• IPN massage response

to get the GroupPrivateToken follow this instructions - Payment Page ID

GroupId -

Link Payment page identifier

Methods -

This ID is not used in API and it is mainly a system internal ID and for logs.

How to find:

It will show in payment page link

SaleId -

This ID returns after a sale is created in iCredit

It can be used for several actions and for getting information about the sale.

Methods -

• SaleDetails request
• IPN massage response
• CancelSale request
• ChargePendingSale request
• ReleaseJ5 request
• Verify request

SalePrivateToken -

This ID will return after a sale is created in iCredit
It can be used for several actions and for getting information about the sale.

Methods -

• GetUrl response
• SaleChargeToken response
• CreateSale response
• SaleDetails request
• CancelSale request
• ChargePendingSale request

PublicSaleToken -

This ID returns in GetUrl method after a payment page is created.

It can be saved for getting sale info after the charge is completed, it should be saved alongside with SalePrivateToken to connect the Thank You page displayed to the specific sale.

The PublicSaleToken value will show in the end of the Thank You page link under "Token"-

Methods -

• GetUrl response

Token -

Unique secured credit card token, used for saving the client credit card for future charges.

Methods -

• SaleChargeToken request*
• ChargeSimple request
• CreateToken response
• SaleDetails response
• IPN massage response