Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Generation

Internal Transfer

This method can be used to generate a Internal Transfer

post/InternalTransfer

Request body

Methodstring required

Method name

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

FromTaxNumberstring required

CPF/CNPJ

FromBankstring

Bank code

FromBankBranchstring

Bank branch

FromBankAccountstring

Bank account

FromBankAccountDigitstring

Bank account digit

ToTaxNumberstring required

CPF/CNPJ

ToBankstring

Bank code

ToBankBranchstring

Bank branch

ToBankAccountstring

Bank account

ToBankAccountDigitstring

Bank account digit

Valuenumber required

Value Of The Transaction without Rates

RateValuenumber

Rate value

RateValueTypeinteger

Rate type

CashbackValuenumber

Cashback Value

TransferDatestring required

Transfer date

Identifierstring required

Identifier Of The Transaction

Tagsstring[]

Tags

Descriptionstring

Description

FeePayerTaxNumberstring

CPF/CNPJ

FeePayerFullNamestring

Fee payern name

FeePayerMailstring

Fee payer mail

FeePayerIdentyDocumentstring

Fee payer identy document

FeePayerTradingNamestring

Fee payer trading name

FeePayerLegalNamestring

Fee payer legal name

FeePayerPhonestring

Fee payer phone

FeePayerBankstring

Fee payer bank

FeePayerBankBranchstring

Fee payer bank branch

FeePayerBankAccountstring

Fee payer bank account

FeePayerBankAccountDigitstring

Fee payer bank account digit

Categorystring

Transfer = 0, PaymentBetweenAccounts = 1

Example request

{
  "Method": "InternalTransfer",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "FromTaxNumber": "596.260.238-21",
  "FromBank": "001",
  "FromBankBranch": "0801",
  "FromBankAccount": "0178945",
  "FromBankAccountDigit": "5",
  "ToTaxNumber": "548.611.276-66",
  "ToBank": "001",
  "ToBankBranch": "0801",
  "ToBankAccount": "157567",
  "ToBankAccountDigit": "5",
  "Value": 2.45,
  "RateValue": 12.5,
  "RateValueType": 1,
  "CashbackValue": 44.4,
  "TransferDate": "2022-05-21",
  "Identifier": "PurchaseTest1106new4",
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ],
  "Description": "This is a new internal transfer",
  "FeePayerTaxNumber": "086.329.321-21",
  "FeePayerFullName": "Maria Isolda Sales",
  "FeePayerMail": "maria@gmail.com",
  "FeePayerIdentyDocument": "111.222.333-44",
  "FeePayerTradingName": "Maria Izolda",
  "FeePayerLegalName": "Maria Izolda da Silva",
  "FeePayerPhone": "5585996071655",
  "FeePayerBank": "123",
  "FeePayerBankBranch": "001",
  "FeePayerBankAccount": "012345",
  "FeePayerBankAccountDigit": "1",
  "Category": "0"
}

Response

OK

Successboolean

True or False

DocumentNumberinteger

Transaction id

Messagestring

Returned message

AlreadyExistsstring

Already exists

Urlstring

URL internal transfer identifier

Example response

{
  "Success": true,
  "DocumentNumber": 656,
  "Message": "Purchase generated successfully",
  "AlreadyExists": "Already exists",
  "Url": "URL"
}