Create Payment Action For Return

post https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/returns/{returnId}/payments/actions

Sets the action of the specified payment transaction interaction. Available actions depend on the current status of the payment transaction.If in doubt, get a list of available payment actions first.

Path Params

returnId

string

required

Query Params

responseFields

string

limits which fields are returned in the response body

Body Params

Action to specify. Possible actions can be "Create," "Capture," "Void," "AuthCapture," or "ReceiveCheck."

actionName

string | null

Name of the Action to post

currencyCode

string | null

ISO currency code for the transaction. Currently, only USD is supported.

checkNumber

string | null

If paying by check, the check number.

returnUrl

string | null

If paying by Paypal Express or some other potential non-gateway payment provider, a return redirect URL must be provided.

cancelUrl

string | null

If paying by Paypal Express or some other potential non-gateway payment provider, a cancel redirect URL must be provided.
This will be used if something goes wrong on the third-party side.

amount

double | null

Amount of funds to withdraw to pay for this order.

interactionDate

date-time | null

Date the interaction occurred

newBillingInfo

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.

referenceSourcePaymentId

string | null

Reference payment id from which to copy the billing info.

manualGatewayInteraction

object

Represents a manually entered payment gateway interaction.

externalTransactionId

string | null

data

object | null

Custom data from payment providers

recaptcha

string | null

Recaptcha for validation.

installmentPlanCode

string | null

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

Response

Response body

object

string | null

Unique Identifier for this Return

customerAccountId

int32 | null

Unique identifier of the customer account.

visitId

string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

webSessionId

string | null

Identifies the web session used to place the order or last update the cart.

customerInteractionType

string | null

Determines the interaction type that a customer will use to create this object.
Valid values are: Website, Store, Call, Unknown

availableActions

array of strings | null

Current available actions.

availableActions

returnNumber

int32 | null

A human-facing identifier that is unique within a tenant to represent the sequential ordering of Returns.

contact

object

int32 | null

string | null

firstName

string | null

middleNameOrInitial

string | null

lastNameOrSurname

string | null

companyOrOrganization

string | null

phoneNumbers

object

address

object

locationCode

string | null

Location code where the return was made/processed

originalOrderId

string | null

The Id of the Order that this Return was generated from.

originalOrderNumber

int32 | null

The order number that this return was generated from.

returnOrderId

string | null

The Id of the Order that represents the items shipped to the shopper for this Return.

currencyCode

string | null

ISO Currency Code. Currently, only USD is supported.

status

string | null

The Status of the Return. Valid values are
Null, Created, ReturnAuthorized, ReturnPending, ReturnReceived, ReplacementShipped, Cancelled, and Closed.

receiveStatus

string | null

A rollup status describing whether the return items have been received.
See Mozu.CommerceRuntime.Contracts.Returns.Return.ReceiveStatusConst for possible values.

refundStatus

string | null

A rollup status describing whether the return items have been refunded.
See Mozu.CommerceRuntime.Contracts.Returns.Return.RefundStatusConst for possible values.

replaceStatus

string | null

A rollup status describing whether the return items have been marked as replaced.
See Mozu.CommerceRuntime.Contracts.Returns.Return.ReplaceStatusConst for possible values.

items

array of objects | null

The list of items being returned by the Shopper and replaced by the Merchant in this Return.

items

object

string | null

The identifer of the return

orderItemId

string | null

The OrderItem that this ReturnItem is associated with. Either the Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.Product or the OrderItemId must be present.

orderLineId

int32 | null

The OrderLineId that this ReturnItem is associated with. If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.OrderItemId is present, the OrderLineId should be present also.

orderItemOptionAttributeFQN

string | null

If this item refers to a product extra, provide the item's corresponding OptionAttributeFQN.

product

object

The product as it appears on the order item.

reasons

array of objects | null

For a given return reason (Damaged, Defective, MissingParts, DifferentExpectations, Late, NoLongerWanted, Other),
how many of the above OrderItem are to be replaced. This value is provided by the Shopper when they request a Return.

