Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Queries

Get Payments

Returns payments infos.

post/GetPayments

Request body

Methodstring required
PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

InitialDatestring

Start date for future posting

FinalDatestring

End date for future posting

InitialPaymentDatestring

Initial payment date

FinalPaymentDatestring

Final payment date

TaxNumberstring

Legal Identification From Company

InicialDatestring
BankBranchstring

Beneficiary's Bank Branch

BankAccountstring

Beneficiary's Account Number (without digit)

BankAccountDigitstring

Beneficiary's Account Digit

Statusstring

(Created = 0, CanBeSettled = 1, Settled = 2, Canceled = 3, ErrorBalance = 4, Error = 5, Expired = 6, Delayed = 7)

Example request

{
  "Method": "GetPayments",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "InitialDate": "2022-05-21",
  "FinalDate": "2022-05-15",
  "InitialPaymentDate": "2022-05-21",
  "FinalPaymentDate": "2022-05-21",
  "TaxNumber": "33.762.255/0001-40",
  "InicialDate": "2022/05/16",
  "Status": "0"
}

Response

OK

Successboolean
Paymentsstring

Example response

{
  "Payments": "{\"GAREs\":[{\"TaxNumber\":\"33109855046\",\"DueDate\":\"2022-05-20T00:00:00\",\"StateRegistration\":\"67890\",\"ActiveDebit\":\"1\",\"PrincipalValue\":168.67,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"TotalValue\":19288.67,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-10T00:00:00\",\"QuoteNumberNotification\":\"213\",\"CodeRevenue\":\"4321\",\"ContributorTaxNumber\":\"33109855046\",\"NumberReference\":\"012018\",\"NameContributor\":\"Ana Victoria\",\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"91846652a18742348f323178c3111339\",\"DocumentNumber\":40237,\"CreationDate\":\"2022-04-08T10:01:49.233\",\"Tags\":[\"Pagamento\"],\"Description\":\"Pagamento\"}],\"DARJs\":[{\"TaxNumber\":\"33109855046\",\"OriginDocument\":10,\"CodeRevenue\":\"34\",\"StateRegistration\":\"67890\",\"NumberReference\":\"12018\",\"PrincipalValue\":156.50,\"FineValue\":14.00,\"InterestValue\":24.00,\"MonetaryValue\":0.00,\"TotalValue\":194.50,\"DueDate\":\"2023-06-05T00:00:00\",\"PaymentDate\":\"2022-03-18T00:00:00\",\"NameContributor\":\"Ana Victoria\",\"DocumentNumber\":30240,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"PaymentAuthentication\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"Status\":0,\"ProtocolId\":\"504104f75c604192bd5ecad69ae544c6\",\"CreationDate\":\"2022-03-15T16:12:45.353\",\"Tags\":[\"Comercial\",\"Taxas\",\"Financeiro\"],\"Description\":\"Darj \"},{\"TaxNumber\":\"33109855046\",\"OriginDocument\":2,\"CodeRevenue\":\"4321\",\"StateRegistration\":\"67890\",\"NumberReference\":\"12018\",\"PrincipalValue\":190.67,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"MonetaryValue\":0.00,\"TotalValue\":19310.67,\"DueDate\":\"2022-05-20T00:00:00\",\"PaymentDate\":\"2022-05-10T00:00:00\",\"NameContributor\":\"Ana Victoria\",\"DocumentNumber\":30241,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"PaymentAuthentication\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"Status\":0,\"ProtocolId\":\"340705113ad941558733510aa840a0b3\",\"CreationDate\":\"2022-04-08T10:13:27.42\",\"Tags\":[\"Pagamento\"],\"Description\":\"Pagamento\"}],\"DARFs\":[{\"TaxNumber\":\"33109855046\",\"DarfType\":0,\"CalculationPeriod\":\"2021-11-03T00:00:00\",\"ReferenceNumber\":\"12518\",\"DueDate\":\"2019-10-24T00:00:00\",\"GrossRevenueValue\":0.00,\"GrossRevenuePercentage\":\"0\",\"PrincipalValue\":200.00,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2021-11-04T00:00:00\",\"CodeRevenue\":\"4256\",\"NumberCompanyInscription\":\"00330120004902588282\",\"PeriodCalculation\":\"2021-11-03T00:00:00\",\"NumberReference\":\"012518\",\"ValueInterestCharges\":17890.00,\"NameContributor\":\"Ana Victoria\",\"ValueRecipeGrossAccumulated\":0.00,\"PercentageRecipeGrossAccumulated\":0.00,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"7be11d68a55d4058bded23acec05db39\",\"DocumentNumber\":70440,\"CreationDate\":\"2021-11-03T14:33:21.447\",\"Tags\":[],\"Description\":\"Teste Integration\"},{\"TaxNumber\":\"33109855046\",\"DarfType\":0,\"CalculationPeriod\":\"2021-11-03T00:00:00\",\"ReferenceNumber\":\"12518\",\"DueDate\":\"2021-11-04T12:20:23.283\",\"GrossRevenueValue\":0.00,\"GrossRevenuePercentage\":\"0\",\"PrincipalValue\":200.00,\"FineValue\":0.00,\"InterestValue\":0.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2021-11-04T09:30:23.97\",\"CodeRevenue\":\"4256\",\"NumberCompanyInscription\":\"123066\",\"PeriodCalculation\":\"2021-11-03T00:00:00\",\"NumberReference\":\"012518\",\"ValueInterestCharges\":0.00,\"NameContributor\":\"Ana Victoria\",\"ValueRecipeGrossAccumulated\":0.00,\"PercentageRecipeGrossAccumulated\":0.00,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Itaú Unibanco\",\"SenderCodeBank\":\"341\",\"SenderBranch\":\"0845\",\"SenderAccount\":\"12306\",\"SenderAccountDigit\":\"6\",\"Returns\":[],\"ProtocolId\":\"247cfe28ce6c4999a0556db648847db4\",\"DocumentNumber\":70441,\"CreationDate\":\"2021-11-04T09:30:25.053\",\"Tags\":[],\"Description\":\"Teste integration\"},{\"TaxNumber\":\"33109855046\",\"DarfType\":0,\"CalculationPeriod\":\"2021-11-03T00:00:00\",\"ReferenceNumber\":\"12518\",\"DueDate\":\"2021-11-10T12:44:18.657\",\"GrossRevenueValue\":0.00,\"GrossRevenuePercentage\":\"0\",\"PrincipalValue\":200.00,\"FineValue\":0.00,\"InterestValue\":0.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2021-11-10T10:04:38.463\",\"CodeRevenue\":\"4256\",\"NumberCompanyInscription\":\"123066\",\"PeriodCalculation\":\"2021-11-03T00:00:00\",\"NumberReference\":\"012518\",\"ValueInterestCharges\":0.00,\"NameContributor\":\"Ana Victoria\",\"ValueRecipeGrossAccumulated\":0.00,\"PercentageRecipeGrossAccumulated\":0.00,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Itaú Unibanco\",\"SenderCodeBank\":\"341\",\"SenderBranch\":\"0845\",\"SenderAccount\":\"12306\",\"SenderAccountDigit\":\"6\",\"Returns\":[],\"ProtocolId\":\"d446ca0d1dfe4727b8a3e81e2d46a2e4\",\"DocumentNumber\":70444,\"CreationDate\":\"2021-11-10T10:04:39.03\",\"Tags\":[],\"Description\":\"Teste DARF integration\"},{\"TaxNumber\":\"33109855046\",\"DarfType\":1,\"CalculationPeriod\":\"2022-06-05T00:00:00\",\"ReferenceNumber\":\"12018\",\"DueDate\":\"2022-06-20T00:00:00\",\"GrossRevenueValue\":0.00,\"GrossRevenuePercentage\":\"1.0\",\"PrincipalValue\":168.67,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-10T00:00:00\",\"CodeRevenue\":\"4321\",\"NumberCompanyInscription\":\"00330120004902588282\",\"PeriodCalculation\":\"2022-06-05T00:00:00\",\"NumberReference\":\"012018\",\"ValueInterestCharges\":17890.00,\"NameContributor\":\"Ana Victoria\",\"ValueRecipeGrossAccumulated\":0.00,\"PercentageRecipeGrossAccumulated\":10.00,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"34cc9927160841148be7e39746d919a4\",\"DocumentNumber\":70452,\"CreationDate\":\"2022-04-08T09:35:13.157\",\"Tags\":[\"Comercial\",\"Taxas\",\"Financeiro\"],\"Description\":\"Pagamento\"}],\"BOLETOs\":[{\"Barcode\":\"03394894500000087671760680778200262003064000\",\"DueDate\":\"2022-04-04T00:00:00\",\"PaymentDate\":\"2022-04-18T00:00:00\",\"PrincipalValue\":87.67,\"InterestValue\":0.00,\"FineValue\":0.0,\"TotalValue\":87.67,\"DiscountValue\":0.00,\"ExtraValue\":0.00,\"PaymentValue\":87.67,\"Status\":0,\"WasAuthorized\":false,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"ReturnErrorMessage\":null,\"ReturnErrorCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"c112e4ce6515435d8ff61aa57236bd50\",\"DocumentNumber\":142578,\"CreationDate\":\"2022-04-04T13:32:42.037\",\"Tags\":[\"Teste1\"],\"Description\":\"Descrição do pagamento\"},{\"Barcode\":\"03396894900000019211760680778200262003064000\",\"DueDate\":\"2022-05-18T00:00:00\",\"PaymentDate\":\"2022-04-18T00:00:00\",\"PrincipalValue\":19.21,\"InterestValue\":0.00,\"FineValue\":0.0,\"TotalValue\":19.21,\"DiscountValue\":0.00,\"ExtraValue\":0.00,\"PaymentValue\":19.21,\"Status\":0,\"WasAuthorized\":false,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"ReturnErrorMessage\":null,\"ReturnErrorCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"dd975476219e4cc6bf0a92ea8e34397a\",\"DocumentNumber\":142579,\"CreationDate\":\"2022-04-08T13:42:04.543\",\"Tags\":[\"Teste1\"],\"Description\":\"Descrição do pagamento\"},{\"Barcode\":\"34191894900000070681760680778200262003064000\",\"DueDate\":\"2022-05-18T00:00:00\",\"PaymentDate\":\"2022-04-18T00:00:00\",\"PrincipalValue\":70.68,\"InterestValue\":0.00,\"FineValue\":0.0,\"TotalValue\":70.68,\"DiscountValue\":0.00,\"ExtraValue\":0.00,\"PaymentValue\":70.68,\"Status\":0,\"WasAuthorized\":false,\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"ReturnErrorMessage\":null,\"ReturnErrorCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"b19e9fb70ce34ca8aab13271c13563c4\",\"DocumentNumber\":142580,\"CreationDate\":\"2022-04-08T13:45:33.78\",\"Tags\":[\"Teste1\"],\"Description\":\"Descrição do pagamento\"}],\"GPSs\":[{\"TaxNumber\":\"33109855046\",\"ReferenceNumber\":0,\"PrincipalValue\":168.67,\"FineInterestValue\":0.00,\"InterestValue\":0.0,\"TotalValue\":168.67,\"OtherValues\":0.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-10T00:00:00\",\"ContributorTaxNumber\":\"33109855046\",\"NameContributor\":\"Ana Victoria\",\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"9bc429f9e2c342159146552704965ad0\",\"DocumentNumber\":60384,\"CreationDate\":\"2022-04-08T10:08:02.567\",\"Tags\":[\"Pagamento\"],\"Description\":\"Pagamento\"}], \"GRUs\":[{\"TaxNumber\":\"91151523089\",\"DueDate\":\"2024-08-15T00:00:00\",\"PrincipalValue\":7783.00,\"DiscountValue\":0.00,\"OtherDeductions\":0.00,\"FineValue\":0.00,\"InterestValue\":0.0,\"OtherValues\":0.0,\"TotalValue\":7783.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2024-08-14T11:34:42.05\",\"RevenueCode\":null,\"ContributorTaxNumber\":\"91151523089\",\"ContributorName\":null,\"ReferenceNumber\":\"201942011\",\"GruOutType\":0,\"ManagerUnit\":null,\"BarCode\":\"89620000000778300012018110831018100030355704\",\"Competence\":\"06/2024\",\"PaymentAuthentication\":null,\"ReceiptUrl\":\"https://stagereceipt.fitbank.com.br/receipt/pdf?filename=2024-08-14/pr1gpeil.pdf\",\"SenderAccount\":\"73105\",\"SenderAccountDigit\":\"4\",\"SenderBranch\":\"2902\",\"SenderCodeBank\":\"341\",\"SenderNameBank\":\"Itaú Unibanco\",\"ProtocolId\":null,\"DocumentNumber\":96,\"CreationDate\":\"2024-08-14T11:34:44.707\",\"Tags\":[],\"Description\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"Returns\":[],\"FGTSs\":[{\"TaxNumber\":\"33109855046\",\"ReferenceNumber\":0,\"PrincipalValue\":168.67,\"CodeRevenue\":\"4321\",\"Barcode\":\"03394894500000087671760680778200262003064000\",\"FgtsIdentifier\":\"9\",\"SocialConnectivityCode\":0,\"SocialConnectivityDigit\":0,\"TotalValue\":168.67,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-16T00:00:00\",\"ContributorTaxNumber\":\"33109855046\",\"NameContributor\":\"Ana Victoria\",\"PaymentAuthentication\":null,\"ReceiptUrl\":null,\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"ProtocolId\":\"a29dd9ff217b42289ff94f72de9cfdcf\",\"DocumentNumber\":20252,\"CreationDate\":\"2022-04-08T10:28:49\",\"Tags\":[\"Pagamento\"],\"Description\":\"Pagamento\"}],\"TEDs\":[],\"INTERNALTRANSFERs\":[]}"
}