Update Payment API

Apply payment details to a cart before placing the order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Schema

ParameterTypeDescription
cartIdStringCart ID to update.
paymentDetailsString (JSON array)JSON-encoded array of payment objects (fields below).
paymentDetails[].OuterIdStringClient-side reference ID for the payment entry.
paymentDetails[].AmountNumberAmount paid via this method.
paymentDetails[].PaymentGatewayCodeStringPayment gateway code, e.g. DefaultManualPaymentMethod.
paymentDetails[].PriceNumberPrice associated with the payment entry.
paymentDetails[].DiscountAmountNumberDiscount applied on this entry.
paymentDetails[].TaxPercentRateNumberTax percentage applied on this entry.
paymentDetails[].CurrencyCodeStringCurrency code for the payment, e.g. INR.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.updatePaymentobjectContainer for the payment update result.
data.updatePayment.statusnumberAPI execution status (1 = success).
data.updatePayment.messagestringResult message (e.g. Payment updated successfully).

Implementation Notes

  1. paymentDetails must be sent as a JSON-encoded string containing an array of payment objects.
  2. Set payment on the cart with this call before calling Place Cart Order.
  3. This response is taken from an actual staging call.
Body Params
string
Defaults to plumProAPI.mutation.updatePayment

Please use 'plumProAPI.mutation.updatePayment' always in query

string
Defaults to plumProAPI
data
object
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json