genericCardPayment

post

/ccadmin/v1/webhook/genericCardPayment

Integrates custom payment gateways that let your store accept card payment.

Request

Supported Media Types
Body ()
Integrates custom payment gateways that let your store accept card payment.
Root Schema : genericCardPayment_request
Type: object
Integrates custom payment gateways that let your store accept card payment.
Show Source
Example:
{
    "amount":"000000068148",
    "orderId":"o60411",
    "profile":{
        "phoneNumber":"212-555-1977",
        "id":"se-570031",
        "email":"kim@example.com"
    },
    "channel":"storefront",
    "locale":"en",
    "transactionId":"o60411-pg60414-1509966500257",
    "transactionTimestamp":"2017-11-06T11:08:20+0000",
    "transactionType":"0100",
    "paymentId":"pg60414",
    "cardDetails":{
        "expirationYear":"2018",
        "number":"4111111111111111",
        "holderName":"Kim",
        "cvv":"123",
        "expirationMonth":"03",
        "type":"visa"
    },
    "paymentMethod":"card",
    "shippingAddress":{
        "country":"US",
        "lastName":"Anderson",
        "address3":"",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":"",
        "companyName":"",
        "jobTitle":"",
        "postalCode":"13202",
        "county":"",
        "suffix":"",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "faxNumber":"",
        "middleName":"",
        "state":"NY",
        "email":"kim@example.com"
    },
    "gatewaySettings":{
        "filteredFields":[
            "merchantId",
            "paymentMethodTypes"
        ],
        "merchantId":"merchant id",
        "paymentMethodTypes":"card"
    },
    "siteId":"siteUS",
    "billingAddress":{
        "country":"US",
        "lastName":"Anderson",
        "address3":"",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":"",
        "companyName":"",
        "jobTitle":"",
        "postalCode":"13202",
        "county":"",
        "suffix":"",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "faxNumber":"",
        "middleName":"",
        "state":"NY",
        "email":"kim@example.com"
    },
    "currencyCode":"USD",
    "gatewayId":"gatewayTest"
}
Nested Schema : request
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The billing address.
Show Source
Nested Schema : cardDetails
Type: object
The details of card used for transaction.
Show Source
Nested Schema : gatewaySettings
Type: object
Additional Properties Allowed
Show Source
The settings of the gateway.
Nested Schema : profile
Type: object
The basic profile details.
Show Source
Nested Schema : referenceInfo
Type: object
Additional Properties Allowed
Show Source
For void/refund transactions
Nested Schema : shippingAddress
Type: object
The shipping address
Show Source
Back to Top

Response

Supported Media Types

200 Response

Integrates custom payment gateways that let your store accept card payment.
Body ()
Root Schema : genericCardPayment_response
Type: object
The generic card payment response from external service
Show Source
Nested Schema : response
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : authorizationResponse
Type: array
This response is received incase the transactionType is AUTH. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
Show Source
Nested Schema : creditResponse
Type: array
This response is recieved incase the transactionType is RFND. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
Show Source
Nested Schema : voidResponse
Type: array
This response is recieved incase the transactionType is VOID. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : customPaymentProperties
Type: array
Custom payment properties can be sent here.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Example Response (application/json)
{
    "hostTransactionTimestamp":1.447807667046E12,
    "amount":"000000068148",
    "orderId":"o60411",
    "authorizationResponse":{
        "responseReason":"1001",
        "authCode":"AUTH-ACCEPT",
        "hostTransactionId":"HOST-TRANSACTION-ID",
        "responseCode":"1000",
        "hostResponse":"host-success",
        "token":"token-success"
    },
    "transactionId":"o60411-pg60414-1509966500257",
    "transactionTimestamp":"2017-11-06T11:08:20+0000",
    "transactionType":"0100",
    "customPaymentProperties":[
        "sample-addnl-property-key2"
    ],
    "paymentId":"pg60414",
    "paymentMethod":"card",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/externalPayment"
        }
    ],
    "additionalProperties":{
        "sample-addnl-property-key2":"sample-payment-property-value2",
        "acsUrl":"http://oracle.com",
        "delayinmillis":"100000",
        "sample-addnl-property-key1":"sample-payment-property-value1",
        "amex-card-number":"3711111111111111",
        "random-properties":"1234567890123456789",
        "termUrl":"http://localhost",
        "MD":"MyMDoracle.com",
        "visa-card-number":"4111111111111111",
        "PAReq":"oracle.com1234",
        "dispalyMessage":"Please WAIT.....",
        "maxRetryCount":"30"
    },
    "currencyCode":"USD",
    "gatewayId":"gatewayTest"
}
Back to Top