This class provides RESTful services to add, get, update, and delete payment instructions for the current shopping cart.
com.ibm.commerce.rest.order.handler.PaymentInstructionHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/cart/@self/payment_instruction | Gets payment instructions for the shopping cart. |
GET | /store/{storeId}/cart/@self/payment_instruction/sensitive_data_mask_by_plain_string | Gets sensitive data mask information for plain string. |
POST | /store/{storeId}/cart/@self/payment_instruction | Adds payment instruction to the shopping cart. |
PUT | /store/{storeId}/cart/@self/payment_instruction | Updates payment instructions in the shopping cart. |
DELETE | /store/{storeId}/cart/@self/payment_instruction | Deletes all payment Instructions from the shopping cart. |
DELETE | /store/{storeId}/cart/@self/payment_instruction/{paymentInstruction_id} | Deletes a payment instruction in the shopping cart. |
Gets payment instructions for the shopping cart.
getPaymentInfo
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets sensitive data mask information for plain string.
getSensitiveDataMaskByPlainString
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
plainString | The plain string for the sensitive data | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.edp.beans.EDPSensitiveDataMaskHelperDataBean_IBM_sensitiveDataMaskByPlainString
GET /wcs/resources/store/10001/cart/@self/payment_instruction/sensitive_data_mask_by_plain_string?plainString=4111111111111111&responseFormat=json
200
{ "resultList": [ { "maskChar": "*", "maskedString": "************1111", "plainLength": -4 } ] }
Adds payment instruction to the shopping cart.
addPaymentInstruction
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | body data required for rest method | body | cart-payment_instruction | false | N/A |
HTTP Status Code | Description |
---|---|
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList
POST /wcs/resources/store/10001/cart/@self/payment_instruction?responseFormat=json
{ "account": "4111111111111111", "authToken": "12051%2CyptDDaIcXYQblKS3z%2BxMsMNKlhs%3D", "billing_address_id": "15808", "cc_brand": "VISA", "cc_cvc": "111", "checkRoutingNumber": " ", "check_routing_number": " ", "checkingAccountNumber": " ", "expire_month": "11", "expire_year": "2014", "payMethodId": "VISA", "paymentTermConditionId": "", "piAmount": "90.00000", "requesttype": "ajax", "valueFromPaymentTC": " ", "valueFromProfileOrder": " " }
201
{ "orderId": "25206", "paymentInstruction": [ { "piId": "14018" } ] }
Updates payment instructions in the shopping cart.
updatePaymentInstruction
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | Request body. | body | cart-payment_instruction | false | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList
Deletes all payment Instructions from the shopping cart.
deleteAllPaymentInstructions
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Deletes a payment instruction in the shopping cart.
deletePaymentInstruction
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
paymentInstruction_id | Payment instruction identifier to delete. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Name | Data Type | Required |
---|---|---|
financialTransaction | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType array | false |
userDataField | cart-payment_instruction.userDataField array | false |
paymentStatus | string | false |
paymentInstruction | cart-payment_instruction.paymentInstruction array | false |
orderId | string | false |
Name | Data Type | Required |
---|---|---|
primary | string | false |
organizationUnitName | string | false |
personTitle | string | false |
phone1 | string | true |
phone2 | string | true |
addressLine | string array | false |
billing_address_id | string | false |
phone1Publish | string | false |
nickName | string | true |
refundAllowed | string | false |
state | string | false |
mobilePhone1Country | string | true |
email1 | string | true |
email2 | string | true |
country | string | false |
paymentRule | string | false |
paymentTermConditionId | string | false |
priority | string | false |
payMethodId | string | false |
piCurrency | string | false |
bestCallingTime | string | false |
zipCode | string | false |
piAmount | string | false |
fax1 | string | true |
fax2 | string | true |
organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
geographicalShippingCode | string | false |
middleName | string | false |
lastName | string | false |
piDescription | string | false |
mobilePhone1 | string | true |
minAmount | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
piStatus | string | false |
addressType | string | false |
stateOrProvinceName | string | false |
attributes | cart-payment_instruction.paymentInstruction.attributes array | false |
language | string | false |
postalCode | string | false |
internalOfficeAddress | string | false |
firstName | string | false |
maxAmount | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
phone1Type | string | false |
personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
organizationName | string | false |
phone2Type | string | false |
protocolData | cart-payment_instruction.paymentInstruction.protocolData array | false |
userDataField | cart-payment_instruction.paymentInstruction.userDataField array | false |
sequenceNumber | string | false |
city | string | false |
phone2Publish | string | false |
piLanguage | string | false |
piId | string | false |
geographicalTaxCode | string | false |
businessTitle | string | false |
Name | Data Type | Required |
---|---|---|
attrValue | string | false |
attrKey | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
name | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
plainLength | string | false |
maskChar | string | false |
maskedString | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier | false |
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
identifier | string | false |
Name | Data Type | Required |
---|---|---|
paymentInstructionID | string | false |
requestAmount | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmount | false |
paymentProtocolData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData array | false |
transactionExtensionData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData array | false |
avsCode | string | false |
responseCode | string | false |
merchantOrderNumber | string | false |
reasonCode | string | false |
trackingID | string | false |
status | string | false |
referenceNumber | string | false |
userData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData | false |
transactionType | string | false |
requestTime | string | false |
expirationTime | string | false |
financialTransactionIdentifier | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifier | false |
lastUpdate | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
name | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
name | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Payment instruction list.
Name | Data Type | Required |
---|---|---|
paymentInstruction | com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList$PaymentInstruction array | true |
orderId | string | true |
Payment instruction.
Name | Data Type | Required |
---|---|---|
piId | string | true |