Get a real-time pre-qualified offer

Submit anonymised transaction data for a single merchant and receive an instant pre-qualification decision.

No personally identifiable information (PII) is required. Pass MCC/SIC codes, country, entity type, and recent transaction history.

Response:

  • qualified — one or more offers are returned in the Offers array
  • declined — the merchant does not meet the pre-qualification criteria; Offers is empty
Body Params

Anonymised merchant and transaction data

Anonymised merchant data for a real-time pre-qualification decision

string
required

Your internal reference for this merchant. Returned in the response for correlation.

string
enum
required

Legal entity type of the merchant

Allowed:
MerchantMCCs
array of strings

Merchant Category Codes (MCC) associated with the merchant. Optional.

MerchantMCCs
MerchantSICs
array of strings

Standard Industrial Classification (SIC) codes associated with the merchant. Optional.

MerchantSICs
string
required

ISO 3166-1 alpha-3 country code of the merchant

Transactions
array of objects
required

Recent card transaction history for the merchant

Transactions*
integer
≥ 0

Age of the business in months. Optional — include where available.

Headers
string
required

Your API key for authentication.

Responses

401

Unauthorized - Missing or invalid API key

403

Forbidden - Invalid or deactivated API key

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json