Enrollment V2 - Callback API

Visão Geral

Esta API permite a confirmação de aprovação do consentimento de enrollment na detentora, então seu status passa a ser AWAITING_ENROLLMENT.

Endpoint

POST /open-keys/itp/api/v2/payment-initiation/callback

Estrutura da Requisição

Payload Completo

{
    "code": "{{callback_code}}",
    "id_token": "{{callback_id_token}}",
    "state": "{{callback_state}}"
}

Campos da Requisição

Nível Raiz

Campo	Tipo	Obrigatório	Descrição
`code`	String	Sim	`code` retornado na aprovação do consentimento
`id_token`	String	Sim	`id_token` retornado na aprovação do consentimento
`state`	String	Sim	`state` retornado na aprovação do consentimento

Exemplo de Requisição (cURL)

curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/payment-initiation/callback' \
--header 'Content-Type: application/json' \
--data '{
    "code": "{{callback_code}}",
    "id_token": "{{callback_id_token}}",
    "state": "{{callback_state}}"
}'

Resposta da API

Sucesso (200 OK)

A API retorna um objeto contendo:

{
    "id": "{itp_enrollment_id}",
    "paymentInitiationApi": "ENROLLMENTS_V2",
    "ofEnrollment": {
        "status": "AWAITING_ENROLLMENT",
        "consentId": "...",
        "enrollmentId": "...",
        "permissions": ["PAYMENTS_INITIATE"]
    },
    "..."
}

Erros Comuns

422 Unprocessable Entity

{
    "name": "ValidationError",
    "message": "Parameters validation error!",
    "code": 422,
    "type": "VALIDATION_ERROR",
    "data": [
        {
            "type": "required",
            "message": "The 'state' field is required.",
            "field": "state",
            "action": "v2.open-keys.itp.payment-initiation.ofCallback"
        }
    ]
}

Causas comuns:

Campos obrigatórios ausentes

404 Not Found

{
    "name": "EntityNotFoundError",
    "message": "Entity not found",
    "code": 404,
    "type": null,
    "data": {
        "id": "sass"
    }
}

Solução: Verifique se o state informado está correto.