reasons

object

reason

string | null

The reason this item has been returned.

quantity

int32

The quantity associated with this Reason.

excludeProductExtras

boolean | null

If this return item refers to a product/bundle that has product extras, this specifies whether those child items should be included or excluded.
For backward compatibility, a null value will be treated as false, i.e. include the extras.

returnType

string | null

Specifies whether the requested resolution for this item is Refund or Replace.

returnNotRequired

boolean

Specifies whether this item should be returned to the merchant, e.g. if the item is irreparably damaged and it's not worth shipping back.
Even if this is set to true, Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.QuantityShipped should still be set to the quantity of items involved in the return.

quantityReceived

int32

The amount of this item actually received from the shopper. It may differ from the sum of the ReturnReasons.
This is populated by the system when the Receive action is performed.

receiveStatus

string | null

Describes the receive status of this item.
If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ReturnNotRequired is {true}, then this should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReceiveStatusConst.NOT_REQUESTED.
Otherwise the value should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReceiveStatusConst.RECEIVED or Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReceiveStatusConst.WAITING depending on Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.QuantityReceived.

quantityShipped

int32

The quantity of this item fulfilled on the parent order.

replaceStatus

string | null

Describes the replace status of this item.
If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ReturnType is Mozu.CommerceRuntime.Contracts.Returns.Return.ReturnTypeConst.REFUND, then this should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReplaceStatusConst.NOT_REQUESTED.
Otherwise the value should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReplaceStatusConst.REPLACED or Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReplaceStatusConst.NOT_REPLACED depending on Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.QuantityReplaced.

quantityRestockable

int32

Of the quantity returned, how many of this item can be added back into the inventory? This item is set by the merchant via an UpdateReturn call.
It is used during the Restock action to set some quantity of this item back into the inventory management system.

quantityRestocked

int32

Field to specify How many items added to inventory

refundAmount

double | null

If a refund is issued for the return, how much of the refund amount is for this particular item.

returnProcessingFeeApplied

double | null

The processing fee on the item that gets persisted into the database

shippingAndHandlingRefunded

boolean | null

Determines if shipping and handling is returned on the item

quantityRefunded

int32

The quantity of the item being refunded is specified in this field

refundStatus

string | null

Describes the refund status of this item.
If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ReturnType is Mozu.CommerceRuntime.Contracts.Returns.Return.ReturnTypeConst.REPLACE, then this should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemRefundStatusConst.NOT_REQUESTED.
Otherwise the value should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemRefundStatusConst.REFUNDED or Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemRefundStatusConst.NOT_REFUNDED depending on Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.RefundAmount.

quantityReplaced

int32 | null

Specifies the quantity of this item that has been marked as replaced, i.e. it has been used to generate a replacement order for the return.
Note that the quantity replaced may not line up with the quantity of the item actually sent back to the shopper,
such as in the case of an exchange, e.g. swapping a medium shirt for a large shirt.

notes

array of objects | null

Any merchant-supplied notes for this ReturnItem.

notes

object

string | null

Unique identifier of the note. System-supplied and read-only.

text

string | null

Text of the note. Maximum 250 characters.

auditInfo

object

productLossAmount

double | null

The loss incurred of the returned products, used for accounting purposes.

productLossTaxAmount

double | null

The tax on the returned products, used for accounting purposes.

shippingLossAmount

double | null

The loss incurred of the returned product shipping, used for accounting purposes.

shippingLossTaxAmount

double | null

The tax on the returned product shipping, used for accounting purposes.

bundledProducts

array of objects | null

deprecated

Deprecated. Not used.

bundledProducts

object

productCode

string | null

Merchant-created code that uniquely identifies the product.

quantity

int32

The amount of this particular product in a bundle that is in this Return

totalWithoutWeightedShippingAndHandling

double | null

Taxable Subtotal including Weighted Order amounts

totalWithWeightedShippingAndHandling

double | null

Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs

shipmentItemId

int32 | null

The identifer of the item

