POST v2/{token}/transacao/boleto
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
token | string |
Required |
Body Parameters
TransacaoBoletoRequestName | Description | Type | Additional information |
---|---|---|---|
amount | integer |
None. |
|
currency | string |
None. |
|
description | string |
None. |
|
reference_id | string |
None. |
|
on_behalf_of | string |
None. |
|
customer | string |
None. |
|
payment_type | string |
None. |
|
payment_method | MetodoPagamentoRequest |
None. |
|
split_rules | Collection of Split |
None. |
Request Formats
application/json, text/json
Sample:
{ "amount": 1, "currency": "sample string 2", "description": "sample string 3", "reference_id": "sample string 4", "on_behalf_of": "sample string 5", "customer": "sample string 6", "payment_type": "sample string 7", "payment_method": { "expiration_date": "sample string 1", "payment_limit_date": "sample string 2", "body_instructions": [ "sample string 1", "sample string 2" ], "billing_instructions": { "late_fee": { "mode": "sample string 1", "amount": 2, "percentage": 3, "start_date": "sample string 4" }, "interest": { "mode": "sample string 1", "amount": 2.0, "percentage": 3.0, "start_date": "sample string 4" }, "discount": [ { "mode": "sample string 1", "limit_date": "sample string 2", "amount": 3, "percentage": 4 }, { "mode": "sample string 1", "limit_date": "sample string 2", "amount": 3, "percentage": 4 } ] } }, "split_rules": [ { "id": "sample string 1", "resource": "sample string 2", "transaction": "sample string 3", "recipient": "sample string 4", "liable": true, "charge_processing_fee": true, "charge_recipient_processing_fee": true, "percentage": 8.0, "amount": 9.0, "is_gross_amount": true, "receivable_amount": 11.0, "receivable_gross_amount": 12.0, "created_at": "sample string 13", "updated_at": "sample string 14" }, { "id": "sample string 1", "resource": "sample string 2", "transaction": "sample string 3", "recipient": "sample string 4", "liable": true, "charge_processing_fee": true, "charge_recipient_processing_fee": true, "percentage": 8.0, "amount": 9.0, "is_gross_amount": true, "receivable_amount": 11.0, "receivable_gross_amount": 12.0, "created_at": "sample string 13", "updated_at": "sample string 14" } ] }
application/xml, text/xml
Sample:
<TransacaoBoletoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoctusPay.Request"> <MetodoPagamento> <Instrucao> <Descontos> <DescontoBoletoRequest> <amount>3</amount> <limit_date>sample string 2</limit_date> <mode>sample string 1</mode> <percentage>4</percentage> </DescontoBoletoRequest> <DescontoBoletoRequest> <amount>3</amount> <limit_date>sample string 2</limit_date> <mode>sample string 1</mode> <percentage>4</percentage> </DescontoBoletoRequest> </Descontos> <InformacaoBoleto> <amount>2</amount> <mode>sample string 1</mode> <percentage>3</percentage> <start_date>sample string 4</start_date> </InformacaoBoleto> <TaxaAtraso> <amount>2</amount> <mode>sample string 1</mode> <percentage>3</percentage> <start_date>sample string 4</start_date> </TaxaAtraso> </Instrucao> <body_instructions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </body_instructions> <expiration_date>sample string 1</expiration_date> <payment_limit_date>sample string 2</payment_limit_date> </MetodoPagamento> <Splits xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoctusPay.Dominio"> <d2p1:Split> <d2p1:Amount>9</d2p1:Amount> <d2p1:ChargeProcessingFee>true</d2p1:ChargeProcessingFee> <d2p1:ChargeRecipientProcessingFee>true</d2p1:ChargeRecipientProcessingFee> <d2p1:CreatedAt>sample string 13</d2p1:CreatedAt> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IsGrossAmount>true</d2p1:IsGrossAmount> <d2p1:Liable>true</d2p1:Liable> <d2p1:Percentage>8</d2p1:Percentage> <d2p1:ReceivableAmount>11</d2p1:ReceivableAmount> <d2p1:ReceivableGrossAmount>12</d2p1:ReceivableGrossAmount> <d2p1:Recipient>sample string 4</d2p1:Recipient> <d2p1:Resource>sample string 2</d2p1:Resource> <d2p1:Transaction>sample string 3</d2p1:Transaction> <d2p1:UpdatedAt>sample string 14</d2p1:UpdatedAt> </d2p1:Split> <d2p1:Split> <d2p1:Amount>9</d2p1:Amount> <d2p1:ChargeProcessingFee>true</d2p1:ChargeProcessingFee> <d2p1:ChargeRecipientProcessingFee>true</d2p1:ChargeRecipientProcessingFee> <d2p1:CreatedAt>sample string 13</d2p1:CreatedAt> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IsGrossAmount>true</d2p1:IsGrossAmount> <d2p1:Liable>true</d2p1:Liable> <d2p1:Percentage>8</d2p1:Percentage> <d2p1:ReceivableAmount>11</d2p1:ReceivableAmount> <d2p1:ReceivableGrossAmount>12</d2p1:ReceivableGrossAmount> <d2p1:Recipient>sample string 4</d2p1:Recipient> <d2p1:Resource>sample string 2</d2p1:Resource> <d2p1:Transaction>sample string 3</d2p1:Transaction> <d2p1:UpdatedAt>sample string 14</d2p1:UpdatedAt> </d2p1:Split> </Splits> <amount>1</amount> <currency>sample string 2</currency> <customer>sample string 6</customer> <description>sample string 3</description> <on_behalf_of>sample string 5</on_behalf_of> <payment_type>sample string 7</payment_type> <reference_id>sample string 4</reference_id> </TransacaoBoletoRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |