Tokenization
access token
Token identifier - provide one of: TokenGuid, ExternalCardToken, or ExternalCheckToken
optional (max: 200) - 3rd party gateway card token
optional (max: 200) - 3rd party gateway check/ACH token
optional (max: 30) - updated credit card number
optional - example: "01" for January
optional - example: "29" for 2029
optional (max: 4) - CVV
optional (max: 25) - updated name on card
optional (max: 9) - updated bank routing number
optional (max: 20) - updated bank account number
optional (max: 10) - check number
optional - 1=Checking, 2=Saving
optional - 1=Personal, 2=Corporate, 3=Government
optional (max: 25) - updated name on check
optional (max: 100) - updated billing email
optional (max: 50) - billing first name
optional (max: 50) - billing last name
optional (max: 10) - billing zip/postal code
optional (max: 50) - billing street address
optional (max: 50) - billing city
optional (max: 50) - 2 char US state code or non-US equivalent
optional - 2 char country code
optional - 3 char currency code, e.g. "USD", "CAD"
optional (max: 200) - constituent id from partner system
optional - when true, designates this token as the default payment method for the constituent; clears IsDefault on all other tokens for the same constituent and processor
optional - internal use - Identifies integrated Product; validated against the integration source that created the token
Returns the updated token details
True if the token update was successful
Update token response message
Processor response message
The TokenGuid identifying this token
Updated ExternalCardToken - may differ from the original if the card number was changed on a processor that requires a new token (e.g. Stripe)
Updated ExternalCheckToken - may differ from the original if the bank account was changed on a processor that requires a new token
ExternalCustomerId - 3rd party gateway customer id tied to the token
Partner's constituent/donor id stored on the token record
Response Code - "0" on success, any other value indicates an error
If the update fails
PUT /api/token HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 539
{
"TokenGuid": "text",
"ExternalCardToken": "text",
"ExternalCheckToken": "text",
"CardNum": "text",
"ExpMonth": "text",
"ExpYear": "text",
"CVNum": "text",
"NameOnCard": "text",
"CheckRoutingNumber": "text",
"CheckAccountNumber": "text",
"CheckNumber": "text",
"CheckAccountTypeId": "text",
"CheckTypeId": "text",
"NameOnCheck": "text",
"Email": "name@gmail.com",
"FirstName": "text",
"LastName": "text",
"Zip": "text",
"Street": "text",
"City": "text",
"State": "text",
"Country": "text",
"Currency": "text",
"ExternalConstituentId": "text",
"IsDefault": true,
"IntegrationSource": "text"
}{
"Successful": true,
"Message": "text",
"ProcessorMessage": "text",
"TokenGuid": "123e4567-e89b-12d3-a456-426614174000",
"ExternalCardToken": "text",
"ExternalCheckToken": "text",
"ExternalCustomerId": "text",
"ExternalConstituentId": "text",
"ResponseCode": "text"
}Token identifier - provide one of: TokenGuid, ExternalCardToken, or ExternalCheckToken
optional (max: 200) - 3rd party gateway card token
optional (max: 200) - 3rd party gateway check/ACH token
optional - internal use - Identifies integrated Product; validated against the integration source that created the token
access token
Token successfully deleted
True if the token was successfully cancelled/deleted
The TokenGuid that was deleted
3rd party gateway card token that was deleted (null for ACH tokens)
3rd party gateway check/ACH token that was deleted (null for card tokens)
3rd party gateway customer id associated with the deleted token
Partner's constituent/donor id stored on the deleted token record
Response message
Processor response message
Response code - "0" on success, any other value indicates an error
If the delete fails
DELETE /api/token HTTP/1.1
AccessToken: text
Accept: */*
{
"Successful": true,
"TokenGuid": "123e4567-e89b-12d3-a456-426614174000",
"ExternalCardToken": "text",
"ExternalCheckToken": "text",
"ExternalCustomerId": "text",
"ExternalConstituentId": "text",
"Message": "text",
"ProcessorMessage": "text",
"ResponseCode": "text"
}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: 200) - ArgoFire Gateway CustomerKey for pre-existing ArgoFire customers without a Payment API token record
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
Partner's constituent/donor id provided at tokenize time
Response Code - Successful = "OK" or "0", any other response code unsuccessful
If it fails to create a token
POST /api/tokenize HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 434
{
"ProcessorGuid": "text",
"CharityId": "text",
"OrganizationGuid": "text",
"IntegrationSource": "text",
"CardNum": "text",
"CardType": "text",
"ExpMonth": "text",
"ExpYear": "text",
"CVNum": "text",
"NameOnCard": "text",
"Email": "name@gmail.com",
"Zip": "text",
"Street": "text",
"City": "text",
"State": "text",
"Country": "text",
"Currency": "text",
"ExternalConstituentId": "text",
"ExternalCustomerId": "text",
"FirstName": "text",
"LastName": "text",
"IpAddress": "text"
}{
"Successful": true,
"Message": "text",
"ProcessorMessage": "text",
"TransactionId": "text",
"TokenGuid": "123e4567-e89b-12d3-a456-426614174000",
"ExternalCardToken": "text",
"ExternalCheckToken": "text",
"ExternalCustomerId": "text",
"ExternalConstituentId": "text",
"ResponseCode": "text"
}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: 200) - ArgoFire Gateway CustomerKey for pre-existing ArgoFire customers without a Payment API token record
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
Partner's constituent/donor id provided at tokenize time
Response Code - Successful = "OK" or "0", any other response code unsuccessful
If it fails to create a token
POST /api/tokenizeAch HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 476
{
"ProcessorGuid": "text",
"CharityId": "text",
"OrganizationGuid": "text",
"IntegrationSource": "text",
"CheckRoutingNumber": "text",
"CheckAccountNumber": "text",
"CheckNumber": "text",
"CheckAccountTypeId": "text",
"CheckTypeId": "text",
"NameOnCheck": "text",
"Email": "name@gmail.com",
"Zip": "text",
"Street": "text",
"City": "text",
"State": "text",
"Country": "text",
"Currency": "text",
"ExternalConstituentId": "text",
"ExternalCustomerId": "text",
"FirstName": "text",
"LastName": "text",
"IpAddress": "text"
}{
"Successful": true,
"Message": "text",
"ProcessorMessage": "text",
"TransactionId": "text",
"TokenGuid": "123e4567-e89b-12d3-a456-426614174000",
"ExternalCardToken": "text",
"ExternalCheckToken": "text",
"ExternalCustomerId": "text",
"ExternalConstituentId": "text",
"ResponseCode": "text"
}Last updated