POST v1/companies-web/cards

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CardHolderId	globally unique identifier	None.
CardHolderSsn	string	None.
DeliveryAddressStreet	string	None.
DeliveryAddressZip	string	None.
DeliveryAddressCity	string	None.
DeliveryAddressCountryCode	string	None.
Phone	string	None.
IsPhysicalCardOrdered	boolean	None.
CardLimit	decimal number	None.
CardHolderEmail	string	None.
ApplicantIsCardHolder	boolean	None.
PhysicalCardUsageLimits	PhysicalCompanyCardRegistrationLimits	None.
PhysicalCardRestrictions	CreditCardRestrictions	None.
VirtualCardUsageLimits	VirtualCompanyCardRegistrationLimits	None.
VirtualCardRestrictions	CreditCardRestrictions	None.
IsPoliticallyInfluential	boolean	None.
NationalityId	globally unique identifier	Required
NationalityId2	globally unique identifier	None.
NationalityId3	globally unique identifier	None.
CardType	CardCreditTypeEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "CardHolderId": "091c354d-bcec-4d69-bc57-b9f9ed2601ed",
  "CardHolderSsn": "sample string 1",
  "DeliveryAddressStreet": "sample string 2",
  "DeliveryAddressZip": "sample string 3",
  "DeliveryAddressCity": "sample string 4",
  "DeliveryAddressCountryCode": "sample string 5",
  "Phone": "sample string 6",
  "IsPhysicalCardOrdered": true,
  "CardLimit": 1.0,
  "CardHolderEmail": "sample string 8",
  "ApplicantIsCardHolder": true,
  "PhysicalCardUsageLimits": {
    "DailyLimitATM": 1.0,
    "MonthlyLimitATM": 2.0,
    "DailyLimitUsage": 3.0,
    "MonthlyLimitUsage": 4.0
  },
  "PhysicalCardRestrictions": {
    "ecomm": true,
    "africa": true,
    "europe": true,
    "home": true,
    "northAmerica": true,
    "oceania": true,
    "southAmerica": true,
    "asia": true
  },
  "VirtualCardUsageLimits": {
    "DailyLimit": 1.0,
    "MonthlyLimit": 2.0
  },
  "VirtualCardRestrictions": {
    "ecomm": true,
    "africa": true,
    "europe": true,
    "home": true,
    "northAmerica": true,
    "oceania": true,
    "southAmerica": true,
    "asia": true
  },
  "IsPoliticallyInfluential": true,
  "NationalityId": "055e89fa-8901-4b70-98b4-a708e1c9fd86",
  "NationalityId2": "96766a42-3abc-4328-9539-168276ad5bb1",
  "NationalityId3": "c74894e9-5d7f-4c6d-96e2-53ec0b52b6ef",
  "CardType": "CreditCard"
}

application/xml, text/xml

Sample:

<RegisterCompanyCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models.Cards">
  <ApplicantIsCardHolder>true</ApplicantIsCardHolder>
  <CardHolderEmail>sample string 8</CardHolderEmail>
  <CardHolderId>091c354d-bcec-4d69-bc57-b9f9ed2601ed</CardHolderId>
  <CardHolderSsn>sample string 1</CardHolderSsn>
  <CardLimit>1</CardLimit>
  <CardType>CreditCard</CardType>
  <DeliveryAddressCity>sample string 4</DeliveryAddressCity>
  <DeliveryAddressCountryCode>sample string 5</DeliveryAddressCountryCode>
  <DeliveryAddressStreet>sample string 2</DeliveryAddressStreet>
  <DeliveryAddressZip>sample string 3</DeliveryAddressZip>
  <IsPhysicalCardOrdered>true</IsPhysicalCardOrdered>
  <IsPoliticallyInfluential>true</IsPoliticallyInfluential>
  <NationalityId>055e89fa-8901-4b70-98b4-a708e1c9fd86</NationalityId>
  <NationalityId2>96766a42-3abc-4328-9539-168276ad5bb1</NationalityId2>
  <NationalityId3>c74894e9-5d7f-4c6d-96e2-53ec0b52b6ef</NationalityId3>
  <Phone>sample string 6</Phone>
  <PhysicalCardRestrictions xmlns:d2p1="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
    <d2p1:africa>true</d2p1:africa>
    <d2p1:asia>true</d2p1:asia>
    <d2p1:ecomm>true</d2p1:ecomm>
    <d2p1:europe>true</d2p1:europe>
    <d2p1:home>true</d2p1:home>
    <d2p1:northAmerica>true</d2p1:northAmerica>
    <d2p1:oceania>true</d2p1:oceania>
    <d2p1:southAmerica>true</d2p1:southAmerica>
  </PhysicalCardRestrictions>
  <PhysicalCardUsageLimits xmlns:d2p1="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
    <d2p1:DailyLimitATM>1</d2p1:DailyLimitATM>
    <d2p1:DailyLimitUsage>3</d2p1:DailyLimitUsage>
    <d2p1:MonthlyLimitATM>2</d2p1:MonthlyLimitATM>
    <d2p1:MonthlyLimitUsage>4</d2p1:MonthlyLimitUsage>
  </PhysicalCardUsageLimits>
  <VirtualCardRestrictions xmlns:d2p1="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
    <d2p1:africa>true</d2p1:africa>
    <d2p1:asia>true</d2p1:asia>
    <d2p1:ecomm>true</d2p1:ecomm>
    <d2p1:europe>true</d2p1:europe>
    <d2p1:home>true</d2p1:home>
    <d2p1:northAmerica>true</d2p1:northAmerica>
    <d2p1:oceania>true</d2p1:oceania>
    <d2p1:southAmerica>true</d2p1:southAmerica>
  </VirtualCardRestrictions>
  <VirtualCardUsageLimits xmlns:d2p1="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
    <d2p1:DailyLimit>1</d2p1:DailyLimit>
    <d2p1:MonthlyLimit>2</d2p1:MonthlyLimit>
  </VirtualCardUsageLimits>
</RegisterCompanyCardRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RegisterCompanyCardRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.