v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payments

Generate Payment GPS

Method used to generate Gps.

post/GeneratePaymentGPS

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

TaxNumberstring required

Legal Identification From Company

ContributorTaxNumberstring required

PrincipalValuenumber float required

Collection Order Value

FineInterestValuenumber

OtherValuesnumber

RateValuenumber

Rate value

PaymentDatenumber required

Constitution Date

DueDatestring date

Date of Due (format YYYY-MM-DD)

Tagsstring[]

Example request

{
  "Method": "GeneratePaymentGPS",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "TaxNumber": "33.762.255/0001-40",
  "ContributorTaxNumber": "87649862097",
  "PrincipalValue": 5,
  "RateValue": 12.5,
  "DueDate": "2022-10-24",
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ],
  "RateValueType": 1,
  "Description": "This is a new internal transfer",
  "Identifier": "PurchaseTest1106new4",
  "PaymentCode": "3213",
  "ReferenceNumber": "012018",
  "JurisdictionDate": "102017",
  "FromBank": "001",
  "FromBankBranch": "0801",
  "FromBankAccount": "0178945",
  "FromBankAccountDigit": "5",
  "ContributorDocumentType": 2
}

Response

Successboolean

DocumentNumberinteger

Urlstring

Example response

{
  "DocumentNumber": 30336,
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/b4ecclde.pdf\""
}