Get Billing Info

Retrieves the customer’s billing address.If paying by credit card, it retrieves the card’s number, expiration date, card holder’s name and billing address.

GET /commerce/orders/{orderId}/billinginfo

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "billingContact": {
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "address4": "<string>",
      "addressType": "<string>",
      "cityOrTown": "<string>",
      "countryCode": "<string>",
      "isValidated": true,
      "postalOrZipCode": "<string>",
      "stateOrProvince": "<string>"
    },
    "companyOrOrganization": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "id": 123,
    "lastNameOrSurname": "<string>",
    "middleNameOrInitial": "<string>",
    "phoneNumbers": {
      "home": "<string>",
      "mobile": "<string>",
      "work": "<string>"
    }
  },
  "card": {
    "bin": "<string>",
    "cardNumberPartOrMask": "<string>",
    "expireMonth": 123,
    "expireYear": 123,
    "paymentOrCardType": "<string>",
    "ccLastFour": "<string>",
    "isCardInfoSaved": true,
    "isTokenized": true,
    "isUsedRecurring": true,
    "nameOnCard": "<string>",
    "paymentServiceCardId": "<string>"
  },
  "check": {
    "checkNumber": "<string>"
  },
  "customCreditType": "<string>",
  "data": {},
  "externalTransactionId": "<string>",
  "isRecurring": true,
  "isSameBillingShippingAddress": true,
  "paymentType": "<string>",
  "paymentWorkflow": "<string>",
  "purchaseOrder": {
    "customFields": [
      {
        "code": "<string>",
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "paymentTerm": {
      "code": "<string>",
      "description": "<string>"
    },
    "purchaseOrderNumber": "<string>"
  },
  "recurringTransactionId": "<string>",
  "storeCreditCode": "<string>",
  "storeCreditType": "<string>",
  "token": {
    "paymentServiceTokenId": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId · string · required

Unique identifier of the order whose customer's payment source you want to get.

Query Parameters

draft · boolean

Determines whether the draft version should be retrieved if one exists.

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

Customer's payment details such as payment type (credit card, check by mail, or PayPal) and cardholder information if payment is by credit card.

auditInfo · object

Show child attributes

billingContact · object

Show child attributes

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.

Show child attributes

check · object

Show child attributes

customCreditType · string | null

Name of custom stored credit type

data · object

Custom data from payment providers

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

isSameBillingShippingAddress · boolean

Indicates that billing and shipping address are the same

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

purchaseOrder · object

Purchase order payment

Show child attributes

recurringTransactionId · string | null

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

storeCreditCode · string | null

The store credit to use for this purchase

storeCreditType · string | null

The type of store credit used for this purchase

token · object

Show child attributes