PIX new account validation service

POST https://api.payretailers.com/payments/v2/services/customer-account/validate

To verify that the consumer has submitted a CPF associated with the Pix Key or bank account they have registered, merchants can use our new account validation service. This service checks the CPF against the Pix Key or bank account details the consumer enters and provides a True/False outcome.

Validations can either be Basic (data-only request) or can use a Micro-Deposit to validate the customer account and CPF.

The Integrations Specifications to the right identify the flow for MicroDeposit validation (a data-only request).

Microdeposit Validation against PIX Key

{  
 "validationType": "Deposit",  
 "notificationUrl":   "<https://example.com/">,  
 "depositReason": "Registered account validation",  
 "countryCode": "BR",  
 "pixKey": "12345678901",  
 "pixKeyType": "CPF",  
 "personalId": "123.456.789-01"  
}

Microdeposit Validation against bank account data

{  
 "validationType": "Deposit",  
 "notificationUrl": "<https://example.com/">,  
 "depositReason": "Registered account validation",  
 "countryCode": "BR",  
 "personalId": "12345678901",  
 "name": "Juan Perez",  
 "bankCode": "001",  
 "agency": "1234",  
 "account": "56789-1",  
 "accountType": "0001"  
}

Deposit Validation Response (OK - 200)

{
    "validationId": "550e8400-e29b-41d4-a716-446655440000",
    "validationStatus": "Succeeded",
    "errors": []
}

Deposit Validation Notification (Succeeded)

{
    "validationId": "123e4567-e89b-12d3-a456-426614174000",
    "validationStatus": "Succeeded",
    "errors": [],
    "data": {
        "name": "Juan Perez",
        "bankCode": "001",
        "agency": "1234",
        "account": "56789-1",
        "accountType": "0001",
        "personType": "person",
        "isUnderAge": false
    }
}

Deposit Validation Notification (Failed)

{
    "validationId": "123e4567-e89b-12d3-a456-426614174000",
    "validationStatus": "Failed",
    "errors": [
        {
            "message": "The Pix key is invalid.",
            "errorCode": "INVALID_PIX_KEY_DATA"
        }
    ]
}