Api de Actualización de Afiliación

El API de Actualización de Afiliación permite actualizar una afiliación.

REQUEST

Path

Method: PUT

URL: {{base}}/recurring/affiliations/{{merchant_code}}/{{merchant_affiliation_code}}

Campo	Descripcion	Obligatorio
`merchant_code`	Código del comercio	SI
`merchant_affiliation_code`	Código de afiliación generado por el comercio	SI

Headers

Se enviará los siguientes parámetros en la cabecera de la petición:

Campo	Descripcion	Valor Aceptado	Tipo
`Authorization`	Token de identificación para uso del API creado previamente en API de Seguridad	Cadena alfanumérica	`String`

Body

Tener en cuenta la API tiene la siguiente restricción. Si se solicita actualizar el state, no se debe enviar el resto de campos.

Campo	Descripcion	Valor Aceptado	Tipo	Obligatorio
`state`	Estado de la afiliación	ACTIVE INACTIVE	`String`	NO* *Obligatorio solo cuando no se envía el objeto `card`
`card`	Objeto que contiene información detallada relacionada a la tarjeta		`Object`	NO* *Obligatorio solo cuando no se envía el campo `state`
`card.token`	Token de la tarjeta	Cadela alfanumérica	`String`	NO
`card.brand`	Marca de la tarjeta usada en la transacción	VISA MSCD AMEX DINC	`String`	NO
`card.bin`	Bin de la tarjeta usada	Cadena numérica	`String`	NO
`card.last_pan`	Ultimos 4 dígitos de la tarjeta	Cadena numérica	`String`	NO
`card.issuer`	Banco emisor de la tarjeta	Cadena alfanumérica	`String`	NO
`card.card_holder_name`	Nombre del tarjehabiente	Cadena alfanumérica	`String`	NO

Escenario 1

Cambiar el estado de la afiliación

JSON

{
    "state": "INACTIVE"
}

Escenario 2

Cambiar los datos del token de la afiliación

JSON

{
    "card": {
        "token": "1521abbb7f78482e84b451077e3e76fb-2240",
        "brand": "VISA",
        "bin": "411111",
        "last_pan": "1111",
        "issuer_name": "BCP",
        "card_holder_name": "Pedro Suarez"
    }
}

RESPONSE

El orquestador responderá información detallada de la afiliación:

