v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payment and Payment Management

GeneratePixOut

This method can be used to generate a pix payment

post/GeneratePixOut

Request body

Methodstring required

PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required

TaxNumberstring required

Legal Identification From Company

BankBranchstring required

Beneficiary's Bank Branch

BankAccountstring required

Beneficiary's Account Number (without digit)

BankAccountDigitstring required

Beneficiary's Account Digit

ToNamestring

Name

ToTaxNumberstring

CPF/CNPJ

ToBankstring

Bank code

ToISPBstring

ToBankBranchstring

Bank branch

ToBankAccountstring

Bank account

ToBankAccountDigitstring

Bank account digit

Valuenumber required

Value Of The Transaction without Rates

PixKeystring

PixKeyTypeinteger

SocialSecurity = 0 TaxNumber = 1 Email = 2 PhoneNumber = 3 RamdomKeyCode = 4

AccountTypeinteger

Current = 0, Salary = 1, Saving = 2, Payment = 3

RateValuenumber

Rate value

RateValueTypeinteger

Rate type

Identifierstring required

Identifier Of The Transaction

PaymentDatenumber required

Constitution Date

Descriptionstring

Tagsstring[]

Example request

{
  "Method": "GeneratePixOut",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "TaxNumber": "33.762.255/0001-40",
  "ToName": "Maria Júlia Soares",
  "ToTaxNumber": "548.611.276-66",
  "ToBank": "001",
  "ToISPB": "13203354",
  "ToBankBranch": "0801",
  "ToBankAccount": "157567",
  "ToBankAccountDigit": "5",
  "Value": 2.45,
  "PixKey": "17699384008",
  "RateValue": 12.5,
  "RateValueType": 1,
  "Identifier": "PurchaseTest1106new4",
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ]
}

Response

Successboolean

Messagestring

DocumentNumberinteger

Urlstring

Example response

{
  "Message": "Solicitação para pagamento Pix recebida com sucesso"
}