Deposits with Installments

Learn how to create credit card deposits with Installments.

We allow deposits with Installments in all our credit card deposit flows, those being:

• via PCI Deposit Creation Endpoint (PCI AOC required)

• via Deposit Creation Endpoint (no need for PCI AOC)

Please check-in with your Account Manager or Sales contact for the corresponding configuration and eligibility of this functionality.

Summary

Endpoint	PCI Deposit Creation	Deposit Creation
URL	https://cc-api-stg.directa24.com/v3/deposits	https://api-stg.directa24.com/v3/deposits
Parameter	installments	allow_installments
Parameter format	Integer. Default value: 1	Boolean. Default value: false

via PCI Deposit Creation Endpoint

To create a deposit with installments through our PCI Endpoint, the parameter installments should be sent in the request with a valid amount of installments.

The deposit will be synchronously processed, and charged with installments to the cardholder with the amount detailed in the installments parameter.

Example request

{
    "invoice_id": "800000001",
    "amount": 1000,
    "country": "BR",
    "currency": "BRL",
    "payer": {
        "id": "11111",
        "document": "84932568207",
        "document_type": "CPF",
        "email": "[e-mail]",
        "first_name": "John",
        "last_name": "Smith",
        "phone": "[phone]",
        "birth_date": "19880910",
        "address": {
            "street": "Calle 13",
            "city": "bahia",
            "state": "SP",
            "zip_code": "12345-678"
        }
    },
    "credit_card": {
        "cvv": "123",
        "card_number": "4111111111111111",
        "expiration_month": "10",
        "expiration_year": "25",
        "holder_name": "JOHN SMITH"
    },
    "installments": 6,
    "description": "Test transaction",
    "client_ip": "123.123.123.123",
    "device_id": "knakvuejffkiebyab"
}

via Deposit Creation Endpoint (non PCI)

Within this API, the flow differs slightly as the Merchant is not supposed to handle credit card information.

In this integration, the user will select the desired amount of installments on our PCI Complaint checkout while the Merchant has full control over which deposit is eligible to be paid with installments and which isn't 😉.

Example request

Please note that we only support deposits with installments for Credit Card transactions. Therefore allow_installments with value true will only be effective if the parameter is sent along a payment_method code with type CREDIT_CARD. For example: VI (Visa) or MC (Mastercard).

{
    "invoice_id" : "1000000001",
    "amount": "1000",
    "country": "BR",
    "currency": "BRL",
    "payment_method": "VI",
    "allow_installments": true,
    "payer": {
        "id": "11",
        "document": "84932568207",
        "first_name": "Ricardo",
        "last_name": "Carlos",
        "email": "[e-mail]",
        "phone": "[phone]",
        "address": {
            "street": "Rua 13",
            "city": "bahia",
            "state": "SP",
            "zip_code": "12345-678"
        }
    },
    "description": "Example Deposit",
    "client_ip": "123.123.123.123",
    "device_id": "00000000-00000000-01234567-89ABCDEF",
    "back_url": "https://www.d24.com/deposit_cancelled",
    "success_url": "https://www.d24.com/deposit_completed",
    "error_url": "https://www.d24.com/deposit_error",
    "notification_url": "https://www.d24.com/d24/notify",
    "logo": "https://www.d24.com/assets/logo-64f1792d.svg",
    "language": "pt"
}

Flow

1. Create a Deposit request sending: - allow_installments with value true . - payment_method with the code of a credit card payment method.

2. Use the redirect_url received in the response to redirect the user to our PCI Compliant checkout.

3. Once the user fills in their Credit Card details they will be capable of selecting the amount of installments desired.

4. The user proceeds to pay and is capable of visualising the transaction details 🚀

Please note that the D24 logo is displayed as an example and you should use your own logo in the checkouts.