Campo	Descripción	Valor Aceptado	Tipo	Obligatorio
`success`	Indica si el proceso se realizó correctamente	Cadena Alfanumérica: true false	`String`	SI
`affiliation`	Objeto que contiene el detalle de la afiliación		`Object`	SI
`affiliation.affiliation_id`	Identificador de afiliación	Cadena alfanumérica	`String`	SI
`affiliation.merchant_affiliation_code`	Número de afiliación enviado por el comercio	Cadena alfanumérica	`String`	SI
`affiliation.merchant_code`	Identificador del comercio	Cadena Alfanumérica	`String`	SI
`affiliation.type`	Tipo de afiliación	MANUAL FIXED VARIABLE	`String`	SI
`affiliation.frecuency`	Frecuencia de afiliación	MONTHLY ANNUAL	`String`	NO
`affiliation.amount`	Monto de afiliación	Cadena Numérica	`String`	NO
`affiliation.max_amount`	Monto máximo de afiliación	Cadena Numérica	`String`	NO
`affiliation.currency`	Código de la moneda de la afiliación en ISO 4217	Cadena Numérica	`String`	SI
`affiliation.state`	Estado actual de la afiliación	ACTIVE INACTIVE	`String`	SI
`affiliation.beneficiary`	Objeto con información del afiliado			SI
`affiliation.beneficiary.first_name`	Nombres	Cadena alfanumérica	`String`	SI
`affiliation.beneficiary.last_name`	Apellidos	Cadena alfanumérica	`String`	SI
`affiliation.beneficiary.email`	Correo electrónico	Cadena alfanumérica	`String`	SI
`affiliation.beneficiary.phone`	Objeto con información del teléfono		`Object`	NO
`affiliation.beneficiary.phone.country_code`	Código del pais del teléfono	Cadena numérica	`String`	NO
`affiliation.beneficiary.phone.subscriber`	Número del teléfono	Cadena numérica	`String`	NO
`affiliation.beneficiary.identity_document`	Objeto con información de identidad		`Object`	NO
`affiliation.beneficiary.identity_document.type`	Tipo de identidad	Cadena numérica	`String`	NO
`affiliation.beneficiary.identity_document.identifier`	Número de identidad	Cadena alfanumérica	`String`	NO
`affiliation.beneficiary.identity_document.country`	Pais	Cadena alfanumérica Código del País en 2 letras ISO-3166	`String`	NO
`affiliation.beneficiary.location`	Objeto con información de la ubicación		`Object`	SI
`affiliation.beneficiary.location.line_1`	Dirección 1	Cadena alfanumérica	`String`	SI
`affiliation.beneficiary.location.line_2`	Dirección 2	Cadena alfanumérica	`String`	NO
`affiliation.beneficiary.location.city`	Ciudad	Cadena alfanumérica	`String`	SI
`affiliation.beneficiary.location.state`	Estado	Cadena alfanumérica	`String`	SI
`affiliation.beneficiary.location.country`	Pais	Cadena alfanumérica Código del País en 2 letras ISO-3166	`String`	SI
`affiliation.additional_fields`	Diccionario para enviar campos y valores personalizados como `key:value` Ej.: external_id:21871054	`key:value`	`Dictionary`	NO
`affiliation.card`	Objeto que contiene información detallada relacionada a la tarjeta		`Object`	SI
`affiliation.card.token`	Token de la tarjeta	Cadela alfanumérica	`String`	SI
`affiliation.card.brand`	Marca de la tarjeta usada en la transacción	Cadena alfabética	`String`	SI
`affiliation.card.bin`	Bin de la tarjeta usada	Cadena numérica	`String`	SI
`affiliation.card.last_pan`	Ultimos 4 dígitos de la tarjeta	Cadena numérica	`String`	SI
`affiliation.card.issuer`	Banco emisor de la tarjeta	Cadena alfanumérica	`String`	SI
`affiliation.card.card_holder_name`	Nombre del tarjehabiente	Cadena alfanumérica	`String`	SI
`meta`	Objeto que contiene metadados del flujo ejecutado		`Object`	SI
`meta.status`	Objeto que contiene el resultado del flujo ejecutado		`Object`	SI
`meta.status.code`	Código que representa el resultado del flujo ejecutado	Cadena numérica	`String`	SI
`meta.status.message_ilgn`	Objeto que contiene el mensaje resultante del flujo		`Object`	SI
`meta.status.message_ilgn.[].locale`	Localidad a nivel de lenguaje para el mensaje del flujo ejecutado	Cadena alfanumérica	`String`	SI
`meta.status.message_ilgn.[].value`	Mensaje resultante del flujo ejecutado	Cadena alfanumérica	`String`	SI

JSON

{
    "success": "true",
    "affiliation": {
        "affiliation_id": "01871a64-95c7-4e1d-80fb-8ed165dd5677",
        "merchant_affiliation_code": "123456",
        "merchant_code": "b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
        "type": "MANUAL",
        "frequency": null,
        "amount": null,
        "max_amount": null,
        "currency": "604",
        "state": "ACTIVE",
        "beneficiary": {
            "first_name": "Producto",
            "last_name": "Alignet",
            "email": "producto@alignet.com",
            "phone": {
                "country_code": "51",
                "subscriber": "999999999"
            },
            "identity_document": {
                "type": "DNI",
                "identifier": "77777777",
                "country": "PE"
            },
            "location": {
                "line_1": "Av. Casimiro Ulloa 333",
                "line_2": null,
                "city": "Lima",
                "state": "Lima",
                "country": "PE"
            }
        },
        "additional_fields": {
            "key1": "value1",
            "key2": "value2"
        },
        "card": {
            "token": "4521abbb7f78482e84b451077e3e76fb-2240",
            "brand": "VISA",
            "bin": "411111",
            "last_pan": "1111",
            "issuer_name": "BCP",
            "card_holder_name": "Producto Alignet"
        }
    },
    "meta": {
        "status": {
            "code": "00",
            "message_ilgn": [
                {
                    "locale": "es_PE",
                    "value": "Se procesó correctamente la petición"
                }
            ]
        }
    }
}