GET 3dCartWebAPI/v1/PaymentTokens?limit={limit}&offset={offset}&countonly={countonly}

GET 3dCartWebAPI/v1/PaymentTokens

Get all Payment Tokens

Request Information

URI Parameters

Name	Description	Type	Additional information
limit	Maximum number of items that can be returned	integer	Default value is 10
offset	Starting point for the return data	integer	Default value is 1
countonly	Count the number of rows only	integer	Default value is 0

Body Parameters

None.

Sample Request

PHP

Python

Ruby

Response Information

Resource Description

Collection of PaymentToken

Name	Description	Type	Additional information
PaymentTokenID	database reference = customers_pmntprofiles.id	integer	None.
CustomerID	database reference = customers_pmntprofiles.contactid	integer	None.
OrderID	database reference = customers_pmntprofiles.contactid	integer	None.
CustomerProfileID	database reference = customers_pmntprofiles.custProfileId	string	String length: inclusive between 0 and 50
PaymentProfileID	database reference = customers_pmntprofiles.custPmntProfileId	string	String length: inclusive between 0 and 50
CardLast4	database reference = customers_pmntprofiles.cardlastdigits	integer	None.
CardExpMonth	database reference = customers_pmntprofiles.cardexp	integer	None.
CardExpYear	database reference = customers_pmntprofiles.cardexp	integer	None.
BillingPaymentMethodID	database reference = customers_pmntprofiles.gateway_id / customers_pmntprofiles.gateway	integer	None.
LastUpdate	database reference = customers_pmntprofiles.datecreated	date	None.
GatewayName	database reference = customers_pmntprofiles.gateway	string	String length: inclusive between 0 and 50
GatewayID	database reference = customers_pmntprofiles.gateway_id	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PaymentTokenID": 1,
    "CustomerID": 1,
    "OrderID": 1,
    "CustomerProfileID": "sample string 1",
    "PaymentProfileID": "sample string 2",
    "CardLast4": 1,
    "CardExpMonth": 1,
    "CardExpYear": 1,
    "BillingPaymentMethodID": 1,
    "LastUpdate": "04/17/2024 08:50",
    "GatewayName": "sample string 3",
    "GatewayID": 1
  },
  {
    "PaymentTokenID": 1,
    "CustomerID": 1,
    "OrderID": 1,
    "CustomerProfileID": "sample string 1",
    "PaymentProfileID": "sample string 2",
    "CardLast4": 1,
    "CardExpMonth": 1,
    "CardExpYear": 1,
    "BillingPaymentMethodID": 1,
    "LastUpdate": "04/17/2024 08:50",
    "GatewayName": "sample string 3",
    "GatewayID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentToken xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PaymentToken>
    <PaymentTokenID>1</PaymentTokenID>
    <CustomerID>1</CustomerID>
    <OrderID>1</OrderID>
    <CustomerProfileID>sample string 1</CustomerProfileID>
    <PaymentProfileID>sample string 2</PaymentProfileID>
    <CardLast4>1</CardLast4>
    <CardExpMonth>1</CardExpMonth>
    <CardExpYear>1</CardExpYear>
    <BillingPaymentMethodID>1</BillingPaymentMethodID>
    <LastUpdate>2024-04-17T08:50:19.5794727-04:00</LastUpdate>
    <GatewayName>sample string 3</GatewayName>
    <GatewayID>1</GatewayID>
  </PaymentToken>
  <PaymentToken>
    <PaymentTokenID>1</PaymentTokenID>
    <CustomerID>1</CustomerID>
    <OrderID>1</OrderID>
    <CustomerProfileID>sample string 1</CustomerProfileID>
    <PaymentProfileID>sample string 2</PaymentProfileID>
    <CardLast4>1</CardLast4>
    <CardExpMonth>1</CardExpMonth>
    <CardExpYear>1</CardExpYear>
    <BillingPaymentMethodID>1</BillingPaymentMethodID>
    <LastUpdate>2024-04-17T08:50:19.5794727-04:00</LastUpdate>
    <GatewayName>sample string 3</GatewayName>
    <GatewayID>1</GatewayID>
  </PaymentToken>
</ArrayOfPaymentToken>