Tokenization
access token
optional for Non-Profit transactions like donations but required if For-Profit API Partner - Identifies Processor being used by an API Partner
optional - Valid CharityId from Charity Search
internal use - Valid Panorama Organization Guid
internal use
Valid Credit card number
optional (max: 20) - "American Express", "Mastercard", "Visa", "Discover", "Diners Club" - will be set internally based on cardNum
example: "01" for January - required
example: "29" for 2029 - required
optional (max: 4) - valid CVV - please provide for CVV checks
required - Name on Card
required - valid contact email
optional (max: 10) - please provide for best interchange and avs checks - US, CA, AU formats are validated (example formats - US: 12345 or 12345-1234, CA: A1A 1A1, AU: 3000
required - please provide for best interchange and avs checks
required - please provide for best interchange and avs checks
optional - 2 char US state code, 3 char may be used for other non-US
required - 2 char country code
optional - 3 char currency code - Example for US - "USD", for CA - "CAD"
optional (max: 200) - ConstituentId per Product
optional (max: 50) - billing First Name
optional (max: 50) - billing Last Name
client ip address (max: 40) where transaction originates
Returns the newly created token
This is "true" tokenization process was successful, and "false" if unsuccessful.
Get Token response message
Get Token Processor response message
Not currently used and may be null
The unique GUID associated with the credit card or bank token you created that is used with the api/paymentToken endpoint
ExternalCardToken if available to return - represents 3rd party gateway card token
ExternalCheckToken if available to return - represents 3rd party gateway check token
ExternalCustomerId if available to return - represents 3rd party gateway customer id tied to gateway token
Response Code - Successful = "OK" or "0", any other response code unsuccessful
If it fails to create a token
access token
optional for Non-Profit transactions like donations but required if For-Profit API Partner - Identifies Processor being used by an API Partner
optional - Valid CharityId Guid from Charity Search
internal use - Valid Panorama Organization Guid
internal use - Identifies integrated Product
required - Valid Check Bank Routing Number - formats - US: Enter 9-digits, CA: Enter 9-digits (Format: 0YYYXXXXX: A mandatory leading zero. YYY: The 3-digit institution number. XXXXX: The 5-digit transit number), AU: Enter 6-digits - BSB Number (Bank State Branch) without hyphen
required - Valid Check Account Number - formats - US: Enter 8-12 digits, CA: Enter 7-12 digits, AU: Enter 3-9 digits
optional (max: 10) - Valid Check Number
required for Check ACH transactions - possible values - 1 - Checking, 2 - Saving
required for Check ACH transactions - possible values - 1 - Personal, 2 - Corporate, 3 - Government
required - Name on ACH Check Account
required - valid contact email
optional (max: 10) - US, CA, AU formats are validated (example formats - US: 12345 or 12345-1234, CA: A1A 1A1, AU: 3000
optional (max: 50) - billing street
optional (max: 50) - billing city
optional - 2 char US state code, 3 char may be used for other non-US
optional - 2 char country code
optional - 3 char currency code - Example for US - "USD", for CA - "CAD"
optional (max: 200) - ConstituentId per Product
optional (max: 50) - billing First Name
optional (max: 50) - billing Last Name
client ip address (max: 40) where transaction originates
Returns the newly created token
This is "true" tokenization process was successful, and "false" if unsuccessful.
Get Token response message
Get Token Processor response message
Not currently used and may be null
The unique GUID associated with the credit card or bank token you created that is used with the api/paymentToken endpoint
ExternalCardToken if available to return - represents 3rd party gateway card token
ExternalCheckToken if available to return - represents 3rd party gateway check token
ExternalCustomerId if available to return - represents 3rd party gateway customer id tied to gateway token
Response Code - Successful = "OK" or "0", any other response code unsuccessful
If it fails to create a token
Last updated