shipmentNumber

int32 | null

data

object | null

Custom data for a given vendor set within the commerce process.

Has additional fields

inventoryTags

array of objects | null

inventoryTags

object

name

string | null

value

string | null

notes

array of objects | null

Any Merchant Notes for this Return.

notes

object

string | null

Unique identifier of the note. System-supplied and read-only.

text

string | null

Text of the note. Maximum 250 characters.

auditInfo

object

rmaDeadline

date-time | null

The deadline for a Shopper to ship the items in this Return to the Merchant.

returnType

string | null

Specifies whether this Return was a Refund or a Replace

refundAmount

double | null

If this Return was refunded, how much was credited to the shopper? This amount is summed from the refund payments.

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

payments

array of objects | null

Any Refund payments associated with this Return.

payments

object

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

array of strings | null

Actions available to the payment

availableActions

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 | null

Custom data from payment providers

Has additional fields

status

string | null

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

subPayments

array of objects | null

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

subPayments

object

status

string | null

amountCollected

double

amountCredited

double

amountRequested

double

amountRefunded

double

target

object

interactions

array of objects | null

List of intereactions 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.

interactions

object

string | null

Unique identifier of this payment transaction interaction.

gatewayInteractionId

int32 | null

Unique identifier of the gateway interaction. Used for credit card transactions, where the
payment service creates a GatewayInteractionId for each transaction interaction.

paymentId

string | null

Unique identifier of the original transaction of which this current interaction is a part.

orderId

string | null

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

target

object

currencyCode

string | null

ISO currency code for the transaction. Currently, only USD is supported.

interactionType

string | null

Types of transaction interactions which can be "Authorization," "Capture," "AuthorizeAndCapture,"
"Void," or "Credit," "CheckRequested," or "CheckReceived."

checkNumber

string | null

If paying by check, the check number.

status

string | null

Status of the payment transaction interaction which can be either "Success" or "Failure."

paymentEntryStatus

string | null

Status of the payment when the transaction interaction was created

isRecurring

boolean | null

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

isManual

boolean

If the payment is a manual payment, this is set to true

isPending

boolean

If true, indicates payment action is still pending and not yet confirmed.

gatewayTransactionId

string | null

Unique identifier of the transaction supplied by PCIaaS.

gatewayAuthCode

string | null

If required by the payment gateway, the authorization code of the transaction. Supplied by PCIaaS.

gatewayAVSCodes

string | null

Gateway AVS Codes. Supplied by PCIaaS.

gatewayCVV2Codes

string | null

Gateway CVV2 Codes. Supplied by PCIaaS.

gatewayResponseCode

string | null

Gateway response code. Supplied by PCIaaS.

gatewayResponseText

string | null

Gateway response text. Supplied by PCIaaS.

gatewayResponseData

array of objects | null

A List of payment response data required to act on authorization when using external order management systems

gatewayResponseData

object

key

string | null

Key from payment gateway

value

string | null

Value from payment gateway

paymentTransactionInteractionIdReference

int32 | null

Unique identifier of previous PaymentTransactionInteraction that this PaymentTransactionInteraction is modifying.
For instance, when crediting a capture, set the PaymentTransactionInteractionIdReference to the capture PaymentTransactionInteractionID.

amount

double | null

Amount of funds associated with this interaction.

note

string | null

Note to be entered by merchant/application

interactionDate

date-time | null

Date the interaction occurred

auditInfo

object

returnId

string | null

Return Id, if the interaction is a Credit for a return-refund.

refundId

string | null

Refund Id, if the interaction is for a stand alone refund.

capturableShipmentsSummary

array of objects | null

Stores pairings of shipment number to shipment total for all captured shipments. This was added for generating TLogs.

capturableShipmentsSummary

object

shipmentNumber

int32

The identifying number of the shipment affected by the payment action

shipmentTotal

double

The shipment's total when the payment action occurred

amountApplied

double

The amount applied by the payment action

isRecurring

boolean

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

amountCollected

double

