KIBO OMS DOCUMENTATION

Edit Payment

The Payment API allows an existing payment method to be edited. The entire structure of the payment method or only certain details can be changed as necessary.

Version2.0
Callhttps://integration.shopatron.com/api/v2/payment/{paymentID}
Supported FormatsJSON
HTTP MethodPUT
Schemahttps://integration.shopatron.com/api/v2/schema/payment.json

The .json address above can be used to access the schema within Postman. An example use of the Payment API follows here — or go directly to the schema or the sample Postman Collection.

Example

This example case creates a call that will edit an existing payment. The request will specify the following properties:

  • Customer 900000 paying for Order 232323
  • Setting payment as a standard credit card

This guide will demonstrate how to put together each section of the call to make these changes.

Required Parameters

Two parameters are always required to edit a payment:

ParametersTypeDescription
orderIDintegerA unique identifier for the order. The minimum value is "1".
customerPaymentMethodobjectThe payment information for the customer’s method. One of 8 options.

Optional Parameters

The API can also change these additional elements:

ParametersTypeDescription
paymentIDintegerA unique identifier for the payment. The minimum value is "0".
holdTypeenumThe type of the payment hold (WAITING_FOR_PAYMENT) if applicable.
maxChargenumberThe maximum amount to charge, or -1 for no max.
amountChargednumberThe actual amount be charged as payment.

Customer Payment Method

There are eight different options for building a customer’s payment method (/customerPaymentMethod/{object}). The below properties are used as a base for all methods, with only billingAddressID being required.

ParametersTypeDescription
paymentMethodIDintegerA unique identifier for the payment method. The minimum value is "1".
customerIDstringA unique identifier for the customer, usually an integer. The minimum length is 1.
billingAddressIDstringA unique identifier for the billing address, usually an integer. The minimum length is 1.
manufacturerIDintegerA unique identifier for the manufacturer. The minimum value is "1".
catalogIDintegerThe catalog number for a manufacturer. The minimum value is "0".
currencyenumThe International Standards Organization Code for the payment currency (USD, CAD, etc.).
localeenumThe Internet Engineering Task Force code for the language. The default is "en-US".

From here, the other parameters vary depending on how the customer is paying. This example uses the below structure for a standard card payment, based on the full card number. Go to the schema for the full list of available options.

ParametersTypeDescription
paymentTypeenumThe payment type (CC).
cardIssuerenumThe abbreviation for the card issuer (VI, BC, etc.).
cardNumberstringThe full credit card number.
cardSecurityCodestringThe Card Security Code or Card Verification Value number. The maximum length is 20.
cardExpirationstringThe card expiration date, ex: 04-2018.

The Full Request

This is the full request that will edit a payment method.

{ 
 "orderID":232323,
 "customerPaymentMethod":{
   "billingAddressID":1111111,
   "customerID":900000,
   "paymentType":"CC",
   "cardIssuer":"VI",
   "cardNumber":"4111111111111111",
   "cardSecurityCode":"123",
   "cardExpiration":"02-2018"
 },
 "maxCharge":1000
}

The returned response follows the same structure as the Get Payment API, providing information about the payment that was changed.


Megan MayfieldOMS Dev: Edit Payment