Response Parameters

Authorize API reference

See reference information for Authorize API response parameters below.

Find Authorize API sample code in Authorize.

status

Parent: root

The status element is required, and it has the following attributes:

ParameterFormatRequirementDescription
codeIntegerRequiredA status code for the authorizing processes. Some possible values:
  • 2000 - successful authorization
  • 2010 - failed authorization
sub-codeIntegerConditional Requirement: Required for a failed authorizationThe granular error code that shows the reason for a failed authorization.

The status element has the following text content:

ParameterFormatRequirementDescription
statusStringRequiredThe status description. If the authorization succeeded, the description is Payment authorized. If the authorization failed, the description corresponds to sub-code's granular error code.

web-method

Parent: root

The web-method element is required when 3-D Secure 2.0 (3DS) verification is required for authorization. It has the following text content:

ParameterFormatRequirementDescription
web methodStringConditional Requirement: Mandatory for the first Authorize response in a 3DS workflow.JS/HTML that the front-end application should use to collect verification. See the 3DS integration guide for more information.

Applicable to 3DS authentication.

ddc-expiry

Parent: root

The ddc-expiry element is required during a 3DS flow when DDC is needed for authorization. It has the following text content:

ParameterFormatRequirementDescription
DDC expiry timeIntegerConditional Requirement: Mandatory when DDC is required.The expiry time in milliseconds. If verification takes more time than this, the front-end application should send a timeout request. See the 3DS integration guide for more information.

Applicable to 3DS authentication with DDC.

return-url

Parent: root

The return-url element is required when 3DS verification is needed for authorization. It has the following text content:

ParameterFormatRequirementDescription
return URLStringConditional Requirement: Mandatory in a 3DS workflow.The absolute URL to the back office of a merchant where Velocity POP sends the payment status.

Note: If you do not provide this parameter, Velocity uses the default URL.

Applicable to 3DS authentication.

card-mask

Parent: root

The card-mask element is required when 3DS verification is needed for authorization. It has the following text content:

ParameterFormatRequirementDescription
masked card numberStringConditional Requirement: Mandatory in a 3DS workflow.The masked card number of the payment card sent in the Authorize request.

Applicable to 3DS authentication.

expiry

Parent: root

The expiry element is required when 3DS verification is needed for authorization. It has the following text content:

ParameterFormatRequirementDescription
card expiryStringConditional Requirement: Mandatory in a 3DS workflow.The payment card expiration date sent in the Authorize request.

Applicable to 3DS authentication.

token

Parent: root

The token element is required during a 3DS challenge flow. It has the following text content:

ParameterFormatRequirementDescription
tokenStringConditional Requirement: Mandatory in a 3DS challenge flow.Applicable to a 3DS challenge flow.

parsed-challenge

Parent: root

Please note:

  • The parsed-challenge element is optional for a 3DS challenge flow.
  • The parsed-challenge element has one child: action.
  • The action element has the following children: url, hidden-fields, and configuration-fields. See their descriptions below.

The action element has the following attribute:

ParameterFormatRequirementDescription
type-idIntegerOptionalA numeric code for the type of challenge required for 3DS verification.

Applicable to a 3DS challenge flow.

url

Parents: root: parsed-challenge: action

The url element is optional for a 3DS challenge flow. It has the following attributes:

ParameterFormatRequirementDescription
content-typeStringOptionalThe content type sent for the challenge.

Applicable to a 3DS challenge flow.
methodStringOptionalThe method for the challenge.

Applicable to a 3DS challenge flow.

The url element has the following text content:

ParameterFormatRequirementDescription
URLStringOptionalThe target URL for the challenge field.

Applicable to a 3DS challenge flow.

hidden-fields

Parents: root: parsed-challenge: action

The hidden-fields element is optional for a 3DS challenge flow. It may have multiple children; each child element provides data for one hidden field.

configuration-fields

Parents: root: parsed-challenge: action

The configuration-fields element is optional for a 3DS challenge flow; it provides information to configure the challenge field.

The configuration-fields element can have the following children:

ElementRequirementFormat of text contentDescription of text content
iframeOptionalBooleanIf true, the challenge field is an iframe.

Applicable to a 3DS challenge flow.
heightOptionalIntegerThe height of the challenge field in pixels.

Applicable to a 3DS challenge flow.
widthOptionalIntegerThe width of the challenge field in pixels.

Applicable to a 3DS challenge flow.

device_collection_status

Parent: root

Please note:

  • The device_collection_status element is optional for a 3DS challenge flow; it describes the status of any previous DDC attempts.
  • The device_collection_status element has one child: status. See its description below.

status

Parents: root: device_collection_status

The status element is optional for a 3DS challenge flow; it describes the status of a previous DDC attempt. It has the following children:

ElementRequirementFormat of text contentDescription of text content
codeOptionalIntegerThe status code of the DDC flow.

Applicable to a 3DS challenge flow.
descriptionOptionalStringThe status description of the DDC flow.

Applicable to a 3DS challenge flow.