Skip to main content
GET
/
commerce
/
returns
/
{returnId}
/
payments
/
{paymentId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "groupId": {
    "targetType": "<string>",
    "targetId": "<string>",
    "targetNumber": 123
  },
  "paymentServiceTransactionId": "<string>",
  "availableActions": [
    "<string>"
  ],
  "orderId": "<string>",
  "paymentType": "<string>",
  "paymentWorkflow": "<string>",
  "externalTransactionId": "<string>",
  "billingInfo": {
    "paymentType": "<string>",
    "paymentWorkflow": "<string>",
    "billingContact": {
      "id": 123,
      "email": "<string>",
      "firstName": "<string>",
      "middleNameOrInitial": "<string>",
      "lastNameOrSurname": "<string>",
      "companyOrOrganization": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "cityOrTown": "<string>",
        "stateOrProvince": "<string>",
        "postalOrZipCode": "<string>",
        "countryCode": "<string>",
        "addressType": "<string>",
        "isValidated": true
      }
    },
    "isSameBillingShippingAddress": true,
    "card": {
      "paymentOrCardType": "<string>",
      "cardNumberPartOrMask": "<string>",
      "expireMonth": 123,
      "expireYear": 123,
      "bin": "<string>",
      "paymentServiceCardId": "<string>",
      "isUsedRecurring": true,
      "nameOnCard": "<string>",
      "isCardInfoSaved": true,
      "isTokenized": true,
      "ccLastFour": "<string>"
    },
    "token": {
      "paymentServiceTokenId": "<string>",
      "type": "<string>"
    },
    "purchaseOrder": {
      "purchaseOrderNumber": "<string>",
      "paymentTerm": {
        "code": "<string>",
        "description": "<string>"
      },
      "customFields": [
        {
          "code": "<string>",
          "label": "<string>",
          "value": "<string>"
        }
      ]
    },
    "check": {
      "checkNumber": "<string>"
    },
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    },
    "storeCreditCode": "<string>",
    "storeCreditType": "<string>",
    "customCreditType": "<string>",
    "externalTransactionId": "<string>",
    "isRecurring": true,
    "recurringTransactionId": "<string>",
    "data": {}
  },
  "data": {},
  "status": "<string>",
  "subPayments": [
    {
      "status": "<string>",
      "amountCollected": 123,
      "amountCredited": 123,
      "amountRequested": 123,
      "amountRefunded": 123,
      "target": {
        "targetType": "<string>",
        "targetId": "<string>",
        "targetNumber": 123
      }
    }
  ],
  "interactions": [
    {
      "id": "<string>",
      "gatewayInteractionId": 123,
      "paymentId": "<string>",
      "orderId": "<string>",
      "target": {
        "targetType": "<string>",
        "targetId": "<string>",
        "targetNumber": 123
      },
      "currencyCode": "<string>",
      "interactionType": "<string>",
      "checkNumber": "<string>",
      "status": "<string>",
      "paymentEntryStatus": "<string>",
      "isRecurring": true,
      "isManual": true,
      "isPending": true,
      "gatewayTransactionId": "<string>",
      "gatewayAuthCode": "<string>",
      "gatewayAVSCodes": "<string>",
      "gatewayCVV2Codes": "<string>",
      "gatewayResponseCode": "<string>",
      "gatewayResponseText": "<string>",
      "gatewayResponseData": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "paymentTransactionInteractionIdReference": 123,
      "amount": 123,
      "note": "<string>",
      "interactionDate": "2023-11-07T05:31:56Z",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "returnId": "<string>",
      "refundId": "<string>",
      "capturableShipmentsSummary": [
        {
          "shipmentNumber": 123,
          "shipmentTotal": 123,
          "amountApplied": 123
        }
      ]
    }
  ],
  "isRecurring": true,
  "amountCollected": 123,
  "amountCredited": 123,
  "amountRequested": 123,
  "changeMessages": [
    {
      "id": "<string>",
      "correlationId": "<string>",
      "userId": "<string>",
      "userFirstName": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "subjectType": "<string>",
      "success": true,
      "identifier": "<string>",
      "subject": "<string>",
      "verb": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "oldValue": "<string>",
      "newValue": "<string>",
      "amount": 123,
      "createDate": "2023-11-07T05:31:56Z",
      "attributes": {}
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "gatewayGiftCard": {
    "id": "<string>",
    "cardNumber": "<string>",
    "cardPin": "<string>",
    "amount": 123,
    "currencyCode": "<string>"
  },
  "installmentPlanCode": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
returnId
string
required
​
paymentId
string
required

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.)

​
id
string | null

Unique identifier of this order transaction.

​
groupId
object
​
paymentServiceTransactionId
string | null

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

​
availableActions
string[] | null

Actions available to the payment

​
orderId
string | null

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

​
paymentType
string | null

Type of Payment

​
paymentWorkflow
string | null

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

​
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

​
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.

​
data
object

Custom data from payment providers

​
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.

​
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.)

​
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.

​
changeMessages
object[] | null

Change messages related to the payment.

​
auditInfo
object
​
gatewayGiftCard
object
​
installmentPlanCode
string | null

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