POST api/v1/TransacaoAssinaturaPagarMe/Create
Request Information
URI Parameters
None.
Body Parameters
TransacaoAssinaturaPagarMeCreateModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TransactionId | string |
None. |
|
| Amount | decimal number |
Required |
|
| DataTransacao | date |
None. |
|
| HoraTransacao | string |
String length: inclusive between 0 and 8 |
|
| StatusGateway | string |
Required String length: inclusive between 0 and 30 |
|
| DescricaoStatusGateway | string |
Required String length: inclusive between 0 and 50 |
|
| Tid | integer |
None. |
|
| CodAuthorization | integer |
None. |
|
| NumberCard | string |
String length: inclusive between 0 and 20 |
|
| ExpirationMonth | integer |
None. |
|
| ExpirationYear | integer |
None. |
|
| BrandCard | string |
String length: inclusive between 0 and 20 |
|
| CPFCardNumber | string |
String length: inclusive between 0 and 15 |
|
| NameCardNumber | string |
String length: inclusive between 0 and 60 |
|
| Parcelas | integer |
None. |
|
| DataInicioPeriodo | date |
None. |
|
| DataFinalPeriodo | date |
None. |
|
| AssinaturaPagarMe_Id | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"TransactionId": "sample string 1",
"Amount": 2.1,
"DataTransacao": "2026-01-21T11:11:34.5641947-03:00",
"HoraTransacao": "sample string 4",
"StatusGateway": "sample string 5",
"DescricaoStatusGateway": "sample string 6",
"Tid": 7,
"CodAuthorization": 8,
"NumberCard": "sample string 9",
"ExpirationMonth": 10,
"ExpirationYear": 11,
"BrandCard": "sample string 12",
"CPFCardNumber": "sample string 13",
"NameCardNumber": "sample string 14",
"Parcelas": 15,
"DataInicioPeriodo": "2026-01-21T11:11:34.5641947-03:00",
"DataFinalPeriodo": "2026-01-21T11:11:34.5641947-03:00",
"AssinaturaPagarMe_Id": 18
}
application/xml, text/xml
Sample:
<TransacaoAssinaturaPagarMeCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GT.Model"> <Amount>2.1</Amount> <AssinaturaPagarMe_Id>18</AssinaturaPagarMe_Id> <BrandCard>sample string 12</BrandCard> <CPFCardNumber>sample string 13</CPFCardNumber> <CodAuthorization>8</CodAuthorization> <DataFinalPeriodo>2026-01-21T11:11:34.5641947-03:00</DataFinalPeriodo> <DataInicioPeriodo>2026-01-21T11:11:34.5641947-03:00</DataInicioPeriodo> <DataTransacao>2026-01-21T11:11:34.5641947-03:00</DataTransacao> <DescricaoStatusGateway>sample string 6</DescricaoStatusGateway> <ExpirationMonth>10</ExpirationMonth> <ExpirationYear>11</ExpirationYear> <HoraTransacao>sample string 4</HoraTransacao> <NameCardNumber>sample string 14</NameCardNumber> <NumberCard>sample string 9</NumberCard> <Parcelas>15</Parcelas> <StatusGateway>sample string 5</StatusGateway> <Tid>7</Tid> <TransactionId>sample string 1</TransactionId> </TransacaoAssinaturaPagarMeCreateModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TransacaoAssinaturaPagarMe| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Guid | globally unique identifier |
Required |
|
| TransactionId | string |
String length: inclusive between 0 and 50 |
|
| Amount | decimal number |
None. |
|
| TaxaAdm | decimal number |
None. |
|
| DataTransacao | date |
None. |
|
| HoraTransacao | string |
String length: inclusive between 0 and 8 |
|
| StatusGateway | string |
String length: inclusive between 0 and 30 |
|
| DescricaoStatusGateway | string |
String length: inclusive between 0 and 50 |
|
| Tid | integer |
None. |
|
| CodAuthorization | integer |
None. |
|
| NumberCard | string |
String length: inclusive between 0 and 20 |
|
| ExpirationMonth | integer |
None. |
|
| ExpirationYear | integer |
None. |
|
| BrandCard | string |
String length: inclusive between 0 and 20 |
|
| CPFCardNumber | string |
String length: inclusive between 0 and 15 |
|
| NameCardNumber | string |
String length: inclusive between 0 and 60 |
|
| Parcelas | integer |
None. |
|
| DataInicioPeriodo | date |
None. |
|
| DataFinalPeriodo | date |
None. |
|
| AssinaturaPagarMe | AssinaturaPagarMe |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"Guid": "b951c000-5ea5-43c3-ad03-dac8926c68c8",
"TransactionId": "sample string 3",
"Amount": 4.1,
"TaxaAdm": 5.1,
"DataTransacao": "2026-01-21T11:11:34.5797949-03:00",
"HoraTransacao": "sample string 7",
"StatusGateway": "sample string 8",
"DescricaoStatusGateway": "sample string 9",
"Tid": 10,
"CodAuthorization": 11,
"NumberCard": "sample string 12",
"ExpirationMonth": 13,
"ExpirationYear": 14,
"BrandCard": "sample string 15",
"CPFCardNumber": "sample string 16",
"NameCardNumber": "sample string 17",
"Parcelas": 18,
"DataInicioPeriodo": "2026-01-21T11:11:34.5797949-03:00",
"DataFinalPeriodo": "2026-01-21T11:11:34.5797949-03:00",
"AssinaturaPagarMe": {
"Id": 1,
"DataInicioPeriodoAtual": "2026-01-21T11:11:34.5797949-03:00",
"DataFinalPeriodoAtual": "2026-01-21T11:11:34.5797949-03:00",
"Guid": "31d686e4-4059-4883-9411-90ea8482ec44",
"AssinaturaIdPagarMe": 5,
"StatusAssinatura": "sample string 6",
"DescricaoStatusAssinatura": "sample string 7",
"Cobrancas": 8,
"LinkAssinaturaPagarMe": "sample string 9"
}
}
application/xml, text/xml
Sample:
<TransacaoAssinaturaPagarMe xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GT.Entidade">
<Amount>4.1</Amount>
<AssinaturaPagarMe>
<AssinaturaIdPagarMe>5</AssinaturaIdPagarMe>
<Cobrancas>8</Cobrancas>
<DataFinalPeriodoAtual>2026-01-21T11:11:34.5797949-03:00</DataFinalPeriodoAtual>
<DataInicioPeriodoAtual>2026-01-21T11:11:34.5797949-03:00</DataInicioPeriodoAtual>
<DescricaoStatusAssinatura>sample string 7</DescricaoStatusAssinatura>
<Guid>31d686e4-4059-4883-9411-90ea8482ec44</Guid>
<Id>1</Id>
<LinkAssinaturaPagarMe>sample string 9</LinkAssinaturaPagarMe>
<StatusAssinatura>sample string 6</StatusAssinatura>
</AssinaturaPagarMe>
<BrandCard>sample string 15</BrandCard>
<CPFCardNumber>sample string 16</CPFCardNumber>
<CodAuthorization>11</CodAuthorization>
<DataFinalPeriodo>2026-01-21T11:11:34.5797949-03:00</DataFinalPeriodo>
<DataInicioPeriodo>2026-01-21T11:11:34.5797949-03:00</DataInicioPeriodo>
<DataTransacao>2026-01-21T11:11:34.5797949-03:00</DataTransacao>
<DescricaoStatusGateway>sample string 9</DescricaoStatusGateway>
<ExpirationMonth>13</ExpirationMonth>
<ExpirationYear>14</ExpirationYear>
<Guid>b951c000-5ea5-43c3-ad03-dac8926c68c8</Guid>
<HoraTransacao>sample string 7</HoraTransacao>
<Id>1</Id>
<NameCardNumber>sample string 17</NameCardNumber>
<NumberCard>sample string 12</NumberCard>
<Parcelas>18</Parcelas>
<StatusGateway>sample string 8</StatusGateway>
<TaxaAdm>5.1</TaxaAdm>
<Tid>10</Tid>
<TransactionId>sample string 3</TransactionId>
</TransacaoAssinaturaPagarMe>