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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
UsageType | Card usage type. Options: | String | Yes |
- Balance (0): Balance control by payment account. | |||
- OverBalance (1): Balance control by representative account. | |||
ConsumeType | Card consumption type. | String | Yes |
- WithLimit (0): Card with consumption limit. | |||
- NoLimit (1): Card without consumption limit. | |||
IdentifierProduct | Product code associated with the card according to the desired design. | String | Yes |
EmbossingName | Name to be printed on the card (character limit: 22). | String | Yes |
EmbossingNameType | Type of name to be printed. Options: | String | Yes |
- CardHolder (0): Cardholder's name. | |||
- CardOwner (1): Owner's name. | |||
RateValueType | Type of rate for charging. Options: | String | No |
- Sent (0): Charge for the request. | |||
- Default (1): Default charge by the business unit. | |||
- None (2): No charge. | |||
RateValue | Rate value for charging (used when RateValueType = Sent). | Float | No |
CardOwner | Object containing information about the card owner. | Object | Yes |
├ OwnerTaxNumber | Tax identification number (CPF/CNPJ) of the card owner. | String | Yes |
├ FullName | Full name of the owner (character limit: 22 if EmbossingNameType = 1). | String | Yes |
├ Phone | Phone number with area code. Example: 71983928554. | String | Yes |
Email of the owner. Example: [email protected]. | String | Yes | |
├ Bank | Bank code of the owner's account. | String | No |
├ BankBranch | Bank branch code of the owner's account. | String | No |
├ BankAccount | Bank account number of the owner. | String | No |
├ BankAccountDigit | Bank account digit of the owner. | String | No |
CardHolder | Object containing information about the cardholder. | Object | Yes |
├ HolderTaxNumber | Tax identification number (CPF) of the cardholder. | String | Yes |
├ FullName | Full name of the cardholder (character limit: 22 if EmbossingNameType = 0). | String | Yes |
├ MotherName | Cardholder's mother's full name. | String | Yes |
├ BirthDate | Date of birth in MM/DD/YYYY format. | String | Yes |
├ Gender | Cardholder's gender. Options: | String | Yes |
- Male (0): Male. | |||
- Female (1): Female. | |||
- Other (2): Other. | |||
├ Nationality | Cardholder's nationality. | String | Yes |
├ MaritalStatus | Cardholder's marital status. Options: | String | Yes |
- NotMarried (0): Stable union. | |||
- Married (1): Married. | |||
- Divorced (2): Divorced. | |||
- Separate (3): Separated. | |||
- Widower (4): Widowed. | |||
- Single (5): Single. | |||
- Other (6): Other. | |||
CardHolderContact | Object containing the cardholder's contact details. | Object | Yes |
├ Phone | Cardholder's phone number. Example: 71983928554. | String | Yes |
Cardholder's email. Example: [email protected]. | String | Yes | |
BillingAddress | Object containing the billing address for the card. | Object | Yes |
├ Line | Street name. Example: Av José Bastos. | String | Yes |
├ Number | Residence number. Example: 4140. | String | Yes |
├ Complement | Additional details. Example: AP 303. | String | No |
├ Reference | Reference point. Example: Near JM Vehicles. | String | No |
├ Neighborhood | Neighborhood. Example: Rodolfo Teófilo. | String | Yes |
├ ZipCode | ZIP code. Example: 60431086. | String | Yes |
├ City | City. Example: Fortaleza. | String | Yes |
├ State | State. Example: EC. | String | Yes |
├ Country | Country. Example: Brazil. | String | Yes |
CardDeliveryAddress | Object containing the delivery address for the card. | Object | Yes |
├ Line | Street name. Example: Av José Bastos. | String | Yes |
├ Number | Residence number. Example: 4140. | String | Yes |
├ Complement | Additional details. Example: AP 303. | String | No |
├ Reference | Reference point. Example: Near JM Vehicles. | String | No |
├ Neighborhood | Neighborhood. Example: Rodolfo Teófilo. | String | Yes |
├ ZipCode | ZIP code. Example: 60431086. | String | Yes |
├ City | City. Example: Fortaleza. | String | Yes |
├ State | State. Example: EC. | String | Yes |
├ Country | Country. Example: Brazil. | String | Yes |
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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
UsageType | Card usage type. Options: | String | Yes |
- Balance (0): Balance control by payment account. | |||
- OverBalance (1): Balance control by representative account. | |||
ConsumeType | Card consumption type. Options: | String | Yes |
- WithLimit (0): Card with consumption limit. | |||
- NoLimit (1): Card without consumption limit. | |||
IdentifierProduct | Product code associated with the card. | String | Yes |
Amount | Number of cards to be requested in the batch. | Integer | Yes |
Address | Object containing the delivery address for the batch. | Object | Yes |
├ Line | Street name of the delivery address. | String | Yes |
├ Number | Number of the delivery address. | String | Yes |
├ Complement | Additional details about the delivery address (e.g., apartment number). | String | No |
├ Reference | Reference point for the delivery address. | String | No |
├ Neighborhood | Neighborhood of the delivery address. | String | Yes |
├ ZipCode | ZIP code of the delivery address. | String | Yes |
├ City | City of the delivery address. | String | Yes |
├ State | State of the delivery address. | String | Yes |
├ Country | Country of the delivery address. | String | Yes |
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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
CardOwner | Object containing information about the card owner. | Object | Yes |
├ OwnerTaxNumber | Tax identification number (CPF/CNPJ) of the card owner. | String | Yes |
├ Bank | Bank code of the card owner's account. | String | Yes |
├ BankBranch | Bank branch code of the card owner's account. | String | Yes |
├ BankAccount | Bank account number of the card owner. | String | Yes |
├ BankAccountDigit | Bank account digit of the card owner. | String | Yes |
├ FullName | Full name of the card owner. | String | Yes |
├ Phone | Phone number of the card owner. | String | Yes |
Email address of the card owner. | String | Yes | |
CardDeliveryAddress | Object containing the delivery address for the card. | Object | Yes |
├ Line | Street name of the delivery address. | String | Yes |
├ Number | Number of the delivery address. | String | Yes |
├ Complement | Additional details about the delivery address (e.g., apartment number). | String | No |
├ Reference | Reference point for the delivery address. | String | No |
├ Neighborhood | Neighborhood of the delivery address. | String | Yes |
├ ZipCode | ZIP code of the delivery address. | String | Yes |
├ City | City of the delivery address. | String | Yes |
├ State | State of the delivery address. | String | Yes |
├ Country | Country of the delivery address. | String | Yes |
IdentifierProduct | Choose a card product code (IdentifierProduct) according to the desired design. | String | Yes |
UsageType | Card usage type. Options: | String | Yes |
- Balance (0): Balance control by payment account. | |||
- OverBalance (1): Balance control by representative account. | |||
ConsumeType | Card consumption type. Options: | String | Yes |
- 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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
CardOwner | Information about the card owner. Contains the following fields: | Object | Yes |
├ OwnerTaxNumber | CPF (tax identification number) of the card owner. | String | Yes |
├ FullName | Full name of the card owner. | String | Yes |
├ Phone | Telephone number (DDD + phone number) of the card owner. | String | Yes |
Email address of the card owner. | String | Yes | |
├ Bank | Bank code associated with the card owner. | String | Optional |
├ BankAccount | Bank account number of the card owner. | String | Optional |
├ BankAccountDigit | Bank account digit of the card owner. | String | Optional |
├ BankBranch | Bank branch code associated with the card owner. | String | Optional |
CardHolder | Information about the cardholder. Contains the following fields: | Object | Yes |
├ HolderTaxNumber | CPF (tax identification number) of the cardholder. | String | Yes |
├ FullName | Full name of the cardholder. | String | Yes |
├ MotherName | Mother's full name of the cardholder. | String | Yes |
├ BirthDate | Date of birth of the cardholder (format: MM/DD/YYYY). | String | Yes |
├ Gender | Gender of the cardholder (e.g., 1 for Male, 2 for Female). | Integer | Yes |
- Male (0): Male. | |||
- Female (1): Female. | |||
- Other (2): Other. | |||
├ Nationality | Nationality of the cardholder. | String | Yes |
├ MaritalStatus | Marital status of the cardholder. Valid values: | Integer | Yes |
- NotMarried (Stable Union) = 0 | |||
- Married = 1 | |||
- Divorced = 2 | |||
- Separate = 3 | |||
- Widower = 4 | |||
- Single = 5 | |||
- Other = 6 | |||
CardHolderContact | Contact information of the cardholder. Contains the following fields: | Object | Yes |
├ Phone | Telephone number (DDD + phone number) of the cardholder. | String | Yes |
Email address of the cardholder. | String | Yes | |
IdentifierCard | Unique identifier of the card to be bound. | String | Yes |
UsageType | Type of card usage. Valid values: | Integer | Yes |
- 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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
IdentifierCard | Unique identifier of the card to be activated. This method will only succeed after PaySmart confirms the card approval. | String | Yes |
RateValue | Value of the rate to be applied during card activation. | Decimal | Yes |
RateValueType | Defines the rate type to be applied: | Integer | Yes |
- 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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
IdentifierCard | Unique identifier of the card whose request is being confirmed. | String | Yes |
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:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
IdentifierCard | Unique identifier of the card whose request is being canceled. (This method will only be successful after PaySmart responds that your card was approved!) | String | Yes |
Updated 11 days ago