Additional Parameters

This lesson provides a list of different endpoints and their additional parameters.

We'll cover the following

Users

Create a user

The table below provides a list of some additional request parameters that can be used to create a user. We can add these parameters to the body of the request when we create a user with the {BASE_URL}/users endpoint. Click here to get the complete list of request parameters that can be used to create a user.

Request Parameters

Parameter

Type

Category

Description

middle_name

string

optional

User's middle name

Maximum length: 40 characters

gender

string

optional

User's gender

Allowable values: M, F

birth_date

string

optional

User's date of birth

Format: yyyy-MM-dd

city

string

optional

City that corresponds to the user's address

Maximum length: 40 characters

state

string

optional

2-letter state code that corresponds to the user's address

Sample values: NY, WA, TX

postal_code

string

optional

Postal code that corresponds to the user's address

Maximum length: 10 characters

id_card_number

string

optional

User’s identification card number

Maximum length: 255 characters

nationality

string

optional

User's nationality

Maximum length: 255 characters

passport_number

string

optional

User's passport number

Maximum length: 40 characters

ssn

string

optional

User’s Social Security Number

Note: This only contains digits. It doesn’t contain any delimiters.

Card products

Create a card product

The table below provides some attributes of the config object, which is an optional input parameter for when we create a card product. Click here for a complete list of config object attributes.

Request Parameters

Parameter

Type

Category

Description

config.poi

object

optional

Defines the points of interaction for the cards

config.poi.ecommerce

boolean

optional

True to allow online shopping with cards, otherwise False

Default value: False

config.poi.atm

boolean

optional

True to allow cash withdrawal from ATMs and to receive cash back at a point of sale (POS), otherwise False

Default value: False

config.transaction_controls

object

optional

Defines transactional characteristics of card usage

config.transaction_controls.always_require_pin

boolean

optional

True to indicate that the card requires a PIN for transaction, otherwise False

Default value: False

Cards

Create a card

The table below shows the attributes of the expiration_offset and activation_actions objects. It also shows some important attributes of the fulfillment object used to create a card. Click here for a complete list of the fulfillment object attributes.

Request Parameters

Parameter

Type

Category

Description

expiration_offset.value

integer

optional

Duration of card validity

Default value: 4

expiration_offset.unit

string

optional

Units for the expiration_offset.value field

Allowable values: YEARS, MONTHS, DAYS, HOURS, MINUTES, SECONDS

Default value: YEARS

activation_actions.terminate_reissued_source_card

boolean

optional

True to terminate the original card in case of reissuance, otherwise False

Default value: True

activation_actions.swap_digital_wallet_tokens_from_card_token

string

optional

Token of the card from which all digital wallet tokens are moved to the new card

Length: 1–36 characters

fulfillment.card_personalization

object

required

Personal information added to the card

fulfillment.card_personalization.text

object

required

Personalized text displayed on the card

fulfillment.shipping

object

optional

Shipping details for the card

fulfillment.shipping.recipient_address

object

optional

Shipping address for the card

Create a card transition

The table below provides the details of the validations object. Click here for the descriptions of the channel and the reason_code values.

Request Parameters

Parameter

Type

Category

Description

validations.user

object

optional

Contains user information

validations.user.birth_date

datetime

optional

Date of birth of the user who owns the card

Format: yyyy-MM-dd

validations.user.phone

string

optional

Telephone number of the user who owns the card

Maximum length: 255 characters

Format: 0000000000 or 000-000-0000


validations.user.random_name_line1_postfix

string

optional

Six-digit numeric postfix for bulk card orders

Maximum length: 6 characters

validations.user.ssn

string

optional

Social Security Number of the user who owns the card

Maximum length: 255 characters

Transactions

Simulate and reverse a transaction

The table below provides the details of the network_fees and webhook objects. Click here to view details of the card_acceptor, card_options, and transaction_options objects. In addition to these details, we can also find the descriptions for the network fee types, as well as whether they credit or debit the account balance.

Request Parameters

Parameter

Type

Category

Description

network_fees.type

string

optional

Type of fee

Allowable values: ISSUER_FEE, SWITCH_FEE, PINDEBIT_ASSOC_FEE, ACQUIRER_FEE, INTERCHANGE_FEE, CUR_CONV_CARDHOLDER_FEE, CUR_CONV_ISSUER_FEE, CROSS_BORDER_ISSUER_FEE

network_fees.amount

decimal

optional

Fee amount

network_fees.credit_debit

string

optional


C to indicate if the fee credits the account, D to indicate if the fee debits the account

Allowable values: C, D

webhook.endpoint

string

optional

Link to which a copy of the response is sent

webhook.username

string

optional

Username used to access the endpoint

Maximum length: 50 characters

webhook.password

string

optional

Password used to access the endpoint

Get all transactions

Some common transaction types include the following:

  • account.credit
  • account.debit
  • balanceinquiry
  • authorization
  • authorization.atm.withdrawal

Click here for a complete list of types of transactions.