2 - Card Issue

Request Card

Requests the issuance of a named card, personalized with the cardholder's information. Ideal for linking the card directly to a user.

Example of requisition:

{
  "Method": "RequestCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "UsageType": "1",
  "ConsumeType": "1",
  "IdentifierProduct": "FC0000001",
  "EmbossingName": "Adriana Josefa",
  "EmbossingNameType": "0",
  "CardOwner": {
    "OwnerTaxNumber": "59626023821",
    "Bank": "001",
    "BankBranch": "0001",
    "BankAccount": "01241455",
    "BankAccountDigit": "1",
    "FullName": "Adriana Teresinha Josefa Santos",
    "Phone": "71983928554",
    "Mail": "[email protected]"
  },
  "CardHolder": {
    "HolderTaxNumber": "59626023821",
    "FullName": "Adriana Teresinha Josefa Santos",
    "MotherName": "Allana Vanessa Josefa",
    "BirthDate": "1992/20/02",
    "Gender": "1",
    "Nationality": "Brasileira",
    "MaritalStatus": "5"
  },
  "CardHolderContact": {
    "Phone": "71983928554",
    "Mail": "[email protected]"
  },
  "BillingAddress": {
    "Line": "Av José Bastos",
    "Number": "4140",
    "Complement": "AP 303",
    "Reference": "Ao lado da JM Veículos",
    "Neighborhood": "Rodolfo Teófilo",
    "ZipCode": "60431086",
    "City": "Fortaleza",
    "State": "CE",
    "Country": "Brasil"
  },
  "CardDeliveryAddress": {
    "Line": "Av José Bastos",
    "Number": "4140",
    "Complement": "AP 303",
    "Reference": "Ao lado da JM Veículos",
    "Neighborhood": "Rodolfo Teófilo",
    "ZipCode": "60431086",
    "City": "Fortaleza",
    "State": "CE",
    "Country": "Brasil"
  }
}
{
  "Success": "true",
  "IdentifierCard": "800018694",
  "Message": "Solicitação de cartão processada com sucesso"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
UsageTypeCard usage type. Options:StringYes
- Balance (0): Balance control by payment account.
- OverBalance (1): Balance control by representative account.
ConsumeTypeCard consumption type.StringYes
- WithLimit (0): Card with consumption limit.
- NoLimit (1): Card without consumption limit.
IdentifierProductProduct code associated with the card according to the desired design.StringYes
EmbossingNameName to be printed on the card (character limit: 22).StringYes
EmbossingNameTypeType of name to be printed. Options:StringYes
- CardHolder (0): Cardholder's name.
- CardOwner (1): Owner's name.
RateValueTypeType of rate for charging. Options:StringNo
- Sent (0): Charge for the request.
- Default (1): Default charge by the business unit.
- None (2): No charge.
RateValueRate value for charging (used when RateValueType = Sent).FloatNo
CardOwnerObject containing information about the card owner.ObjectYes
├ OwnerTaxNumberTax identification number (CPF/CNPJ) of the card owner.StringYes
├ FullNameFull name of the owner (character limit: 22 if EmbossingNameType = 1).StringYes
├ PhonePhone number with area code. Example: 71983928554.StringYes
├ MailEmail of the owner. Example: [email protected].StringYes
├ BankBank code of the owner's account.StringNo
├ BankBranchBank branch code of the owner's account.StringNo
├ BankAccountBank account number of the owner.StringNo
├ BankAccountDigitBank account digit of the owner.StringNo
CardHolderObject containing information about the cardholder.ObjectYes
├ HolderTaxNumberTax identification number (CPF) of the cardholder.StringYes
├ FullNameFull name of the cardholder (character limit: 22 if EmbossingNameType = 0).StringYes
├ MotherNameCardholder's mother's full name.StringYes
├ BirthDateDate of birth in MM/DD/YYYY format.StringYes
├ GenderCardholder's gender. Options:StringYes
- Male (0): Male.
- Female (1): Female.
- Other (2): Other.
├ NationalityCardholder's nationality.StringYes
├ MaritalStatusCardholder's marital status. Options:StringYes
- NotMarried (0): Stable union.
- Married (1): Married.
- Divorced (2): Divorced.
- Separate (3): Separated.
- Widower (4): Widowed.
- Single (5): Single.
- Other (6): Other.
CardHolderContactObject containing the cardholder's contact details.ObjectYes
├ PhoneCardholder's phone number. Example: 71983928554.StringYes
├ MailCardholder's email. Example: [email protected].StringYes
BillingAddressObject containing the billing address for the card.ObjectYes
├ LineStreet name. Example: Av José Bastos.StringYes
├ NumberResidence number. Example: 4140.StringYes
├ ComplementAdditional details. Example: AP 303.StringNo
├ ReferenceReference point. Example: Near JM Vehicles.StringNo
├ NeighborhoodNeighborhood. Example: Rodolfo Teófilo.StringYes
├ ZipCodeZIP code. Example: 60431086.StringYes
├ CityCity. Example: Fortaleza.StringYes
├ StateState. Example: EC.StringYes
├ CountryCountry. Example: Brazil.StringYes
CardDeliveryAddressObject containing the delivery address for the card.ObjectYes
├ LineStreet name. Example: Av José Bastos.StringYes
├ NumberResidence number. Example: 4140.StringYes
├ ComplementAdditional details. Example: AP 303.StringNo
├ ReferenceReference point. Example: Near JM Vehicles.StringNo
├ NeighborhoodNeighborhood. Example: Rodolfo Teófilo.StringYes
├ ZipCodeZIP code. Example: 60431086.StringYes
├ CityCity. Example: Fortaleza.StringYes
├ StateState. Example: EC.StringYes
├ CountryCountry. Example: Brazil.StringYes

📘

Important:

To include a confirmation step in the card application process, you must enable the "Requires additional confirmation for card application" parameter in the Business Unit (BU).

Request Card Batch

Requests the issuance of a batch of cards, allowing the mass issuance of named or unnamed cards in an efficient and organized way.

Example of requisition:

{
  "Method": "RequestCardBatch",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "UsageType": "1",
  "ConsumeType": "1",
  "IdentifierProduct": "FC0000001",
  "Amount": 10,
  "Address": {
    "Line": "Av José Bastos",
    "Number": "4140",
    "Complement": "AP 303",
    "Reference": "Ao lado da JM Veículos",
    "Neighborhood": "Rodolfo Teófilo",
    "ZipCode": "60431086",
    "City": "Fortaleza",
    "State": "CE",
    "Country": "Brasil"
  }
}
{
  "Success": "true",
  "Message": "Lote de cartões não nominais solicitado",
  "CardBatchId": "ESV4UROD"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
UsageTypeCard usage type. Options:StringYes
- Balance (0): Balance control by payment account.
- OverBalance (1): Balance control by representative account.
ConsumeTypeCard consumption type. Options:StringYes
- WithLimit (0): Card with consumption limit.
- NoLimit (1): Card without consumption limit.
IdentifierProductProduct code associated with the card.StringYes
AmountNumber of cards to be requested in the batch.IntegerYes
AddressObject containing the delivery address for the batch.ObjectYes
├ LineStreet name of the delivery address.StringYes
├ NumberNumber of the delivery address.StringYes
├ ComplementAdditional details about the delivery address (e.g., apartment number).StringNo
├ ReferenceReference point for the delivery address.StringNo
├ NeighborhoodNeighborhood of the delivery address.StringYes
├ ZipCodeZIP code of the delivery address.StringYes
├ CityCity of the delivery address.StringYes
├ StateState of the delivery address.StringYes
├ CountryCountry of the delivery address.StringYes

Request Unnamed Card

Requests the issuance of unnamed cards, ideal for scenarios where it is not necessary to link the card to a specific user during issuance.

Example of requisition:

{
  "Method": "RequestUnnamedCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "CardOwner": {
    "OwnerTaxNumber": "59626023821",
    "Bank": "001",
    "BankBranch": "0001",
    "BankAccount": "01241455",
    "BankAccountDigit": "1",
    "FullName": "Adriana Teresinha Josefa Santos",
    "Phone": "71983928554",
    "Mail": "[email protected]"
  },
  "CardDeliveryAddress": {
    "Line": "Av José Bastos",
    "Number": "4140",
    "Complement": "AP 303",
    "Reference": "Ao lado da JM Veículos",
    "Neighborhood": "Rodolfo Teófilo",
    "ZipCode": "60431086",
    "City": "Fortaleza",
    "State": "CE",
    "Country": "Brasil"
  },
  "IdentifierProduct": "FC0000001",
  "UsageType": "1",
  "ConsumeType": "1"
}
{
  "Success": "true",
  "IdentifierCard": "800018694",
  "Message": "Solicitação de cartão processada com sucesso"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
CardOwnerObject containing information about the card owner.ObjectYes
├ OwnerTaxNumberTax identification number (CPF/CNPJ) of the card owner.StringYes
├ BankBank code of the card owner's account.StringYes
├ BankBranchBank branch code of the card owner's account.StringYes
├ BankAccountBank account number of the card owner.StringYes
├ BankAccountDigitBank account digit of the card owner.StringYes
├ FullNameFull name of the card owner.StringYes
├ PhonePhone number of the card owner.StringYes
├ MailEmail address of the card owner.StringYes
CardDeliveryAddressObject containing the delivery address for the card.ObjectYes
├ LineStreet name of the delivery address.StringYes
├ NumberNumber of the delivery address.StringYes
├ ComplementAdditional details about the delivery address (e.g., apartment number).StringNo
├ ReferenceReference point for the delivery address.StringNo
├ NeighborhoodNeighborhood of the delivery address.StringYes
├ ZipCodeZIP code of the delivery address.StringYes
├ CityCity of the delivery address.StringYes
├ StateState of the delivery address.StringYes
├ CountryCountry of the delivery address.StringYes
IdentifierProductChoose a card product code (IdentifierProduct) according to the desired design.StringYes
UsageTypeCard usage type. Options:StringYes
- Balance (0): Balance control by payment account.
- OverBalance (1): Balance control by representative account.
ConsumeTypeCard consumption type. Options:StringYes
- WithLimit (0): Card with consumption limit.
- NoLimit (1): Card without consumption limit.

📘

Important:

If the user wishes to include a confirmation step, it is necessary to enable the parameter "Requires further confirmation of card application" in the Business Unit (BU).

Bind Unnamed Card

Links an unnamed card to a cardholder or end user, enabling its secure and personalized usage.

Example of requisition:

{
  "Method": "BindUnnamedCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "CardOwner": {
    "OwnerTaxNumber": "59626023821",
    "Bank": "001",
    "BankBranch": "0001",
    "BankAccount": "01241455",
    "BankAccountDigit": "1",
    "FullName": "Adriana Teresinha Josefa Santos",
    "Phone": "71983928554",
    "Mail": "[email protected]"
  },
  "CardHolder": {
    "HolderTaxNumber": "59626023821",
    "FullName": "Adriana Teresinha Josefa Santos",
    "MotherName": "Allana Vanessa Josefa",
    "BirthDate": "1992/20/02",
    "Gender": "1",
    "Nationality": "Brasileira",
    "MaritalStatus": "5"
  },
  "CardHolderContact": {
    "Phone": "71983928554",
    "Mail": "[email protected]"
  },
  "IdentifierCard": "800015485",
  "UsageType": "1"
}
{
  "Success": "true",
  "Message": "Cartão vinculado com sucesso"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
CardOwnerInformation about the card owner. Contains the following fields:ObjectYes
├ OwnerTaxNumberCPF (tax identification number) of the card owner.StringYes
├ FullNameFull name of the card owner.StringYes
├ PhoneTelephone number (DDD + phone number) of the card owner.StringYes
├ MailEmail address of the card owner.StringYes
├ BankBank code associated with the card owner.StringOptional
├ BankAccountBank account number of the card owner.StringOptional
├ BankAccountDigitBank account digit of the card owner.StringOptional
├ BankBranchBank branch code associated with the card owner.StringOptional
CardHolderInformation about the cardholder. Contains the following fields:ObjectYes
├ HolderTaxNumberCPF (tax identification number) of the cardholder.StringYes
├ FullNameFull name of the cardholder.StringYes
├ MotherNameMother's full name of the cardholder.StringYes
├ BirthDateDate of birth of the cardholder (format: MM/DD/YYYY).StringYes
├ GenderGender of the cardholder (e.g., 1 for Male, 2 for Female).IntegerYes
- Male (0): Male.
- Female (1): Female.
- Other (2): Other.
├ NationalityNationality of the cardholder.StringYes
├ MaritalStatusMarital status of the cardholder. Valid values:IntegerYes
- NotMarried (Stable Union) = 0
- Married = 1
- Divorced = 2
- Separate = 3
- Widower = 4
- Single = 5
- Other = 6
CardHolderContactContact information of the cardholder. Contains the following fields:ObjectYes
├ PhoneTelephone number (DDD + phone number) of the cardholder.StringYes
├ MailEmail address of the cardholder.StringYes
IdentifierCardUnique identifier of the card to be bound.StringYes
UsageTypeType of card usage. Valid values:IntegerYes
- Balance control by payment account (Balance) = 0
- Balance control by representative account (OverBalance) = 1

Activate Card

Activates a previously issued card, making it ready for use in accordance with applicable rules and security measures.

Example of requisition:

{
  "Method": "ActivateCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485",
  "RateValue": 1.9,
  "RateValueType": "1"
}
{
  "Success": "true",
  "Message": " Solicitação de ativação registrada com sucesso!"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
IdentifierCardUnique identifier of the card to be activated. This method will only succeed after PaySmart confirms the card approval.StringYes
RateValueValue of the rate to be applied during card activation.DecimalYes
RateValueTypeDefines the rate type to be applied:IntegerYes
- Sent = 0 (Billing - Request)
- Default = 1 (Billing - BU)
- None = 2 (No Charge)

📘

Important:

If the user has used the "InactivateAndReissueCard" method, the new "Card" returned in the response must be provided in the "ActivateCard" method. Then, the "ChangePinCard" method must be executed to set the new card password.

Confirm Card Request

Confirms the request for a card or batch issuance, allowing the process to proceed after the necessary checks.

📘

Important:

This method can be used for both individual card requests and batch requests. In this case, the "IdentifierCard" field should be filled with the batch number.

Example of requisition:

{
  "Method": "ConfirmCardRequest",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485"
}
{
  "Success": "true",
  "IdentifierCard": "800015485",
  "Message": "Confirmação realizada com sucesso"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
IdentifierCardUnique identifier of the card whose request is being confirmed.StringYes

Cancel Card Request

Cancels a card or batch request before its completion, preventing unwanted or incorrect processes.

📘

Important:

The Card Status after using the “RequestCard” and “RequestUnnamedCard” methods:

  • This method can be used to cancel a card or a batch of cards (in this case, the "IdentifierCard" field will be filled with the card batch number).
  • CardStatus cannot be equal to (Canceled = 11).
  • CardStatus must be either (Pre-Created = 10) or (Created = 0).

Example of requisition:

{
  "Method": "CancelCardRequest",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "IdentifierCard": "800015485"
}
{
  "Success": "true",
  "Message": "Confirmação realizada com sucesso"
}

Field Descripition:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
IdentifierCardUnique identifier of the card whose request is being canceled. (This method will only be successful after PaySmart responds that your card was approved!)StringYes