Request Virtual Card:

This method requests the issuance of a new virtual card. Typically, it involves a POST request to create a card with specific details.

Example of requisition:

{
  "Method": "RequestVirtualCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "EmbossingName": "Adriana Josefa",
  "IdentifierProduct": "FC0000001",
  "UsageType": "1",
  "CardOwner": {
    "OwnerTaxNumber": "59626023821",
    "FullName": "Adriana Teresinha Josefa Santos",
    "Phone": "71983928554",
    "Mail": "[email protected]"
  },
  "CardHolder": {
    "HolderTaxNumber": "59626023821",
    "FullName": "Adriana Teresinha Josefa Santos",
    "BirthDate": "1992/20/02",
    "Nationality": "Brasileira",
    "Gender": "1",
    "MaritalStatus": "5",
    "MotherName": "Allana Vanessa Josefa"
  },
  "CardHolderContact": {
    "Mail": "[email protected]",
    "Phone": "71983928554"
  }
}

{
  "Success": "true",
  "Message": "Solicitação de cartão virtual registrada com sucesso. O processo poderá levar alguns minutos para ser concluído."
}

{
  "Success": "false",
  "Message": "ISE0014 - Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
  "Validation": [
    "string"
  ]
}

Field Descripition:

Method	Description	Type	Mandatory	Example	Enums
Method	API method being called.	String	Yes	RequestVirtualCard
PartnerId	Unique identifier for the partner (provided by FitBank).	Integer	Yes	30326
BusinessUnitId	Unique identifier for the business unit (FitBank provided ID).	Integer	Yes	30326
EmbossingName	Name to be embossed on the virtual card.	String	Yes	Adriana Josefa
IdentifierProduct	Product identifier associated with the virtual card.	String	No	FC0000001
UsageType	Type of card use, which can indicate specific categories or purposes for the card.	String($enum)	No	1	Enum: [Account Balance = 0, Account Overbalance = 1]
CardOwner	Information about the virtual card owner.	Object	Yes
OwnerTaxNumber	CPF/CNPJ number of the card owner.	String	Yes	59626023821
FullName	Full name of the owner.	String	Yes	Adriana Teresinha Josefa Santos
Phone	Phone number of the owner.	String	No	71983928554
Mail	Email address of the owner.	String	No	[email protected]
CardHolder	Information about the virtual card holder.	Object	Yes
HolderTaxNumber	CPF/CNPJ number of the card holder.	String	No
FullName	Full name of the card holder.	String	No	59626023821
BirthDate	Birthdate of the holder. Must be in ISO 8601 format.	String	No	YYYY-MM-DD
Nationality	Nationality of the holder.	String	No	Brazilian
Gender	Gender of the holder.	String($enum)	No	1	Enum: [Male = 0, Female = 1, Other = 2]
MaritalStatus	Marital status of the holder.	String($enum)	No	5	Enum: [NotMarried = 0, Married = 1, Divorced = 2, Separated = 3, Widower = 4, Single = 5, Other = 6]
MotherName	Mother's name of the holder.	String	No	Allana Vanessa Josefa

Block Virtual Card

Requests the blocking of a virtual card, preventing its use until it is unblocked.

Example of requisition:

{
  "Method": "BlockVirtualCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485"
}

{
  "Success": "true",
  "Message": "Solicitação de bloqueio registrada com sucesso!"
}

{
  "Success": "false",
  "Message": "Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
  "Validation": [
    "string"
  ]
}

Field Descripition:

Method	Descrição	Tipo	Mandatório	Exemplo
Method	Method name	string	SIM	BlockVirtualCard
PartnerId	Partner identifier provided by Fitbank	integer	SIM	30326
BusinessUnitId	Business unit identifier	integer	SIM	30326
Identifier card	Card Identifier	string	SIM	800015485

Unblock Virtual Card

Requests the unblocking of a previously blocked virtual card.

Example of requisition:

{
  "Method": "UnblockVirtualCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485"
}

{
  "Success": "true",
  "Message": "Solicitação de desbloqueio registrada com sucesso!",
  "IdentifierCard": "800015485"
}

{
  "Success": "false",
  "Message": "Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
  "Validation": [
    "string"
  ]
}

Field Descripition:

Method	Descrição	Tipo	Mandatório	Exemplo
Method	Method name	string	SIM	UnblockVirtualCard
PartnerId	Partner identifier provided by Fitbank	integer	SIM	30326
BusinessUnitId	Business unit identifier	integer	SIM	30326
Identifier card	Card Identifier	string	SIM	800015485

Cancel Virtual Card

Requests the cancellation of a virtual card, rendering it invalid and inactive.

Example of requisition:

{
  "Method": "CancelVirtualCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485"
}

{
  "Success": "true",
  "Message": "Sua solicitação de cancelamento foi salva com sucesso. O processo levará alguns minutos para ser concluído.",
  "IdentifierCard": "800015485"
}

{
  "Success": "false",
  "Message": "Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
  "Validation": [
    "string"
  ]
}

Field Descripition:

Method	Descrição	Tipo	Mandatório	Exemplo
Method	Method name	string	SIM	CancelVirtualCard
PartnerId	Partner identifier provided by Fitbank	integer	SIM	30326
BusinessUnitId	Business unit identifier	integer	SIM	30326
Identifier card	Card Identifier	string	SIM	800015485

Get Virtual Card By Id

Requests the cancellation of a virtual card, rendering it invalid and inactive.

Example of requisition:

{
  "Method": "GetVirtualCardById",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485"
}

{
  "Success": "true",
  "VirtualCard": "CuukyiZMzAEFuMOn83WRpnNWnKVmop9CeO/uVn+xrh17j6eLaHzEy+GDc4Dc0f6nPi+Goq0Mfl2OmZpMq2/uIPkSBYrPDcw2jrvnInwQGlVz7JMArlKUQIWBVpesgUQekhm348eLF0eeWUU1L+ZUCOABvzVsxfF8jVearbkYZMCB/t3G4qQPiXt9tNbebvb8jvXNSJm7wRdNseDEclCK4LoFj08Yvljd9IGUAwCmi/tr0WVudpsmBHo6MDPLd8ESH+lnYUz6uQ8lQ6yYB3IF1So56UzYLrHlffmJ5ukOTqxJpyYVsyS8htKwrbwyAzEVi6iUG2/XEPR9hSsoBioRIg=="
}

{
  "Success": "false",
  "Message": "Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
  "Validation": [
    "string"
  ]
}

Field Descripition:

Method	Descrição	Tipo	Mandatório	Exemplo
Method	Method name	string	SIM	GetVirtualCardById
PartnerId	Partner identifier provided by Fitbank	integer	SIM	30326
BusinessUnitId	Business unit identifier	integer	SIM	30326
Identifier card	Card Identifier	string	SIM	800015485