PaymentResponse

Use an object based on PaymentResponse to represent the response after a customer has completed a payment.

Properties marked as not required are required if the corresponding properties are set to true in the PaymentOptions of the corresponding PaymentRequest.

Properties

Property	Type	Description	Required
`requestId`	string	The unique identifier for the request that this response corresponds to. `requestId` is set in the PaymentConfiguration of the PaymentRequest.	Yes
`container`	PaymentContainer	The details that were sent to the payment processor to complete payment.	Yes
`containerDescription`	string	A human-readable description of the payment method selected by the customer that can appear in subsequent merchant messages such as confirmation pages.	Yes
`payerEmail`	string	The email address provided by the customer.	No
`payerPhone`	string	The phone number provided by the customer.	No
[deprecated] `shippingOptionId`	string	The ID of the ShippingOption selected by the customer. NOTE: This field is now deprecated. Please use `fulfillmentOptionId` instead.	No
`fulfillmentOptionId`	string	The ID of the FulfillmentOption selected by the customer.	No
`pickupName`	string	The pickup name provided by the customer.	No
`pickupEmail`	string	The pickup email address provided by the customer.	No
`pickupPhone`	string	The pickup phone number provided by the customer.	No
`shippingAddress`	PaymentAddress	The shipping address that was provided by the customer.	No
`billingAddress`	PaymentAddress	The billing address that was provided by the customer.	No
`offers`	Array<Offer>	A list of offers applied to the transaction.	No

PaymentResponse

Properties

See Also