Reference

Authentication

The methods here follow the Responses and errors conventions.

Generate Token

Generates the authentication token.

POST /v2/token

Information	Value
URL	/v2/token
Request method (verb)	POST
Requires authentication?	No

Request headers

Name	Required?	Value
Content-Type	Yes	application/x-www-form-urlencoded

Request arguments

Name	Type	Required?	Notes
username	string	Yes	The username provided by our team
password	string	Yes	The password provided by our team

Request sample

<?php

$headers = array(
  "Content-Type: application/x-www-form-urlencoded"
);

$fields = array(
  "username" => "foo",
  "password" => "bar"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/token");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, "username=foo&password=bar");

$response = curl_exec($ch);
$decoded = json_decode($response, TRUE);
$authentication_token = $decoded["jwt"];

echo "Authentication token is ".$authentication_token;

Response fields

Name	Type	Nullable?	Notes
jwt	string	No	The authentication token

Response sample

{
  "jwt": <value>
}

Important

Token will be valid for 1 hour. If a 401 Unauthorized response is returned by any other endpoint you will need to generate a new token and update your next requests.

Calculator

The methods here follow the Responses and errors conventions.

Lowest Payment Option

Returns the monthly lowest payment option, financed period, and early buyout options for a specific store.

POST /v2/calculator/store/[code]/amount/[financedAmount]/lowestPaymentOption

Information	Value
URL	/v2/calculator/store/{code}/amount/{financedAmount}/lowestPaymentOption
Request method (verb)	POST
Requires authentication?	No

Request headers

Name	Required?	Value
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Notes
code	string	Yes	The store code
financedAmount	decimal	Yes	Financed amount

Request sample

<?php

$store_code = "FOO";
$financed_amount = 1234;

$headers = array(
  "Content-Type: application/json"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/calculator/store/".$store_code."/amount/".$financed_amount."/lowestPaymentOption");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, array());

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
financingPartnerCode	string	No	Financing Partner's Code
financingPartnerName	string	No	Financing Partner's Name
financingPartnerDisplayName	string	No	Financing Partner's Display Name
profileId	int	No	Profile's Id
profileName	string	No	Profile's Name
minCreditScore	decimal	No	Credit Score for minimum monthly payment value
minMonthlyPayment	decimal	No	Monthly Payment minimum value
maxCreditScore	decimal	No	Credit Score for maximun monthly payment value
maxMonthlyPayment	decimal	No	Monthly Payment maximum value
financePeriod	int	No	Finance Period
disclaimer	string	Yes	Offer disclaimer
earlyBuyoutOptions	array of object	No	Early Buyout options

Early Buyout option fields:

Name	Type	Nullable?	Notes
month	int	No	Month
earlyBuyoutPayment	decimal	No	Early Buyout Payment value
savingsPercentage	decimal	No	Savings percentage

Response sample

{
  "financingPartnerCode": <value>,
  "financingPartnerName": <value>,
  "financingPartnerDisplayName": <value>,
  "profileId": <value>,
  "profileName": <value>,
  "minCreditScore": <value>,
  "minMonthlyPayment": <value>,
  "maxCreditScore": <value>,
  "maxMonthlyPayment": <value>,
  "financePeriod": <value>,
  "disclaimer": <value>,
  "earlyBuyoutOptions": [
    {
      "month": <value>,
      "earlyBuyoutPayment": <value>,
      "savingsPercentage": <value>
    }
  ]
}

Application

The methods here follow the Responses and errors conventions.

Create Application

Creates a new application.

POST /v2/applications

Information	Value
URL	/v2/applications
Request method (verb)	POST
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json
Callback-Url	No	URL to be posted when there is an update on the status of the application (see Callback notification)

Request arguments

Name	Type	Required?	Constraints	Notes
storeCode	string	Yes
firstName	string	Yes	Maximum length is 100 characters	Customer's First Name
middleInitial	string	No	Maximum length is 100 characters	Customer's Middle Initial
lastName	string	Yes	Maximum length is 100 characters	Customer's Last Name
dateOfBirth	datetime	No	Must be at least 18 years old	Customer's Date of Birth
mobilePhone	string	Yes	Must follow the patterns: 999-999-9999 or 9999999999	Customer's Mobile Phone
email	string	No	Maximum length is 100 characters	Customer's E-mail
address	object	No		Customer's Address
products	array of object	Yes		List of products
redirectUrl	string	No		URL to redirect the customer back to the retailer website if he signs the contract. Only executed when the checkout plugin uses data-type="redirect" and not executed for modal or popup.
cancelUrl	string	No		If passed in this URL will be used to redirect the customer back to the retailer website if he closes the integration without signing a contract otherwise the redirectUrl will be used. Only executed when the checkout plugin uses data-type="redirect" and not executed for modal or popup.
referenceNumber	string	No	Must be unique	Invoice Reference Number

Address arguments:

Name	Type	Required?	Constraints	Notes
street	string	No	Maximum length is 40 characters and PO boxes are not allowed	Street
suiteApartment	string	No	Maximum length is 5 characters	Suite/Apartment
city	string	No	Maximum length is 25 characters	City
state	string	No	Must be exactly 2 upper-case letters and a valid US state abbreviation	State
zipCode	string	No	Maximum length is 5 characters	Zip Code

Product arguments:

Name	Type	Required?	Constraints	Notes
id	string	No	Maximum length is 256 characters	ID
serialNumber	string	No	Maximum length is 256 characters	Serial Number
description	string	Yes	Maximum length is 256 characters	Description
quantity	decimal	Yes	Must be greater than 0	Quantity
value	decimal	Yes		Extended Product Value - without sales tax if sales tax is being sent as a separate Product. Include the sales tax in the value if it is not sent as a separate Product. If you have a quantity of 2, the value would represent both products combined, not each product.

Best Practice

Products in the "product" array should include items such as merchandise, shipping, insurance, coupons, total sales tax, etc. as separate items.  This method provides the greatest clarity for both the retailer and the consumer to identify the itemized costs.  Note that the cart total is the sum of all product array "value" parameters; as an example, coupons and discounts should be included as negative values.

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$fields = array(
  "storeCode" => "LIPSUM",
  "firstName" => "Lorem",
  "lastName" => "Ipsum",
  "dateOfBirth" => "1983-04-01",
  "mobilePhone" => "123-456-789",
  "email" => "lorem@ipsum.com",
  "referenceNumber" =>  "3456789",

  "address" => array(
    "street" => "45999 Center Oak Plaza",
    "suiteApartment" => "100",
    "city" => "Sterling",
    "state" => "VA",
    "zipCode" => "20166"
  ),

  "products" => array(
    array(
      "id" => "1",
      "description" => "Foo",
      "serialNumber" => "FOO001",
      "quantity" => "1",
      "value" => "1000.00"
    ),

    array(
      "id" => "2",
      "description" => "Bar",
      "serialNumber" => "BAR001",
      "quantity" => "2",
      "value" => "2200.00"
    )
  )
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
publicId	string	No	The Public ID associated with the last checkout attempt. Always store this publicId with your cart information to future reference.
link	string	No	URL to redirect the user to our website to complete the process

Response sample

{
  "publicId": <value>,
  "link": <value>
}

Return Status

Returns the application status.

GET /v2/applications/[publicId]/status

Information	Value
URL	/v2/applications/{publicId}/status
Request method (verb)	GET
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Notes
publicId	string	Yes	The Public ID associated with the application or pre-qualification

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/".$public_id."/status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
publicId	string	No	The Public ID associated with the application or pre-qualification
applicationId	int	Yes (when there is no application)	Our internal application ID
status	string	No	Current status. The possible values are: Pending, Pre-qualified, Ineligible, Declined, Approved, PendingApproval, SignedWaitingForInvoice, SignedWaitingForInvoiceApproval, Signed, Funded, PendingReturn, Returned, Expired and Error.
phone	string	No	Customer's phone number
approvalAmount	decimal	Yes (when status is Declined)	Approval Amount
borrowedAmount	decimal	Yes (when status is not Signed)	Contract's Borrowed Amount
invoiceAmount	decimal	Yes (when status is not Signed)	Contract's Invoice Amount
totalInStorePayment	decimal	Yes (when status is not Signed)	Contract's Total In Store Payment
financingPartnerCode	string	Yes (when status is not Signed)	Contract's Financing Partner Code
financingPartnerName	string	Yes (when status is not Signed)	Contract's Financing Partner Name
financingPartnerDisplayName	string	Yes (when status is not Signed)	Contract's Financing Partner Display Name
paymentInfo	object	Yes (when payment is not Created)	Payment information (see Payment information)

Payment Information

Name	Type	Nullable?	Notes
transferId	string	Yes (when status is manually processed)	Payment Transfer ID
wireReferenceId	string	Yes (when status is not manually processed)	Payment Wire Reference ID
date	date	No	Payment Date
amount	decimal	No	Payment Amount
status	string	No	Payment Status. The possible values are: pending, processed, manually processed and returned

Response sample

{
  "publicId": <value>,
  "applicationId": <value>,
  "status": <value>,
  "phone": <value>,
  "approvalAmount": <value>,
  "borrowedAmount": <value>,
  "invoiceAmount": <value>,
  "totalInStorePayment": <value>,
  "financingPartnerCode": <value>,
  "financingPartnerName": <value>,
  "financingPartnerDisplayName": <value>,
  "paymentInfo": {
   "transferID": <value>,
   "wireReferenceId": <value>,
   "date": <value>,
   "amount": <value>,
   "status": <value>
 }
}

Return Status By Phone

Returns the application status using customer phone.

* This endpoint should not be used as a validation to confirm an order on your system.

GET /v2/applications/phone/[phone]/status

Information	Value
URL	/v2/applications/phone/{phone}/status
Request method (verb)	GET
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Constraints	Notes
phone	string	Yes	Must follow the patterns: 999-999-9999 or 9999999999	The phone to be searched

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$phone = "815-227-1188";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/phone/".$phone."/status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
publicId	string	No	The Public ID associated with the application or pre-qualification
applicationId	int	Yes (when there is no application)	Our internal application ID
status	string	No	Current status. The possible values are Pending, Pre-qualified, Ineligible, Declined, Approved, PendingApproval, SignedWaitingForInvoice, SignedWaitingForInvoiceApproval, Signed, Funded, PendingReturn, Returned, Expired, Error
phone	string	No	Customer's phone number
approvalAmount	decimal	Yes (when status is Declined)	Approval Amount
borrowedAmount	decimal	Yes (when status is not Signed)	Contract's Borrowed Amount
invoiceAmount	decimal	Yes (when status is not Signed)	Contract's Invoice Amount
totalInStorePayment	decimal	Yes (when status is not Signed)	Contract's Total In Store Payment
financingPartnerCode	string	Yes (when status is not Signed)	Contract's Financing Partner Code
financingPartnerName	string	Yes (when status is not Signed)	Contract's Financing Partner Name
financingPartnerDisplayName	string	Yes (when status is not Signed)	Contract's Financing Partner Display Name

Response sample

{
  "publicId": <value>,
  "applicationId": <value>,
  "status": <value>,
  "phone": <value>,
  "approvalAmount": <value>,
  "borrowedAmount": <value>,
  "invoiceAmount": <value>,
  "totalInStorePayment": <value>,
  "financingPartnerCode": <value>,
  "financingPartnerName": <value>,
  "financingPartnerDisplayName": <value>
}

Applications Status List

Returns a list of application and their status.

GET /v2/applications/from/[storeCode]/at/[date]

Information	Value
URL	/v2/applications/from/{storeCode}/at/{date}
Request method (verb)	GET
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Notes
storeCode	string	Yes	The Code associated with the store
date	string	Yes	The date as string on which the applications were created. in the following format {YYYY-MM-DD}

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/from/".$store_code."/at/".$date);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
publicId	string	No	The Public ID associated with the application or pre-qualification
applicationId	int	Yes (when there is no application)	Our internal application ID
status	string	No	Current status. The possible values are Pending, Pre-qualified, Ineligible, Declined, Approved, PendingApproval, SignedWaitingForInvoice, SignedWaitingForInvoiceApproval, Signed, Funded, PendingReturn, Returned, Expired and Error.
phone	string	No	Customer's phone number
approvalAmount	decimal	Yes (when status is Declined)	Approval Amount
borrowedAmount	decimal	Yes (when status is not Signed)	Contract's Borrowed Amount
invoiceAmount	decimal	Yes (when status is not Signed)	Contract's Invoice Amount
totalInStorePayment	decimal	Yes (when status is not Signed)	Contract's Total In Store Payment
financingPartnerCode	string	Yes (when status is not Signed)	Contract's Financing Partner Code
financingPartnerName	string	Yes (when status is not Signed)	Contract's Financing Partner Name
financingPartnerDisplayName	string	Yes (when status is not Signed)	Contract's Financing Partner Display Name
paymentInfo	object	Yes (when payment is not Created)	Payment information

Payment Information

Name	Type	Nullable?	Notes
transferID	string	No	Payment transfer id
wireReferenceId	string	No	Payment wire reference Id
date	dateTime	No	Payment start date
amount	decimal	No	Payment amount
status	string	No	Payment status The possible values are error, failed, manually processed, pending, processed, returned and waiting.

Response sample

[
  {
    "publicId": <value>,
    "applicationId": <value>,
    "status": <value>,
    "phone": <value>,
    "approvalAmount": <value>,
    "borrowedAmount": <value>,
    "invoiceAmount": <value>,
    "totalInStorePayment": <value>,
    "financingPartnerCode": <value>,
    "financingPartnerName": <value>,
    "financingPartnerDisplayName": <value>,
    "paymentInfo": {
      "transferID": <value>,
      "wireReferenceId": <value>,
      "date": <value>,
      "amount": <value>,
      "status": <value>
    }
  }
]

Return Request

Starts the return request process.

POST /v2/applications/[publicId]/requestreturn

The application must be signed and cannot have a pending return request.

Information	Value
URL	/v2/applications/{publicId}/requestreturn
Request method (verb)	POST
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Notes
agentName	string	No	Maximum length is 100 characters
phone	string	No	Must follow the patterns: 999-999-9999 or 9999999999
email	string	No	Maximum length is 100 characters
reason	string	No	Maximum length is 500 characters
returnType	int	No	1 = Redraft or 2 = Return
returnReasonPublicId	string	No	The Public ID associated with the return reason (see Return All Return Reasons)

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

$fields = array(
  "agentName" => "Jonh",
  "phone" => "123-456-789",
  "email" => "lorem@ipsum.com",
  "reason" => "customer request",
  "returnType" => "1",
  "returnReasonPublicId" => "teydfgJhbTiulkjTUCUzI1NiIsnR5LKJosp6"
  )
);

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/".$public_id."/requestreturn");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, array());
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

This method does not return any content.

Upload Invoice

Attachs a new invoice to the application.

POST /v2/applications/[publicId]/uploadinvoice

The supported file types are pdf, doc, docx, tif, jpg, jpeg, gif, png, xls, xlsx, and raw image.

Information	Value
URL	/v2/applications/{publicId}/uploadinvoice
Request method (verb)	POST
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	multipart/form-data

Request arguments

Name	Type	Required?	Notes
publicId	string	Yes	The Public ID associated with the application
file	file	Yes	The invoice file

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: multipart/form-data",
  "Authorization: Bearer ".$authentication_token
);

$fields = array(
  "file" => new CurlFile("invoice.pdf", "application/pdf", "invoice.pdf")
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/".$public_id."/uploadinvoice");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
status	string	No	Status of the request

Response sample

{
  "status": <value>
}

Add Delivery Information

Adds the delivery information to the application.

POST /v2/applications/[publicId]/deliveryinformation

Information	Value
URL	/v2/applications/{publicId}/deliveryinformation
Request method (verb)	POST
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Constraints	Notes
publicId	string	Yes		The Public ID associated with the application
method	string	Yes		Delivery Method. Possible values are Direct or Shipped
carrier	string	Only if the delivery method is set as Shipped		Carrier String Representation. (See List of Possible Carriers)
trackingNumber	string	Yes		Tracking Number
address	string	Yes	Maximum length is 50 characters	Address
address2	string	Only if the delivery method is set as Direct	Maximum length is 50 characters
city	string	Yes	Maximum length is 50 characters	City
state	string	Yes	Maximum length is 2 characters	State
zip	string	Yes	Maximum length is 5 characters	Zip Code

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$fields = array(  
  "method" => "Direct",
  "carrier" => "UPS",
  "trackingNumber" => "000001",
  "address" => "45999 Center Oak Plaza",
  "address2" => "Suite 100",
  "city" => "Sterling",
  "state" => "VA",
  "zip" => "20166"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/".$public_id."/deliveryinformation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
status	string	No	Status of the request

Response sample

{
  "status": <value>
}

List of Possible Carriers

Name	String Representation
AmazonMws	AmazonMws
APC	APC
Asendia	Asendia
Australia Post	AustraliaPost
AxlehireV3	AxlehireV3
Bond	Bond
BorderGuru	BorderGuru
Cainiao	Cainiao
Canada Post	CanadaPost
Canpar	Canpar
CDL Last Mile Solutions	ColumbusLastMile
Chronopost	Chronopost
Colis Privé	ColisPrive
Colissimo	Colissimo
Courier Express	CourierExpress
CouriersPlease	CouriersPlease
Dai Post	DaiPost
Deutsche Post	DeutschePost
Deutsche Post UK	DeutschePostUK
DHL eCommerce Asia	DHLEcommerceAsia
DHL eCommerce Solutions	DhlEcs
DHL Express	DHLExpress
DHL Freight	DHLFreight
DHL Germany	DHLGermany
DPD	DPD
DPD UK	DPDUK
EMS	ChinaEMS
Estafeta	Estafeta
Fastway	Fastway
FedEx	FedEx
FedEx Cross Border	FedExCrossBorder
FedEx Mailview	FedExMailview
FedEx SameDay City	FedExSameDayCity
FedEx SmartPost	FedexSmartPost
FirstMile	FirstMile
Globegistics	Globegistics
GSO	GSO
Hermes	Hermes
Hong Kong Post	HongKongPost
Interlink Express	InterlinkExpress
Janco Freight	JancoFreight
JP Post	JPPost
Kuroneko Yamato	KuronekoYamato
La Poste	LaPoste
LaserShip	LaserShipV2
Liefery	Liefery
Loomis Express	LoomisExpress
LSO	LSO
Newgistics	Newgistics
OnTrac	OnTrac
Osm Worldwide	OsmWorldwide
Parcelforce	Parcelforce
Passport	Passport
PCF Final Mile	PcfFinalMile
Pilot	Pilot
PostNL	PostNL
PostNord	PostNord
Purolator	Purolator
Royal Mail	RoyalMail
RR Donnelley	RRDonnelley
Seko	Seko
SEKO OmniParcel	OmniParcel
Singapore Post	SingaporePost
Spee-Dee	SpeeDee
StarTrack	StarTrack
Toll	Toll
TForce	TForce
UDS	UDS
Ukrposhta	Ukrposhta
UPS	UPS
UPS i-parcel	UPSIparcel
UPS Mail Innovations	UPSMailInnovations
USPS	USPS
Veho	Veho
Yanwen	Yanwen

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json
Callback-Url	No	URL to be posted when there is an update on the status of the contract amendment request (see Callback notification)

Request arguments

Name	Type	Required?	Constraints	Notes
products	array of object	Yes		List of products

Product arguments:

Name	Type	Required?	Constraints	Notes
id	string	No	Maximum length is 256 characters	ID
serialNumber	string	No	Maximum length is 256 characters	Serial Number
description	string	Yes	Maximum length is 256 characters	Description
quantity	decimal	Yes	Must be greater than 0	Quantity
value	decimal	Yes		Extended Product Value - without sales tax if sales tax is being sent as a separate Product. Include the sales tax in the value if it is not sent as a separate Product. If you have a quantity of 2, the value would represent both products combined, not each product.

Best Practice

Products in the "product" array should include items such as merchandise, shipping, insurance, coupons, total sales tax, etc. as separate items.  This method provides the greatest clarity for both the retailer and the consumer to identify the itemized costs.  Note that the cart total is the sum of all product array "value" parameters; as an example, coupons and discounts should be included as negative values.

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$fields = array(
  "products" => array(
    array(
      "id" => "1",
      "description" => "Foo",
      "serialNumber" => "FOO001",
      "quantity" => "1",
      "value" => "1000.00"
    )
  )
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/".$public_id."/requestcontractamendment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

This method does not return any content.

Callback notification

When requesting a contract amendment, you can provide the Callback-Url HTTP header with an URL that our system will POST to when there is an update on the status of the contract amendment request.

The URL must be public, secure (i.e., it must use HTTPS), support JSON requests, and return a 200 (OK) response.

Here are the fields included in the request:

Name	Type	Nullable?	Notes
publicId	string	No	The Public ID associated with the application or pre-qualification
status	string	No	Current status. The possible values are Processed, Rejected, Error
statusReason	string	Yes (when status is Processed)	Reason for the current status

Add References To Orders

Add the order reference into the application.

POST /v2/applications/[publicId]/orders

The application must be signed.

Information	Value
URL	/v2/applications/{publicId}/orders
Request method (verb)	POST
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

Name	Type	Required?	Notes
orders	array of string	Yes	Number or IDs of the orders attached to this Contract.

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
$public_id = "c4c4eede-cbb0-4efd-8e10-aa1d02392ce6";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

$fields = array(
  "orders" => 
      array(
        0 => "1234",
        1 => "9876"
      )
);

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/applications/".$public_id."/orders");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, array());
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

This method does not return any content.

Financing Partner

The methods here follow the Responses and errors conventions.

Return All Financing Partners

Returns all the active financing partners associated with the authenticated store.

GET /v2/financingpartners

Information	Value
URL	/v2/financingpartners
Request method (verb)	GET
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

This method does not require any argument.

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/financingpartners");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
code	string	No	Code
name	string	No	Name
displayName	string	No	Display Name
street	string	No	Street
suiteApartment	string	Yes	Suite/Apartment
city	string	No	City
state	string	No	State
zipCode	string	No	Zip Code
phone	string	No	Phone Number

Response sample

[
  {
    "code": <value>,
    "name": <value>,
    "displayName": <value>,
    "street": <value>,
    "suiteApartment": <value>,
    "city": <value>,
    "state": <value>,
    "zipCode": <value>,
    "phone": <value>
  }
]

Return Reasons

The methods here follow the Responses and errors conventions.

Return All Return Reasons

Returns all return reasons in the system.

GET /v2/returnreasons

Information	Value
URL	/v2/returnreasons
Request method (verb)	GET
Requires authentication?	Yes (see Authentication)

Request headers

Name	Required?	Value
Authorization	Yes	See Authentication
Content-Type	Yes	application/json

Request arguments

This method does not require any argument.

Request sample

<?php

$authentication_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer ".$authentication_token
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://sandbox-lending-api.credova.com/v2/returnreasons");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

echo "Response is ".$response;

Response fields

Name	Type	Nullable?	Notes
publicId	string	No	PublicId
description	string	No	Description

Response sample

[
  {
    "publicId": <value>,
    "description": <value>
  }
]