POST Api/PaymentAccount/JS

Returns a URL for the payment account entry screen

Request Information

URI Parameters

None.

Body Parameters

APIPaymentAccountJSRequestModel
NameDescriptionTypeAdditional 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
PostbackAuthorization

Optionally provide authorization information to send back to the postback endpoint in the HTTP Authorization header.

 string

String length: inclusive between 0 and 1024
PostbackURL

Optionally provide a HTTP endpoint to post the new payment account information including token and description to.

 string

String length: inclusive between 0 and 1024
SingleUse

Optionally specifies whether this payment account can only be used for a single payment. Defaults to false.

 boolean?

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerToken": "sample string 1",
  "ExternalUserID": "sample string 2",
  "PostbackAuthorization": "sample string 3",
  "PostbackURL": "sample string 4",
  "SingleUse": true
}

Response Information

Resource Description

Returns a URL for the payment account entry screen

APIPaymentAccountJSResponseModel
NameDescriptionTypeAdditional information
AccessToken

Contains the JavaScript access token to pass to the JavaScript API methods.

 string

None.
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 retrieving the JavaScript access token.

 Collection of string

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"
  ],
  "AccessToken": "sample string 2",
  "Success": true
}