CIM Responses - Merchant Web Services API

The example below illustrates the structure of a typical response from the payment gateway for any of the CIM API calls.

Table 18 Payment gateway responses

ELEMENT VALUE TYPE/FORMAT NOTES

refId Merchant-assigned reference ID for the request

Optional

Up to 20 characters If included in the request, this value will be included in the response. This feature might be

especially useful for multi-threaded applications.

messages Contains information about the results of the request resultCode Contains additional

information about the results of the request

Ok Error message Contains the result code

and text

Provides more details about the error(s).

code A code that represents the reason for the error

String See the Response Codes

section of this document for possible values.

text A text description of the error

String See the Response Codes

section of this document for possible values.

Response example .

Output for createCustomerProfileResponse

The following table lists the additional output returned from the payment gateway for an API call to the createCustomerProfileRequest function.

Note: The createCustomerProfileResponse returns onlythe assigned customerProfileId for the created profile. To retrieve the customerPaymentProfileId and the custom-erShippingId that may also be created when using the createCustomerProfile function, you must submit the getCustomerProfileRequest function using the assigned customerProfileId for that customer profile.

<?xml version="1.0" encoding="utf-8" ?>

<createCustomerProfileResponse xmlns:xsi="http://www.w3.org/2001/

XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">

<refId>refid1</refId>

<text>Successful.</text>

</message>

</messages>

</createCustomerProfileResponse>

Table 19 Output for createCustomerProfileResponse

FIELD VALUE TYPE/FORMAT NOTES

refId

Merchant-assigned reference ID for the request Optional

Up to 20 characters If included in the request, this value will be included in the response. This feature might be especially useful for multi-threaded applications.

customerProfileId Payment gateway assigned ID associated with the customer profile

Numeric This output is

present only for successful requests.

customerPaymentProfileIdList A list of all payment profile IDs created with the request Optional

Numeric This output is

present only for requests that contain one or more payment profiles.

The payment profile IDs are returned in the same order as they were in the request.

customerShippingAddressIdList A list of all shipping profile IDs created with the request Optional

Numeric This output is

present only for requests that contain multiple shipping profiles.

The shipping profile IDs are returned in the same order as they were in the request.

validationDirectResponseList A list of the direct response results for the validation transaction for each payment profile.

Optional

String

See the Advanced Integration Guide at http://

www.authorize.net/

support/AIM_

guide.pdf for details about information included in the payment gateway transaction response.

This output is present only if the ValidationMode input element is passed with a value of testMode or liveMode.

The list is returned in the same order as the payment profiles were submitted in the request.

Table 19 Output for createCustomerProfileResponse (Continued)

FIELD VALUE TYPE/FORMAT NOTES

Example Successful createCustomerProfileResponse

Output for createCustomerPaymentProfileResponse

The following table lists the output returned from the payment gateway for an API call to the

<?xml version="1.0" encoding="utf-8"?>

<createCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

</customerPaymentProfileIdList>

</customerShippingAddressIdList>

<string>1,1,1,This transaction has been

approved.,000000,Y,2000000000,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main

St.,Bellevue,WA,98004,USA,000-000-0000,,[email protected],,,,,,,,,0.00,0.00,0.00,,none,

D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,</string>

<string>1,1,1,This transaction has been

approved.,000000,Y,2000000001,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main

St.,Bellevue,WA,98004,USA,000-000-0000,,[email protected],,,,,,,,,0.00,0.00,0.00,,none,

D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,</string>

</validationDirectResponseList>

</createCustomerProfileResponse>

Example createCustomerPaymentProfileResponse

Table 20 Output for createCustomerPaymentProfileResponse

FIELD VALUE TYPE/FORMAT NOTES

refId

Merchant-assigned reference ID for the request Optional

Up to 20 characters If included in the request, this value will be included in the response. This feature might be especially useful for multi-threaded applications.

customerPaymentProfileId Payment

gateway assigned ID associated with the customer payment profile

Numeric This output is

present only for successful requests.

validationDirectResponse Contains detailed information about the result of the

transaction.

String

See the Advanced Integration Guide at http://

www.authorize.net/

support/AIM_guide.pdf for details about information included in the payment gateway transaction response.

This output is present only if the ValidationMode input parameter is passed with a value of testMode or liveMode.

<?xml version="1.0" encoding="utf-8"?>

<createCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

<validationDirectResponse>1,1,1,This transaction has been approved.,000000,Y,2000000000,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main

