API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Create a new physical card

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

Asynchronously create a physical card. The response will include a resource to allow the client to check the status of the request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The account which card funds will be raised from.

Body Params
double
required
≥ 1

Total card authorisation limit.

string
required

ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is inclusive of the specified month.

string
required

Identifies the type of card to create (GBP consumer, GBP business, etc). Modulr will supply a list of possible values.

string
required
length between 1 and 50

Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).

constraints
object

Constraints

authentication
object

Authentication. Required by default, optional for Virtual Business Travel Cards only

string

Date for card to be cancelled on

customFields
array of objects
length between 0 and 20

Custom fields of card

customFields
authorisationWindow
object

Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only.

string
enum
Allowed:
holder
object

CardHolder

shippingAddress
object

Add a Shipping address if you wish the card to be sent to an address other than the billing address

design
object
required

Design references for card and packaging

string
required
length between 1 and 27

Name to be printed on the card. Maximum of 27 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space). Please add business name to this field if you wish to have it on the card.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

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

Updated 7 months ago