POST Api/PaymentAccount/ConvertJSToken

Converts a temporary payment account token received from the JavaScript API into a permanent payment account token.

Request Information

URI Parameters

None.

Body Parameters

APIPaymentAccountJSTokenModel

Name	Description	Type	Additional information
CustomerToken	Optionally contains the unique customer token used to identify the customer the payment account is being added/edited for.	string	None.
ExternalUserID	Contains the unique user ID for the customer that the payment account is being created for.	string	String length: inclusive between 0 and 256
TemporaryToken	Contains the temporary token to convert.	string	Required String length: inclusive between 0 and 1024

Name

Description

Type

Additional information

CustomerToken

Optionally contains the unique customer token used to identify the customer the payment account is being added/edited for.

string

None.

ExternalUserID

Contains the unique user ID for the customer that the payment account is being created for.

string

String length: inclusive between 0 and 256

TemporaryToken

Contains the temporary token to convert.

string

Required

String length: inclusive between 0 and 1024

Request Formats

application/json, text/json

Sample:

{
  "CustomerToken": "sample string 1",
  "ExternalUserID": "sample string 2",
  "TemporaryToken": "sample string 3"
}

Response Information

Resource Description

Converts a temporary payment account token received from the JavaScript API into a permanent payment account token.

APIPaymentAccountResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when performing the payment account action.	Collection of string	None.
Result	Contains the details of the payment account.	PaymentAccountResponseModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorID": "sample string 1",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "Account": "Visa",
    "AccountNumberLastFour": "1234",
    "AchBankName": "sample string 1",
    "AchRegion": "USA",
    "Address": "sample string 2",
    "Address2": "sample string 3",
    "CcCardType": "Visa",
    "CcChargeType": "Unknown",
    "CcExpirationDate": "01/16",
    "City": "sample string 5",
    "Country": "USA",
    "Description": "sample string 7",
    "DisplayAccountNumber": "*****1234",
    "DisplayDescription": "sample string 8",
    "DisplayRoutingNumber": "*****0614",
    "ExternalUserID": "sample string 10",
    "FirstName": "sample string 11",
    "IsAmazonPay": true,
    "IsApplePay": true,
    "IsBankAccount": true,
    "IsBilledByAutoDebit": true,
    "IsBilledByPaymentPlan": true,
    "IsBilledByRecurringPayment": true,
    "IsBlocked": true,
    "IsBusinessAccount": true,
    "IsCheckingAccount": true,
    "IsCreditCard": true,
    "IsPayPal": true,
    "IsPersonalAccount": true,
    "IsPinacleAccount": true,
    "IsRTPAccount": true,
    "IsRTPEligible": true,
    "IsSavingsAccount": true,
    "LastName": "sample string 29",
    "Name": "sample string 30",
    "PaymentAccountType": "ACH",
    "State": "NY",
    "Swiped": true,
    "Token": "sample string 34",
    "Validated": true,
    "Zip": "sample string 35"
  },
  "Success": true
}