St.,Bellevue,WA,98004,USA,000-000-0000,,[email protected],,,,,,,,,0.00,0.00,0.00,,none,

D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,

Output for createCustomerShippingAddressResponse

The following table represents the output returned from the payment gateway for an API call to the createCustomerShippingAddress function.

Example Sample createCustomerShippingAddressResponse

Output for createCustomerProfileTransactionResponse

The following table represents the output returned from the payment gateway for an API call to the createCustomerProfileTransaction function.

Table 21 Output for createCustomerShippingAddressResponse

FIELD VALUE TYPE/

FORMAT

NOTES

refId

Merchant-assigned reference ID for the request Optional

Up to 20 characters

If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.

customerShippingAddressId Payment

gateway assigned ID associated with the customer shipping address

Numeric This output is present only for successful requests.

<?xml version="1.0" encoding="utf-8"?>

<createCustomerShippingAddressResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

</createCustomerShippingAddressResponse>

Example createCustomerProfileTransactionResponse

Table 22 Output for createCustomerProfileTransactionResponse

FIELD VALUE TYPE/FORMAT NOTES

refId

Merchant-assigned reference ID for the request Optional

Up to 20 characters If included in the request, this value is included in the response.

This feature might be especially useful for multi-threaded applications.

directResponse Contains

detailed

See the Advanced Integration Guide at http://

www.authorize.net/

support/AIM_

guide.pdf for details about information included in the payment gateway transaction response.

Transactions created from a customer profile behave the same as regular transactions - you and your

customer will receive all associated email notifications.

Additionally, all fraud settings, including FDS filters and AVS and CCV settings, will be enforced.

Output for deleteCustomerProfileResponse

The following table lists the output returned from the payment gateway for an API call to the deleteCustomerProfile function.

Example deleteCustomerProfileResponse

<?xml version="1.0" encoding="utf-8"?>

<createCustomerProfileTransactionResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

<directResponse>1,1,1,This transaction has been approved.,000000,Y,2000000001,INV000001,description of

transaction,10.95,CC,auth_capture,custId123,John,Doe,,123 Main

St.,Bellevue,WA,98004,USA,000-000-0000,,[email protected],John,Doe,,123 Main St.,Bellevue,WA,98004,USA,1.00,0.00,2.00,FALSE,PONUM000001,

D18EB6B211FE0BBF556B271FDA6F92EE,M,2,,,,,,,,,,,,,,,,,,,,,,,,,,,, </directResponse>

</createCustomerProfileTransactionResponse>

Table 23 Output for deleteCustomerProfileResponse

FIELD VALUE TYPE/FORMAT NOTES

refId Merchant-assigned

reference ID for the request

Optional

Up to 20 characters

If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.

Output for deleteCustomerPaymentProfileResponse

The following table lists the output returned from the payment gateway for an API call to the deleteCustomerPaymentProfile function.

Example deleteCustomerPaymentProfileResponse

<?xml version="1.0" encoding="utf-8"?>

<deleteCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

</deleteCustomerProfileResponse>

Table 24 Output for deleteCustomerPaymentProfileResponse

FIELD VALUE TYPE/

FORMAT

NOTES

refId

Merchant-assigned reference ID for the request Optional

Up to 20 characters

If included in the request, this value is included in the response. This feature might be

especially useful for multi-threaded applications.

<?xml version="1.0" encoding="utf-8"?>

<deleteCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

</deleteCustomerPaymentProfileResponse>

Output for deleteCustomerShippingAddressResponse

The following table lists the output returned from the payment gateway for an API call to the deleteCustomerShippingAddressRequest function.

Example deleteCustomerShippingAddressResponse

Output for getCustomerProfileIdsResponse

The following table lists the output returned from the payment gateway for an API call to the getCustomerProfileIdsRequest function.

Table 25 Output for deleteCustomerShippingAddressResponse

FIELD VALUE TYPE/

FORMAT

NOTES

refId

Merchant-assigned reference ID for the request Optional

Up to 20 characters

If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.

<?xml version="1.0" encoding="utf-8"?>

<deleteCustomerShippingAddressResponse xmlns="AnetApi/xml/v1/schema/

AnetApiSchema.xsd">

<text>Successful.</text>

</message>

</messages>

</deleteCustomerShippingAddressResponse>

Table 26 Output for getCustomerProfileIdsResponse

FIELD VALUE TYPE/FORMAT NOTES

Example Successful getCustomerProfileIdsResponse

In document Merchant Web Services API (Page 95-105)