Skip to main content
GET
/
commerce
/
orders
/
{orderId}
/
payments
/
{paymentId}
Error
A valid request URL is required to generate request examples
{
  "amountCollected": 123,
  "amountCredited": 123,
  "amountRequested": 123,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "availableActions": [
    "<string>"
  ],
  "billingInfo": {
    "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>"
    }
  },
  "changeMessages": [
    {
      "amount": 123,
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "attributes": {},
      "correlationId": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "identifier": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "subject": "<string>",
      "subjectType": "<string>",
      "success": true,
      "userFirstName": "<string>",
      "userId": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "verb": "<string>"
    }
  ],
  "data": {},
  "externalTransactionId": "<string>",
  "gatewayGiftCard": {
    "amount": 123,
    "cardNumber": "<string>",
    "cardPin": "<string>",
    "currencyCode": "<string>",
    "id": "<string>"
  },
  "groupId": {
    "targetId": "<string>",
    "targetNumber": 123,
    "targetType": "<string>"
  },
  "id": "<string>",
  "installmentPlanCode": "<string>",
  "interactions": [
    {
      "amount": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "capturableShipmentsSummary": [
        {
          "amountApplied": 123,
          "shipmentNumber": 123,
          "shipmentTotal": 123
        }
      ],
      "checkNumber": "<string>",
      "currencyCode": "<string>",
      "gatewayAVSCodes": "<string>",
      "gatewayAuthCode": "<string>",
      "gatewayCVV2Codes": "<string>",
      "gatewayInteractionId": 123,
      "gatewayResponseCode": "<string>",
      "gatewayResponseData": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "gatewayResponseText": "<string>",
      "gatewayTransactionId": "<string>",
      "id": "<string>",
      "interactionDate": "2023-11-07T05:31:56Z",
      "interactionType": "<string>",
      "isManual": true,
      "isPending": true,
      "isRecurring": true,
      "note": "<string>",
      "orderId": "<string>",
      "paymentEntryStatus": "<string>",
      "paymentId": "<string>",
      "paymentTransactionInteractionIdReference": 123,
      "refundId": "<string>",
      "returnId": "<string>",
      "status": "<string>",
      "target": {
        "targetId": "<string>",
        "targetNumber": 123,
        "targetType": "<string>"
      }
    }
  ],
  "isRecurring": true,
  "orderId": "<string>",
  "paymentServiceTransactionId": "<string>",
  "paymentType": "<string>",
  "paymentWorkflow": "<string>",
  "status": "<string>",
  "subPayments": [
    {
      "amountCollected": 123,
      "amountCredited": 123,
      "amountRefunded": 123,
      "amountRequested": 123,
      "status": "<string>",
      "target": {
        "targetId": "<string>",
        "targetNumber": 123,
        "targetType": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
orderId
string
required

Unique identifier of the order whose payment transaction you want to get.

​
paymentId
string
required

Unique identifier of the payment transaction you want to get.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Payment transaction associated with this order. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal. (PayPal not currently supported.)

​
amountCollected
number<double>

Amount collected on the payment

​
amountCredited
number<double>

Amount credited back to the payment.

​
amountRequested
number<double>

Derived from the Amount on the initial payment create, used to help storefront determine how much can be captured for multiple payments. See Order.AmountRemainingForPayment for an example.

​
auditInfo
object
​
availableActions
string[] | null

Actions available to the payment

​
billingInfo
object

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

​
changeMessages
object[] | null

Change messages related to the payment.

​
data
object

Custom data from payment providers

​
externalTransactionId
string | null

The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout

​
gatewayGiftCard
object
​
groupId
object
​
id
string | null

Unique identifier of this order transaction.

​
installmentPlanCode
string | null

Stores the Installment Plan code. Installment is only supported on subscription orders

​
interactions
object[] | null

List of interactions for this transaction. A transaction is created upon authorization and lasts across the payment interchange, which can consist of multiple interactions, such as consecutive captures.

​
isRecurring
boolean

If true, the product is purchased or fulfilled at regular intervals, for example, monthly billing or a subscription. (Not currently supported.)

​
orderId
string | null

Unique identifier of the order with which this transaction is associated.

​
paymentServiceTransactionId
string | null

Unique identifier of the transaction, specified by the payment service processesing this transaction.

​
paymentType
string | null

Type of Payment

​
paymentWorkflow
string | null

The source of data for this payment. By default, this will be set to 'mozu'

​
status
string | null

Current status of this transaction which are described by the PaymentStatusConst class.

​
subPayments
object[] | null

List of sub payments that correspond to child orders in case of multiship orders.