DELETE Api/PaymentAccount?CustomerToken={CustomerToken}&ExternalUserID={ExternalUserID}&Token={Token}

Deletes an existing payment account from the system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CustomerToken

For enrolled customers, must contain the unique customer token used to identify the customer the payment account is being deleted from.

string

None.

ExternalUserID

For one-time customers, must contain the unique user ID for the customer that the payment account is being deleted from.

string

String length: inclusive between 0 and 256

Token

Specifies the token of the existing payment account to delete.

string

Required

Body Parameters

None.

Response Information

Resource Description

Deletes an existing payment account from the system.

APIPaymentAccountResponseModel
NameDescriptionTypeAdditional 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
}