POST api/Card/InsertCardTransaction
Request Information
URI Parameters
None.
Body Parameters
CardTransaction| Name | Description | Type | Additional information |
|---|---|---|---|
| MerchantOrderId | string |
None. |
|
| AuthCode | string |
None. |
|
| DateCreated | date |
None. |
|
| ProofOfSale | string |
None. |
|
| PaymentDate | date |
None. |
|
| EmittedDate | date |
None. |
|
| Plate | string |
None. |
|
| Aborted | boolean |
None. |
|
| Status | integer |
None. |
|
| Customer | CardCustomer |
None. |
|
| Payment | CardPayment |
None. |
|
| ItemType | string |
None. |
|
| Items | Collection of CardItem |
None. |
|
| Classification | CardClassification |
None. |
|
| MerchantOrderIdNumbers | string |
None. |
|
| SpecialDescription | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"MerchantOrderId": "sample string 1",
"AuthCode": "sample string 2",
"DateCreated": "2026-07-22T11:49:37.4193646-03:00",
"ProofOfSale": "sample string 4",
"PaymentDate": "2026-07-22T11:49:37.4193646-03:00",
"EmittedDate": "2026-07-22T11:49:37.4193646-03:00",
"Plate": "sample string 6",
"Aborted": true,
"Status": 8,
"Customer": {
"CustomerId": 1,
"Name": "sample string 2",
"Civil_Status": "sample string 3",
"Cpf": "sample string 4",
"Gender": "sample string 5",
"Birth": "sample string 6",
"Identidade": "sample string 7",
"Orgao_Expedidor": "sample string 8",
"Address": {
"Address1": "sample string 1",
"Number": 2,
"Address2": "sample string 3",
"Neighborhood": "sample string 4",
"Zipcode": 5,
"City": "sample string 6",
"State": "sample string 7"
},
"ContactInfo": {
"Name": "sample string 1",
"DDD1": 2,
"Phone1": "sample string 3",
"Email": "sample string 4"
}
},
"Payment": {
"CreditCard": {
"CardNumber": "sample string 1",
"Holder": "sample string 2",
"ExpirationDate": "sample string 3",
"Brand": "sample string 4"
},
"Installments": 1,
"TotalAmount": 2.0,
"AuthorizationCode": "sample string 3"
},
"ItemType": "sample string 9",
"Items": [
{
"Description": "sample string 1",
"Amount": 2
},
{
"Description": "sample string 1",
"Amount": 2
}
],
"Classification": {
"Department": 1,
"OriginOperation": 2,
"TypeDocument": 3,
"ManagementAccount": 4,
"ClassificationAccount": 5,
"PaymentTerms": 6,
"ChargeAgent": 7,
"InvoiceNumber": "sample string 8",
"ItemOrderDescription": "sample string 9",
"GeneralDescription": "sample string 10",
"ItemSingleType": 11,
"InvoiceNumberOnlyDigits": "8"
},
"MerchantOrderIdNumbers": "1",
"SpecialDescription": "Número da Nota: 8 - NSU: sample string 4 - Código Autorização: sample string 2 - Data Transação: 22-07-2026 - Bandeira: sample string 4"
}
application/xml, text/xml
Sample:
<CardTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LibraryCardIntegration.Models">
<Aborted>true</Aborted>
<AuthCode>sample string 2</AuthCode>
<Classification xmlns:d2p1="http://schemas.datacontract.org/2004/07/LibraryCardIntegration.Models.Card">
<d2p1:ChargeAgent>7</d2p1:ChargeAgent>
<d2p1:ClassificationAccount>5</d2p1:ClassificationAccount>
<d2p1:Department>1</d2p1:Department>
<d2p1:GeneralDescription>sample string 10</d2p1:GeneralDescription>
<d2p1:InvoiceNumber>sample string 8</d2p1:InvoiceNumber>
<d2p1:ItemOrderDescription>sample string 9</d2p1:ItemOrderDescription>
<d2p1:ItemSingleType>11</d2p1:ItemSingleType>
<d2p1:ManagementAccount>4</d2p1:ManagementAccount>
<d2p1:OriginOperation>2</d2p1:OriginOperation>
<d2p1:PaymentTerms>6</d2p1:PaymentTerms>
<d2p1:TypeDocument>3</d2p1:TypeDocument>
</Classification>
<CompanyCode>10</CompanyCode>
<Customer>
<Address>
<Address1>sample string 1</Address1>
<Address2>sample string 3</Address2>
<City>sample string 6</City>
<Neighborhood>sample string 4</Neighborhood>
<Number>2</Number>
<State>sample string 7</State>
<Zipcode>5</Zipcode>
</Address>
<Birth>sample string 6</Birth>
<CivilStatus>sample string 3</CivilStatus>
<ContactInfo>
<Ddd1>2</Ddd1>
<Email>sample string 4</Email>
<Name>sample string 1</Name>
<Phone1>sample string 3</Phone1>
</ContactInfo>
<Cpf>sample string 4</Cpf>
<CustomerId>1</CustomerId>
<Gender>sample string 5</Gender>
<Identidade>sample string 7</Identidade>
<Name>sample string 2</Name>
<OrgaoExpedidor>sample string 8</OrgaoExpedidor>
</Customer>
<DateCreated>2026-07-22T11:49:37.4193646-03:00</DateCreated>
<EmittedDate>2026-07-22T11:49:37.4193646-03:00</EmittedDate>
<ItemType>sample string 9</ItemType>
<Items>
<CardItem>
<Amount>2</Amount>
<Description>sample string 1</Description>
</CardItem>
<CardItem>
<Amount>2</Amount>
<Description>sample string 1</Description>
</CardItem>
</Items>
<MerchantOrderId>sample string 1</MerchantOrderId>
<Payment>
<AuthorizationCode>sample string 3</AuthorizationCode>
<CreditCard>
<Brand>sample string 4</Brand>
<CardNumber>sample string 1</CardNumber>
<ExpirationDate>sample string 3</ExpirationDate>
<Holder>sample string 2</Holder>
</CreditCard>
<Installments>1</Installments>
<TotalAmount>2</TotalAmount>
</Payment>
<PaymentDate>2026-07-22T11:49:37.4193646-03:00</PaymentDate>
<Plate>sample string 6</Plate>
<ProofOfSale>sample string 4</ProofOfSale>
<Status>8</Status>
</CardTransaction>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CardResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Codigo | string |
None. |
|
| Sucesso | boolean |
None. |
|
| Mensagem | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Codigo": "sample string 1",
"Sucesso": true,
"Mensagem": "sample string 3"
}
application/xml, text/xml
Sample:
<CardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LibraryCardIntegration.Models"> <Code>sample string 1</Code> <Message>sample string 3</Message> <Success>true</Success> </CardResponse>