Retrieve payment instrument details for an order.
Operation ID: getPaymentMethodsForOrderGets the applicable payment methods for an existing order considering the open payment amount only.
curl "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-orders/v1/organizations/{organizationId}/orders/{orderNo}/payment-methods?siteId=RefArch"
An identifier for the organization the request is being made by
f_ecom_zzxy_prd
The order number
00000410
The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
RefArch
A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter Accept-Language
following RFC 2616 & RFC 1766. This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
en-US
Success, the response body contains the applicable payment methods for the order.
{
"applicablePaymentMethods": [
{
"id": "GIFT_CERTIFICATE",
"name": "Gift Certificate",
"paymentProcessorId": "BASIC_GIFT_CERTIFICATE"
},
{
"cards": [
{
"cardType": "Visa",
"checksumVerificationEnabled": true,
"name": "Visa",
"numberLengths": [
"13",
"16"
],
"numberPrefixes": [
"4"
],
"securityCodeLength": 3
},
{
"cardType": "Amex",
"checksumVerificationEnabled": true,
"name": "American Express",
"numberLengths": [
"15"
],
"numberPrefixes": [
"34",
"37"
],
"securityCodeLength": 4
},
{
"cardType": "Master Card",
"checksumVerificationEnabled": true,
"name": "MasterCard",
"numberLengths": [
"16"
],
"numberPrefixes": [
"51-55"
],
"securityCodeLength": 3
},
{
"cardType": "Discover",
"checksumVerificationEnabled": true,
"name": "Discover",
"numberLengths": [
"16"
],
"numberPrefixes": [
"6011",
"622126-622925",
"644-649",
"65"
],
"securityCodeLength": 3
}
],
"id": "CREDIT_CARD",
"name": "Credit Card",
"paymentProcessorId": "BASIC_CREDIT"
},
{
"id": "PayPal",
"name": "Pay Pal",
"paymentProcessorId": "PAYPAL_EXPRESS"
},
{
"id": "BML",
"name": "Bill Me Later",
"paymentProcessorId": "CYBERSOURCE_BML"
}
]
}
The applicable payment methods. It is read only.