API  INTEGRATION

  PAYMENT OBJECTS

Every order posted to the order endpoint must contain a payment object. Below are examples of each type, followed by a table listing the fields. Additionally, CREDITCARD has different required data, depending on how the card was handled and is to be handled by ShipRight. Note that the paymentMethodCode depends on what credit card types are accepted by the client. ShipRight will provide valid codes for each client.

CREDITCARD
– ShipRight to handle authorization and capture
– Pre-Authorized  at time of order, ShipRight to capture
– Authorized and captured at time of order
INVOICE
PAPERCHECK

CREDITCARD (ShipRight to handle authorization and capture)

“paymentMethodCode”: “V”,
“prePaid”: false,
“paymentInstrumentType”: “CREDITCARD”,
“creditCard”: {
“creditCardNumber”: “4530910000012345”,
“cvnResultCode”: “P”,
“expiration”: “2015-01-01T00:00:00Z”
}

Field Example Data Type Max Length Additional Notes
paymentMethodCode V String 1 Required
prePaid false True/False Required
paymentInstrumentType CREDITCARD String Required
creditCard “creditCard”: { Beginning of node. Required
creditCardNumber 4530910000012345 Number 24 Required
cvnResultCode P String 6 Optional (This is not the CVN/CVV2 code)
expiration 2015-01-01T00:00:00Z Date Required

 CREDITCARD (Pre-Authorized  at time of order, ShipRight to capture)

“paymentMethodCode”: “M”,
“prePaid”: false,
“paymentInstrumentType”: “CREDITCARD”,
“creditCard”: {
“creditCardNumber”: “5191330000004415”,
“cvnResultCode”: “P”,
“expiration”: “2015-01-01T00:00:00Z”
“authorizationDate”: “2014-03-12T16:00:00Z”,
“authorizationCode”: “ac_scenario_9”,
“transactionID”: “76543219”
}

Field Example Data Type Max Length Additional Notes
paymentMethodCode M String 1 Required
prePaid false True/False Required
paymentInstrumentType CREDITCARD String Required
creditCard “creditCard”: { Beginning of node. Required
creditCardNumber 5191330000004415 Number 24 Required
cvnResultCode P String 6 Optional (This not the CVN/CVV2 code)
expiration 2015-01-01T00:00:00Z Date Required
authorizationDate 2014-03-12T16:00:00Z Date Time Required
authorizationCode ac_scenario_9 String 10 Required
transactionID 76543219 Number 10 Required

 CREDITCARD (Authorized and captured at time of order)

“paymentMethodCode”: “A”,
“prePaid”: true,
“paymentInstrumentType”: “CREDITCARD”,
“creditCard”: {
“creditCardNumber”: “370123456789017”,
“cvnResultCode”: “P”,
“expiration”: “2015-01-01T00:00:00Z”
“captureDate”: “2014-03-12T16:00:00Z”
“authorizationCode”: “ac_scenario_10”
“transactionID”: “765432110”
}

Field Example Data Type Max Length Additional Notes
paymentMethodCode A String 1 Required
prePaid true True/False Required
paymentInstrumentType CREDITCARD String Required
creditCard “creditCard”: { Beginning of node. Required
creditCardNumber 370123456789017 Number 24 Required
cvnResultCode P Number 6 Optional (This not the CVN/CVV2 code)
expiration 2015-01-01T00:00:00Z Date Required
captureDate 2014-03-12T16:00:00Z Date Time Required
authorizationCode ac_scenario_9 String 10 Required, but can be dummy info.
transactionID

INVOICE

“paymentMethodCode”: “I”,
“prePaid”: true,
“paymentInstrumentType”: “INVOICE”,
“invoice”: {
“reference”: ” ABC123456″
}

Field Example Data Type Max Length Additional Notes
paymentMethodCode I String 1 Required
prePaid true True/False Required
paymentInstrumentType INVOICE String Required
invoice “invoice”: { Beginning of node. Required
reference ABC123456 String 24 Required

PAPERCHECK

“paymentMethodCode”: “C”,
“prePaid”: true,
“paymentInstrumentType”: “PAPERCHECK”,
“invoice”: {
“reference”: ” ABC123456″
}

Field Example Data Type Max Length Additional Notes
paymentMethodCode C String 1 Required
prePaid true True/False Required
paymentInstrumentType PAPERCHECK String Required
invoice “invoice”: { Beginning of node. Required
reference ABC123456 String 24 Required