The joint payment functionality allows multiple payers to be included in a single payment request, making it easier to divide expenses among multiple people.

With this feature, you can specify the payers and the corresponding amounts each will contribute, generating a single, consolidated payment.

Additionally, the solution ensures a clear and transparent distribution of the amounts owed by each payer, preventing confusion and eliminating the need for multiple individual transactions.

This approach not only saves time but also reduces the risk of errors, making it easier to reconcile payments between all parties involved.

🚧

Version 1

Feature available from: October 2024

This documentation is under construction and may be subject to change.

How It Works

API Method = GeneratePaymentOrder

This method allows you to send joint payment orders. When the data is received from the customer, our API verifies that the payers have sufficient balance to proceed with the transaction. It then creates a beneficiary, who undergoes a Pix key match verification, followed by a KYC (Know Your Customer) process, and finally processes the transaction for the chosen beneficiary.

{
    "Method": "GeneratePaymentOrder",
    "PartnerId": 425,
    "BusinessUnitId": 10950,
    "Value": 10.00,
    "Type": 1, 
    "Identifier": "{{$guid}}",
    "PaymentDate": "2024-08-15",
    "Payer": {
        "AccountKey": "",
        "TaxNumber": "052.134.123-00",
        "Bank": "450",
        "BankBranch": "0001",
        "BankAccount": "218538",
        "BankAccountDigit": "2",
        "JointValue": 5
    },
    "Beneficiary": {
        "Name": "Paulo Joaquim Veras",
        "MotherName": "Ana Alencar Veras",
        "Ocuppation": "QA",
        "Nationality": "Brazileiro",
        "BirthCity": "Crateús",
        "BirthState": "Ceará",
        "Country": "Brazil",
        "CompanyActivity": "Payments",
        "ContactInfo": {
            "Mail": "[email protected]",
            "Phone": "(88) 99437-0450"
        },
        "AccountInfo": {
            "Key": "",
            "PixKey": "87.233.401/0001-70",
            "AccountType": "1", 
            "TaxNumber": "87.233.401/0001-70",
            "Bank": "450",
            "BankBranch": "0001",
            "BankAccount": "1123705",
            "BankAccountDigit": "0"
        }
    },
    "Tags": [
        "Payment Order",
        "Vitor Ted Interno"
    ],
    "JointPayment": [
      {
        "JointValue": 5.00,
        "Bank": "450",
        "BankBranch": "0001",
        "BankAccount": "22751639",
        "BankAccountDigit": "8",
        "TaxNumber": "619.531.270-37"
        }
    ]
}

Description:

Important:

• To avoid errors and issues with the operation, the PaymentDate field must follow the specified format:
  • For Pix with bank details, the PaymentDate field should be formatted as: 2024-02-16T15:00:00
  • For Pix key, the PaymentDate field should be formatted as: 2024-02-16
• Type: The joint payment will be processed via Pix.
• The ToBankIdentifier field is optional. However, if a Payment Order is made using bank details, this field becomes mandatory.

Important Information on Joint Payment:

• The sum of the JointValue amounts must exactly match the value specified in Value.
• The requisition may contain more than one joint payment.

📘

Explanation

NP = Natural Person

LP = Legal Person

Identified Beneficiary = Is the initial step, and will meet most cases, without the need for additional information (is the beneficiary who only needs the information required to settle payment orders)

Qualified Beneficiary = Qualification is a more in-depth step that demands more information about the beneficiary. This step will only be required when, after sending the initial request, the system returns a EXC0033 error. In this situation, a new request must be sent, with the mandatory data for the qualification process (beneficiary who needs to present information previously considered optional for KYC validation)

Pix Key Pattern

By Real Time Payments (Pix)

There are two ways to process the Payment Order by Real Time Payment (Pix) in a quick and efficient way:

Payment Request by Pix Key

When sending the Payment Order, the customer needs to inform only the beneficiary's Pix key and TaxNumber (CPF or CNPJ), which can be the CPF/CNPJ number, e-mail, telephone or a random key generated by Brazil's Central Bank (Banco Central). With this data, our API proceeds to verify the correspondence between the Pix key and the payee, then performs the beneficiary's KYC process and concludes the transfer.

Payment Request by Pix with bank informations

When sending the Payment Order, if the beneficiary does not have a Pix key, the customer must inform the beneficiary's bank details and CPF or CNPJ. Having this data, our API verifies if the informed banking data corresponds to one of the institutions that operates with Pix and, if so, proceeds with the transfer.