Amount collected on the payment

amountCredited

double

Amount credited back to the payment.

amountRequested

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

array of objects | null

Change messages related to the payment.

changeMessages

object

string | null

Unique identifier of the message. System-supplied. Read-only.

correlationId

string | null

Correlation Id

userId

string | null

User Id that identifies the user that performed the related change

userFirstName

string | null

User First Name

userLastName

string | null

User Last Name

userScopeType

string | null

User Type (e.g. Shopper, Admin, etc.)

appId

string | null

App Id that identifies the user that performed the related change

appKey

string | null

App Key

appName

string | null

App Name

subjectType

string | null

Subject of the message, for example, "Product." System-supplied. Read-only.

success

boolean | null

Indicates if the message is related to a success or failure.

identifier

string | null

Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.

subject

string | null

Text on the subject line of the message, for example, the product name. System-supplied. Read-only.

verb

string | null

Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the
product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only.

message

string | null

Human readable message. System-supplied. Read-only.

metadata

string

Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.

oldValue

string | null

deprecated

Original price of the item. System-supplied. Read-only.

newValue

string | null

deprecated

Current price of the item. System-supplied. Read-only.

amount

double | null

deprecated

Monetary amount that pertains to the change if applicable

createDate

date-time | null

When the message was created. System-supplied. Read-only.

attributes

object | null

Additional Data. This property will be a Dictionary of objects.

Has additional fields

auditInfo

object

gatewayGiftCard

object

installmentPlanCode

string | null

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

packages

array of objects | null

Shipping package associated with this return.

packages

object

shippingMethodCode

string | null

Code describing the shipping method.

shippingMethodName

string | null

Name of the shipping method

shipmentId

string | null

ID of the related shipment

trackingNumber

string | null

Tracking number of this package (to support classic use cases)

trackingNumbers

array of strings | null

Tracking number of this package

trackingNumbers

packagingType

string | null

Packaging type of this package

hasLabel

boolean

If there is a shipping label present for this Package, this will be set to true

measurements

object

Physical dimensions of the package required to ship the product and its weight.

carrier

string | null

Carrier of this package

signatureRequired

boolean | null

SignatureRequired for this package

trackings

array of objects | null

Tracking number and url data for this package

trackings

object

attributes

object | null

Has additional fields

number

string | null

url

string | null

packingSlipItemDetails

array of objects | null

PackingSlipItemDetails for this package

packingSlipItemDetails

object

attributes

object | null

Gets or Sets Attributes

Has additional fields

lineId

int32 | null

Gets or Sets LineId

originalOrderItemId

string | null

Gets or Sets OriginalOrderItemId

quantity

int32 | null

Gets or Sets Quantity

packingSlipNumber

int32 | null

PackingSlipNumber for this package

returnTrackings

array of objects | null

returnTrackings

object

attributes

object | null

Has additional fields

number

string | null

url

string | null

returnTrackingNumbers

array of strings | null

returnTrackingNumbers

returnCarrier

string | null

packageId

string | null

manifestId

string | null

labelFormat

string | null

integratorId

string | null

fxcbPackNotificationId

string | null

fxcbDocumentsUrl

string | null

attributes

object | null

Has additional fields

string | null

ID of the fulfillment unit.

code

string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form
{fulfillmentUnitType} #{next available int}

status

string | null

Status of the fulfillment unit
See FulfillmentStatusConst

items

array of objects | null

List of items in the fulfillment unit

items

object

productCode

string | null

Code of the Product to be fulfilled.

quantity

int32

Quantity of the order item

fulfillmentItemType

string | null

The type of fulfillment item

lineId

int32 | null

The line id associated with the fulfillment.

optionAttributeFQN

string | null

fulfillmentDate

date-time | null

Date of the pickup

fulfillmentLocationCode

string | null

Location code from which to obtain this item

auditInfo

object

availableActions

array of strings | null

Actions that can be taken on this fulfillment unit

availableActions

changeMessages

array of objects | null

Change messages related to the fulfillment unit.

