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”
}

 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”
}

 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”
}

INVOICE

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

PAPERCHECK

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