Skip to content

Guía pago recurrente API Doc

rlop03 edited this page Sep 7, 2015 · 15 revisions

Guía pago recurrente API Doc

Versión 1.5 Marzo 2015

1. Introducción

Esta guía provee una explicación técnica del proceso de petición a la API de pago recurrente de MYMOID. Para empezar a utilizar esta guía, el comercio debe estar ya registrado en MYMOID y haber recibido toda la información de identificación necesaria, incluyendo su ID de comercio, ID de aplicación y Password de aplicación (APPSECRET).

2. Implementación

Creación de una nueva orden de pago basada en el id de una orden previamente pagada

Para implementar este servicio necesitará crear una nueva orden de pago basada en un pago ya realizado. Debe ser una operación realizada, ya que MYMOID debe corroborar que el usuario aceptó realizar el pago y la tarjeta de crédito usada fue admitida.

Endpoint

protocolo://server/pay/order/reissue/{orderid}

Ejemplo: https://api.mymoid.com/pay/order/reissue/350596aad1363b1dbbaf4ad7a38ed4d6075bb9497984b92f07ec8e4e55d6b0af

Llamada

  • Verbo: POST
  • URL: [ENDPOINT]
  • Entrada: OrderReissue
  • Salida: PaymentOrderOutDTO

Este método tomara las especificaciones para la orden de pago de los argumentos enviados en la llamada. El servidor se encargara de pedir las consideraciones de seguridad necesarias a la plataforma y realizará una nueva orden de pago. Cuando ese proceso haya finalizado, se intentará pagar la orden con la misma configuración que la orden de pago inicial. Al no conocer el comercio el id de la nueva orden de pago que se generará, es necesario que este id aparezca en la respuesta de la petición. En caso de que el reissue se haya realizado correctamente, el paymentOrderId de la nueva orden de pago y su estado aparecerán en el apartado “data” de la respuesta json de la petición. Si por el contrario se hubiera producido un error al realizar la operación, estarán en el subapartado params del atributo data de la respuesta.

A continuación se muestra una ejemplo de respuesta de la petición para ambos casos:

Ejemplo de respuesta para un pago recurrente correcto:

{
 "status": true,
 "code": 0,
 "data": {
    "paymentOrderId":"cb89e6ee5d161255aba3f22c507b08b3ed10169c576913b768fe6a78de09e7f1",         
    "shortCode": "2N11L2",
    "currencyCode": "EUR",
    "amount": 4990,
    "merchantId":"bacfeb8f01a06f93d76a7d82b6c39c17a7830001b91e22098bae2ff4b226d072",
    "reference": "sw-xl-0231842",
    "concept": "Camiseta Star-Wars XL",
    "status": "PAID",
    "currentStatus": {},
    "expirationCard": "12/15",
    "pan": "xxxxxxxxxxxx0003"
  }
 }

Ejemplo de respuesta para un pago recurrente erróneo:

{
 "status": false,
 "code": 200,
 "data": [
  {
   "message": "Generic gateway error",
   "code": "Validator.mymoPay.genericGatewayError",
   "params": {
        "status": "AVAILABLE",
        "paymentOrderId": "843c36fb950479bc01e0b2bdb1caba3a6225213a20ec1f523029c1f5b37fb191"
    }
   }
  ]
 }