POST api/NYMCARDService/CreateCard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
card_product_id	string	None.
user_id	string	None.
card_type	string	None.
id	string	None.
reference_card_id	string	None.
bulk_issuance_id	string	None.
name_on_card	string	None.
shipping_details	ShippingDetails	None.
dry_run	boolean	None.
card_validity_term	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "card_product_id": "sample string 1",
  "user_id": "sample string 2",
  "card_type": "sample string 3",
  "id": "sample string 4",
  "reference_card_id": "sample string 5",
  "bulk_issuance_id": "sample string 6",
  "name_on_card": "sample string 7",
  "shipping_details": {
    "method": "sample string 1",
    "return_address": {
      "first_name": "sample string 1",
      "middle_name": "sample string 2",
      "last_name": "sample string 3",
      "mobile": "sample string 4",
      "address_line1": "sample string 5",
      "address_line2": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "country": "sample string 9",
      "postal_code": "sample string 10"
    },
    "shipping_address": {
      "first_name": "sample string 1",
      "middle_name": "sample string 2",
      "last_name": "sample string 3",
      "mobile": "sample string 4",
      "address_line1": "sample string 5",
      "address_line2": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "country": "sample string 9",
      "postal_code": "sample string 10"
    }
  },
  "dry_run": true,
  "card_validity_term": 9
}

application/xml, text/xml

Sample:

<CreateCardInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.NYMCARD.Service.Models">
  <bulk_issuance_id>sample string 6</bulk_issuance_id>
  <card_product_id>sample string 1</card_product_id>
  <card_type>sample string 3</card_type>
  <card_validity_term>9</card_validity_term>
  <dry_run>true</dry_run>
  <id>sample string 4</id>
  <name_on_card>sample string 7</name_on_card>
  <reference_card_id>sample string 5</reference_card_id>
  <shipping_details>
    <method>sample string 1</method>
    <return_address>
      <address_line1>sample string 5</address_line1>
      <address_line2>sample string 6</address_line2>
      <city>sample string 7</city>
      <country>sample string 9</country>
      <first_name>sample string 1</first_name>
      <last_name>sample string 3</last_name>
      <middle_name>sample string 2</middle_name>
      <mobile>sample string 4</mobile>
      <postal_code>sample string 10</postal_code>
      <state>sample string 8</state>
    </return_address>
    <shipping_address>
      <address_line1>sample string 5</address_line1>
      <address_line2>sample string 6</address_line2>
      <city>sample string 7</city>
      <country>sample string 9</country>
      <first_name>sample string 1</first_name>
      <last_name>sample string 3</last_name>
      <middle_name>sample string 2</middle_name>
      <mobile>sample string 4</mobile>
      <postal_code>sample string 10</postal_code>
      <state>sample string 8</state>
    </shipping_address>
  </shipping_details>
  <user_id>sample string 2</user_id>
</CreateCardInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResponseOfCard

Name	Type	Additional information
IsSuccess	boolean	None.
Data	Card	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Data": {
    "id": "sample string 1",
    "user_id": "sample string 2",
    "card_type": "sample string 3",
    "card_product_id": "sample string 4",
    "reference_card_id": "sample string 5",
    "bulk_issuance_id": "sample string 6",
    "name_on_card": "sample string 7",
    "shipping_details": {
      "method": "sample string 1",
      "return_address": {
        "first_name": "sample string 1",
        "middle_name": "sample string 2",
        "last_name": "sample string 3",
        "mobile": "sample string 4",
        "address_line1": "sample string 5",
        "address_line2": "sample string 6",
        "city": "sample string 7",
        "state": "sample string 8",
        "country": "sample string 9",
        "postal_code": "sample string 10"
      },
      "shipping_address": {
        "first_name": "sample string 1",
        "middle_name": "sample string 2",
        "last_name": "sample string 3",
        "mobile": "sample string 4",
        "address_line1": "sample string 5",
        "address_line2": "sample string 6",
        "city": "sample string 7",
        "state": "sample string 8",
        "country": "sample string 9",
        "postal_code": "sample string 10"
      }
    },
    "status": "sample string 8",
    "status_reason": "sample string 9",
    "card_validity_term": 10,
    "fulfillment_status": "sample string 11",
    "bin": "sample string 12",
    "last_four": "sample string 13",
    "expiry_date": "sample string 14",
    "pin_retries": 15,
    "proxy_number": "sample string 16",
    "created": "2024-09-19T04:10:45.1229131+00:00",
    "modified": "2024-09-19T04:10:45.1229131+00:00"
  },
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseResponseOfCardzwF0ve9J xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.NYMCARD.Service.Models">
  <Data>
    <bin>sample string 12</bin>
    <bulk_issuance_id>sample string 6</bulk_issuance_id>
    <card_product_id>sample string 4</card_product_id>
    <card_type>sample string 3</card_type>
    <card_validity_term>10</card_validity_term>
    <created>2024-09-19T04:10:45.1229131+00:00</created>
    <expiry_date>sample string 14</expiry_date>
    <fulfillment_status>sample string 11</fulfillment_status>
    <id>sample string 1</id>
    <last_four>sample string 13</last_four>
    <modified>2024-09-19T04:10:45.1229131+00:00</modified>
    <name_on_card>sample string 7</name_on_card>
    <pin_retries>15</pin_retries>
    <proxy_number>sample string 16</proxy_number>
    <reference_card_id>sample string 5</reference_card_id>
    <shipping_details>
      <method>sample string 1</method>
      <return_address>
        <address_line1>sample string 5</address_line1>
        <address_line2>sample string 6</address_line2>
        <city>sample string 7</city>
        <country>sample string 9</country>
        <first_name>sample string 1</first_name>
        <last_name>sample string 3</last_name>
        <middle_name>sample string 2</middle_name>
        <mobile>sample string 4</mobile>
        <postal_code>sample string 10</postal_code>
        <state>sample string 8</state>
      </return_address>
      <shipping_address>
        <address_line1>sample string 5</address_line1>
        <address_line2>sample string 6</address_line2>
        <city>sample string 7</city>
        <country>sample string 9</country>
        <first_name>sample string 1</first_name>
        <last_name>sample string 3</last_name>
        <middle_name>sample string 2</middle_name>
        <mobile>sample string 4</mobile>
        <postal_code>sample string 10</postal_code>
        <state>sample string 8</state>
      </shipping_address>
    </shipping_details>
    <status>sample string 8</status>
    <status_reason>sample string 9</status_reason>
    <user_id>sample string 2</user_id>
  </Data>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccess>true</IsSuccess>
</BaseResponseOfCardzwF0ve9J>