Card enquiry

post https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/enquiry

Retrieve card details by PAN

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

string

Card identifier. Maximum of 10 alphanumeric characters

holder

object

CardHolder

title

string

Cardholder title is optional for all card types. Maximum of 4 alphanumeric characters.

firstName

string

required

Cardholder first name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.

lastName

string

required

Cardholder last name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.

billingAddress

object

required

Billing address for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL.

dateOfBirth

date

required

Cardholder date of birth. Must match date format of yyyy-mm-dd. Required for virtual consumer and physical cards. Optional for individual customers.

mobileNumber

string

required

Cardholder mobile number. Must start with a '+', followed by the country code and then the mobile number. Required for virtual consumer and physical cards.

string

length between 0 and 50

Cardholder email

expiry

string

An ISO 8601 date with year & month components only

status

string

The current state of the card.

CREATED ACTIVE BLOCKED SUSPENDED CANCELLED EXPIRED

currency

string

A 3 letter ISO 4217 code representing the card currency

limit

string

Total card authorisation limit

maxLimit

string

Maximum limit which can be set on this card and is the maximum lifetime spend the card can have

spend

string

Current total of all authorisations on this card

externalRef

string

Client reference for the newly created card. Maximum of 50 characters.

maskedPan

string

Masked card PAN

cardType

string

Card product type

cardScheme

string

Card scheme. MASTERCARD or VISA

accountBid

string

Account identifier

productId

string

Product identifier

format

string

The format of the card. PHYSICAL or VIRTUAL

PHYSICAL VIRTUAL

constraints

object

CardConstraints

mccWhitelist

array of strings

required

mccWhitelist

mccWhitelist*

authorisation

object

Authorisation constraints

design

object

External reference for card design. Will only be returned for physical cards

cardRef

string

required

Design reference for card

packagingRef

string

required

Design reference for card packaging

printedName

string

Name printed on the card. Will only be returned for physical cards. Maximum of 20 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space)

cancellationDate

string

Date card will be cancelled on

createdDate

date-time

threeDSecureStatus

string

deprecated

The 3DS status of the card, based on the SMS one time password

NOT_ENROLLED ENROLLED UNENROLLED

authentication

object

The 3DS authentication method statuses

otpSmsStatus

string

The SMS one time password authentication status

NOT_ENROLLED ENROLLED UNENROLLED

knowledgeBaseStatus

string

The knowledge based authentication (KBA) status

NOT_ENROLLED ENROLLED UNENROLLED

shippingAddress

object

Shipping address

addressLine1

string

required

length between 1 and 50

First line of address

addressLine2

string

length between 0 and 50

Second line of address

postTown

string

required

length between 1 and 20

Post town

postCode

string

required

length between 1 and 10

Postcode

country

string

required

Country (ISO 3166 alpha-2 country code)

AT BE BG CY CZ DK EE FI FR DE GR HR HU IS IE IT LV LI LT LU MT NL NO PL PT RO SK SI ES SE AX AW BL CW GF GL GP ME MF MQ NC PF PM RE SX TF WF YT AI BM FK GB GG GI GS IO JE KY MS PN SH TC VG

customFields

array of objects

Custom fields currently defined for card

customFields

object

key

string

Custom field key

value

string

Custom field value

authWindow

object

Authorisation window defined for card

startDate

date-time

Authorisation window start date

endDate

date-time

Authorisation window end date

channelManagerId

string

Channel Manager identifier

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/enquiry \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Card enquiry successful

400Invalid request