d

KIBO OMS DOCUMENTATION

Create Payment

The customer payment method is initialized with the Create Payment API. This allows details of the payment to be set up based on a set of eight options, each representing a different form of payment such as a credit card via CyberSource or PayPal.

Version2.0
Callhttps://integration.shopatron.com/api/v2/payment/
Supported FormatsJSON
HTTP MethodPOST
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

The example case creates an API call to create a payment with the following properties:

  • CyberSource credit card payment
  • Paying for OrderĀ 12345678 from Manufacturer 10101

This guide will demonstrate how to put together each section of the request to create this payment.

Required Parameters

The required parameters to create a payment are:

ParameterTypeDescription
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

Other possible parameters can be provided to specify other details about the payment. These variables are:

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

ParameterTypeDescription
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 through CyberSource, based on the last four card digits. Go to the schema for the full list of available options.

ParameterTypeDescription
paymentTypeenumA CyberSource payment type (CS).
cardIssuerenumThe abbreviation for the card issuer (VI, BC, etc.).
ccLastFourstringThe last four digits of the credit card number.
cardTokenstringA string token from CyberSource that represents the card number. The minimum length is 16.
cardExpirationstringThe card expiration date, ex: 04-2018.

The Full Request

This is the entire request that will create the payment.

{
 "orderID": 12345678,
 "customerPaymentMethod": {
   "manufacturerID": 10101,
   "catalogID": 1,
   "currency": "USD",
   "customerID": "00001111",
   "billingAddressID": "12121212",
   "paymentType": "CS",
   "cardIssuer": "VI",
   "ccLastFour": "0000",
   "cardToken": "12345678987654321",
   "cardExpiration": "00-0000"
 }
}

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


Megan MayfieldOMS Dev: Create Payment