Jump to

• Request
• Response

authPayment

post

/ccagent/v1/payment/auth

Auth Payment. Payment authorization endpoint.

Request

Supported Media Types

• application/json

Body ()

Root Schema : authPayment_request

Type: object

Show Source

• 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.

{
    "properties":{
        "unsigned_field_names":{
            "description":"Unsigned field names.",
            "type":"string"
        },
        "card_expiry_date":{
            "description":"Card expiry date.",
            "type":"string"
        },
        "bill_to_address_postal_code":{
            "description":"Billing address postal code.",
            "type":"string"
        },
        "bill_to_address_state":{
            "description":"Billing address state code.",
            "type":"string"
        },
        "locale":{
            "description":"The current site locale.",
            "type":"string"
        },
        "bill_to_email":{
            "description":"Billing address email address.",
            "type":"string"
        },
        "bill_to_address_country":{
            "description":"Billing address country code.",
            "type":"string"
        },
        "bill_to_surname":{
            "description":"Billing address surname.",
            "type":"string"
        },
        "bill_to_phone":{
            "description":"Billing address phone number.",
            "type":"string"
        },
        "currency":{
            "description":"Currency",
            "type":"string"
        },
        "bill_to_forename":{
            "description":"Billing address forename.",
            "type":"string"
        },
        "payment_method":{
            "description":"The payment method.",
            "type":"string"
        },
        "amount":{
            "description":"Total order amount.",
            "type":"string"
        },
        "transaction_uuid":{
            "description":"The transaction unique ID.",
            "type":"string"
        },
        "card_cvn":{
            "description":"Card CVN number.",
            "type":"string"
        },
        "signed_field_names":{
            "description":"Signed field names.",
            "type":"string"
        },
        "transaction_type":{
            "description":"The transaction type.",
            "type":"string"
        },
        "card_type":{
            "description":"Card type.",
            "type":"string"
        },
        "reference_number":{
            "description":"Order reference number.",
            "type":"string"
        },
        "bill_to_address_line1":{
            "description":"Billing address address line 1.",
            "type":"string"
        },
        "profile_id":{
            "description":"The profile ID.",
            "type":"string"
        },
        "access_key":{
            "description":"The payment access key.",
            "type":"string"
        },
        "bill_to_address_city":{
            "description":"Billing address address line 2.",
            "type":"string"
        },
        "siteId":{
            "description":"Site ID.",
            "type":"string"
        },
        "signed_date_time":{
            "description":"Signed date and time.",
            "type":"string"
        }
    },
    "required":[
        "unsigned_field_names",
        "card_expiry_date",
        "bill_to_address_postal_code",
        "bill_to_address_state",
        "locale",
        "bill_to_email",
        "bill_to_address_country",
        "bill_to_surname",
        "bill_to_phone",
        "currency",
        "bill_to_forename",
        "payment_method",
        "amount",
        "transaction_uuid",
        "card_cvn",
        "signed_field_names",
        "transaction_type",
        "card_type",
        "reference_number",
        "bill_to_address_line1",
        "profile_id",
        "access_key",
        "bill_to_address_city",
        "siteId",
        "signed_date_time"
    ],
    "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":"[e-mail]",
        "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":""
    }
}

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":"[e-mail]",
    "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":""
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : authPayment_response

Type: object

Show Source

• accessKey(optional): string
  Access key.
• ignore_avs(optional): boolean
  A flag to tell the Cybersource whether to ignore the AVS results.
• 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.

{
    "properties":{
        "ignore_avs":{
            "description":"A flag to tell the Cybersource whether to ignore the AVS results.",
            "type":"boolean"
        },
        "accessKey":{
            "description":"Access key.",
            "type":"string"
        },
        "signature":{
            "description":"Generated signature.",
            "type":"string"
        },
        "sopURL":{
            "description":"CyberSource SOP URL.",
            "type":"string"
        },
        "profileId":{
            "description":"SOP Profile ID.",
            "type":"string"
        },
        "transaction_uuid":{
            "description":"Unique transaction ID.",
            "type":"string"
        },
        "signed_date_time":{
            "description":"Key expiration date.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "ignore_avs":false,
    "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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top