changeMessages

object

string | null

Unique identifier of the message. System-supplied. Read-only.

correlationId

string | null

Correlation Id

userId

string | null

User Id that identifies the user that performed the related change

userFirstName

string | null

User First Name

userLastName

string | null

User Last Name

userScopeType

string | null

User Type (e.g. Shopper, Admin, etc.)

appId

string | null

App Id that identifies the user that performed the related change

appKey

string | null

App Key

appName

string | null

App Name

subjectType

string | null

Subject of the message, for example, "Product." System-supplied. Read-only.

success

boolean | null

Indicates if the message is related to a success or failure.

identifier

string | null

Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.

subject

string | null

Text on the subject line of the message, for example, the product name. System-supplied. Read-only.

verb

string | null

message

string | null

Human readable message. System-supplied. Read-only.

metadata

string

Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.

oldValue

string | null

deprecated

Original price of the item. System-supplied. Read-only.

newValue

string | null

deprecated

Current price of the item. System-supplied. Read-only.

amount

double | null

deprecated

Monetary amount that pertains to the change if applicable

createDate

date-time | null

When the message was created. System-supplied. Read-only.

attributes

object | null

Additional Data. This property will be a Dictionary of objects.

Has additional fields

productLossTotal

double | null

The Total Loss Amount is equal to the (cost of item) * quantity of item returned.
It is meant to represent the product value to the merchant of the items damaged or returned by a shopper.

shippingLossTotal

double | null

The Shipping Loss Total is equal to the (shipping cost of item) * quantity of item returned.
It is meant to represent the product value to the merchant of the items damaged or returned by a shopper.

lossTotal

double | null

Sum of the ProductLossTotal and the ShippingLossTotal.

productLossTaxTotal

double | null

The Total Taxes assessed on the product loss.

shippingLossTaxTotal

double | null

The Total Taxes assessed on the shipping loss.

tenantId

int32 | null

Unique identifier of the Tenant.

siteId

int32 | null

Unique identifier of the Site.

userId

string | null

Unique identifier of the current user.

channelCode

string | null

Unique identifier of the channel for this item.

changeMessages

array of objects | null

Change messages related to the return.

changeMessages

object

string | null

Unique identifier of the message. System-supplied. Read-only.

correlationId

string | null

Correlation Id

userId

string | null

User Id that identifies the user that performed the related change

userFirstName

string | null

User First Name

userLastName

string | null

User Last Name

userScopeType

string | null

User Type (e.g. Shopper, Admin, etc.)

appId

string | null

App Id that identifies the user that performed the related change

appKey

string | null

App Key

appName

string | null

App Name

subjectType

string | null

Subject of the message, for example, "Product." System-supplied. Read-only.

success

boolean | null

Indicates if the message is related to a success or failure.

identifier

string | null

Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.

subject

string | null

Text on the subject line of the message, for example, the product name. System-supplied. Read-only.

verb

string | null

message

string | null

Human readable message. System-supplied. Read-only.

metadata

string

Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.

oldValue

string | null

deprecated

Original price of the item. System-supplied. Read-only.

newValue

string | null

deprecated

Current price of the item. System-supplied. Read-only.

amount

double | null

deprecated

Monetary amount that pertains to the change if applicable

createDate

date-time | null

When the message was created. System-supplied. Read-only.

attributes

object | null

Additional Data. This property will be a Dictionary of objects.

Has additional fields

actionRequired

boolean

To find Returns that have failed to refund.

isUnified

boolean

Was this return created by the Unified platform.

canInitiateRefund

boolean

To identify Return is refundable or not.

refundToGC

boolean

If this Flag is true, Refund will be done on new Gift Card.

shipOrBillCountryCode

string | null

ShipOrBillCountryCode contains country code of shipping address or Billing address

externalId

string | null

A return can be created from an external system. This field is used to store the external id.

overrideReturnRule

boolean

When this is set to true, the return rules will be ignored, and a return will be created without any checks.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/returns/returnId/payments/actions \
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