authPayment
post
/ccstore/v1/payment/auth
Auth Payment. Payment authorization endpoint.
Request
Supported Media Types
- application/json
Root Schema : authPayment_request
Type:
Show Source
object
-
access_key:
string
The payment access key.
-
amount:
string
Total order amount.
-
bill_to_address_city:
string
Billing address address line 2.
-
bill_to_address_country:
string
Billing address country code.
-
bill_to_address_line1:
string
Billing address address line 1.
-
bill_to_address_postal_code:
string
Billing address postal code.
-
bill_to_address_state:
string
Billing address state code.
-
bill_to_email:
string
Billing address email address.
-
bill_to_forename:
string
Billing address forename.
-
bill_to_phone:
string
Billing address phone number.
-
bill_to_surname:
string
Billing address surname.
-
card_cvn:
string
Card CVN number.
-
card_expiry_date:
string
Card expiry date.
-
card_type:
string
Card type.
-
currency:
string
Currency
-
locale:
string
The current site locale.
-
payment_method:
string
The payment method.
-
profile_id:
string
The profile ID.
-
reference_number:
string
Order reference number.
-
signed_date_time:
string
Signed date and time.
-
signed_field_names:
string
Signed field names.
-
siteId:
string
Site ID.
-
transaction_type:
string
The transaction type.
-
transaction_uuid:
string
The transaction unique ID.
-
unsigned_field_names:
string
Unsigned field names.
Example:
{
"unsigned_field_names":"card_number",
"card_expiry_date":"02-2015",
"bill_to_address_postal_code":"36003",
"bill_to_address_state":"AL",
"locale":"en",
"bill_to_email":"test@example.com",
"bill_to_address_country":"US",
"bill_to_surname":"test",
"bill_to_phone":"9121354321",
"currency":"USD",
"bill_to_forename":"test",
"payment_method":"card",
"amount":185.5,
"transaction_uuid":"",
"card_cvn":"123",
"signed_field_names":"access_key,profile_id,transaction_uuid,signed_field_names,signed_date_time,locale,transaction_type,payment_method,unsigned_field_names,reference_number,amount,currency,card_type,card_expiry_date,card_cvn,bill_to_forename,bill_to_surname,bill_to_phone,bill_to_address_line1,bill_to_address_city,bill_to_address_state,bill_to_address_country,bill_to_address_postal_code,bill_to_email",
"transaction_type":"authorization,create_payment_token",
"card_type":"001",
"reference_number":"o10003",
"bill_to_address_line1":"test",
"profile_id":"",
"access_key":"",
"bill_to_address_city":"Montgomery",
"siteId":"siteUS",
"signed_date_time":""
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : authPayment_response
Type:
Show Source
object
-
accessKey(optional):
string
Access key.
-
ignore_avs(optional):
boolean
A flag to tell the Cybersource whether to ignore the AVS results.
-
partner_solution_id(optional):
string
A field that identifies a transaction as occurring through Oracle Commerce.
-
profileId(optional):
string
SOP Profile ID.
-
signature(optional):
string
Generated signature.
-
signed_date_time(optional):
string
Key expiration date.
-
sopURL(optional):
string
CyberSource SOP URL.
-
transaction_uuid(optional):
string
Unique transaction ID.
Example Response (application/json)
{
"ignore_avs":false,
"partner_solution_id":"ABCDXYZ",
"signature":"0O5+qVCnDZ+B9jBJwcYqbhg/8dgW/dDKP7LCH5LQq9o=",
"sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
"profile_id":"Test111",
"access_key":"a7b7592b38603ae99b2815712007dd8b",
"transaction_uuid":"deec2cf1467542f8a9b6b8928f31f8be",
"signed_date_time":"2014-10-27T06:27:11Z"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code