Set Billing Info

put https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/orders/{orderId}/billinginfo

Adds a payment source to the order.

Path Params

orderId

string

required

Unique identifier of the order whose payment source you want to update.

Query Params

updateMode

string

Determines the update strategy for this update (ApplyAndCommit, ApplyToOriginal, ApplyToDraft).

version

string

Determines whether or not to check versioning of items for concurrency purposes.

responseFields

string

limits which fields are returned in the response body

Body Params

All the properties that you want the payment source object to contain.

paymentType

string | null

Type of payment, such as credit card, check by mail, or PayPal.
see Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values

paymentWorkflow

string | null

billingContact

object

isSameBillingShippingAddress

boolean

Indicates that billing and shipping address are the same

card

object

If the customer is paying by credit card, the card holder's details, such as the name on the card, number, billing
address, and expiration dates.

token

object

purchaseOrder

object

Purchase order payment

check

object

auditInfo

object

storeCreditCode

string | null

The store credit to use for this purchase

storeCreditType

string | null

The type of store credit used for this purchase

customCreditType

string | null

Name of custom stored credit type

externalTransactionId

string | null

Transaction Id from third party payment source like Visa Checkout, Amazon

isRecurring

boolean

Indicates whether the payment is used in recurring transactions. ex- subscription payments

recurringTransactionId

string | null

Recurring Payment Id returned by Payment Gateway
networkTransactionId for vantiv
previousTransactionId for cybersource etc

data

object | null

Custom data from payment providers

Response

Response body

object

paymentType

string | null

Type of payment, such as credit card, check by mail, or PayPal.
see Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values

paymentWorkflow

string | null

billingContact

object

int32 | null

string | null

firstName

string | null

middleNameOrInitial

string | null

lastNameOrSurname

string | null

companyOrOrganization

string | null

phoneNumbers

object

address

object

isSameBillingShippingAddress

boolean

Indicates that billing and shipping address are the same

card

object

If the customer is paying by credit card, the card holder's details, such as the name on the card, number, billing
address, and expiration dates.

paymentServiceCardId

string | null

Credit card number.

isUsedRecurring

boolean | null

If true, the credit card is charged on a regular interval, such as for a subscription. (Not supported currently.)

nameOnCard

string | null

Card holder's name as it appears on the card.

isCardInfoSaved

boolean

If true, the card information is stored in the customer's account.

isTokenized

boolean

If true, the card is tokenized by external provider

ccLastFour

string | null

Last four digit of Credit card
Only for OMS Only tenant.

paymentOrCardType

string | null

Card type such as Visa, MasterCard, American Express, or Discover.

cardNumberPartOrMask

string | null

The visible part of the card number that the merchant uses to refer to
payment information, for example, the last for digits of the card number.

expireMonth

int32

Month when the card expires.

expireYear

int32

Year when the card expires.

bin

string | null

Year when the card expires.

token

object

paymentServiceTokenId

string | null

type

string | null

purchaseOrder

object

Purchase order payment

purchaseOrderNumber

string | null

Purchase order number

paymentTerm

object

customFields

array of objects | null

Memo/custom fields

customFields

object

code

string | null

label

string | null

value

string | null

check

object

checkNumber

string | null

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

storeCreditCode

string | null

The store credit to use for this purchase

storeCreditType

string | null

The type of store credit used for this purchase

customCreditType

string | null

Name of custom stored credit type

externalTransactionId

string | null

Transaction Id from third party payment source like Visa Checkout, Amazon

isRecurring

boolean

Indicates whether the payment is used in recurring transactions. ex- subscription payments

recurringTransactionId

string | null

Recurring Payment Id returned by Payment Gateway
networkTransactionId for vantiv
previousTransactionId for cybersource etc

data

object | null

Custom data from payment providers

Has additional fields

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/orders/orderId/billinginfo \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success