API

Introducción

La siguiente imagen muestra de forma gráfica el flujo de llamadas que se llevan a cabo para la asignación de un crédito.

En primer lugar, el comercio envía la petición de crédito a Instant Credit. En este punto, el usuario inicia el proceso de crédito. Cuando finalice la transacción, Instant Credit confirmará al comercio si ha terminado de forma satisfactoria o no.

Signature

Descripción

El uso del campo signature garantiza la integridad de los datos, ya que consiste en un cifrado del cuerpo de la notificación JSON que se envía a Instant Credit. Este mecanismo es útil para evitar un ataque de tipo man-in-the-middle, para así garantizar que los datos recibidos no han sido alterados.

Algoritmo

Para conseguir este objetivo, los datos se cifran usando el algoritmo SHA-256. El SHA-256 convierte una cadena de entrada (los datos que queremos transmitir) en una cadena donde los datos han sido ocultados mediante operaciones matemáticas. Para garantizar la integridad de los datos, el servidor de destino debe comprobar que la signature recibida es idéntica a la generada usando la misma llave (secret key) y cadena de entrada. Esta cadena de entrada se forma concatenando a la llave el string que contiene el cuerpo de la notificación que se va a encriptar.

Código de ejemplo

Imaginemos que queremos transmitir la siguiente información:

{
"amount":"400",
"currency":"EUR",
"country":"ES"
}

Cuerpo del mensaje:

{
"amount":"400",
"currency":"EUR",
"country":"ES"
}
Llave: a09fd33m19rtf
Cadena de entrada: a09fd33m19rtf{"amount":"400","currency":"EUR","country":"ES"}
Tras ejecutar el algoritmo a la entrada anterior, obtenemos la siguiente cadena:
77da5ac0df3cfd7692a1c1646c36e2de08cc74afa700e2f277e5e430f5cd2545

Por lo tanto, cuando el servidor recibe los datos, genera la signature usando la misma llave y cuerpo de la notificación y, comprueba si coincide con la enviada. Si son idénticas, los datos no han sido manipulados y es seguro procesarlos.

Access token request

Este método devolverá el accessToken, refreshToken, scopes permitidos y el tiempo que durará el accessToken.

https://test.instantcredit.net/api/oauth/token

Content-Type: application/json

"clientId":"324",
"userName":"MERCHANT_USERNAME",
"password":"MERCHANT_PASSWORD",
"grantType":"password",
"scope":"credit_request"
}

Content-Type: application/json

{
"accessToken":"86fmxj44rka1j4if",
"refreshToken":"23kl09a1hbcnr55js783s",
"expiresIn":3600,
"scope":"credit_request"
}

Credit/request

Mediante este método, el comercio inicia el proceso de creación de un nuevo crédito.

https://test.instantcredit.net/api/credit/request

Content-Type: application/json
Authorization: Bearer [accessToken]
Signature: [signature]

{  
   "orderId":"",
   "custom":"",
   "amount":"240.10",
   "currency":"EUR",
   "country":"ES",
   "successURL":"",
   "failURL":"",
   "notificationURL":"",
   "whiteList":"YES",
   "blackList":"YES",
   "endUser":{  
      "endUserId":"",
      "ip":"",
      "firstName":"John Doe",
      "lastName":"Doe",
      "personalId":"12345678Z",
      "email":"john@doe.com",
      "birthDate":"1970-01-01",
      "mobile":"674883322",
      "alternativePhoneNumber":"964337891",
      "employmentStatus":"EMPLOYED",
      "address":{  
         "street":"Passeig de Gracia",
         "postalCode":"08008",
         "province":8,
         "city":"Barcelona",
         "country":"ES"
      },
      "registrationDate":"1970-01-01",
      "historicOrders":[  
         {  
            "status":"FRAUD",
            "date":"1970-01-01 23:23:23",
            "amount":"240.10",
            "currency":"EUR",
            "country":"FR"
         }
      ]
   }
}

Content-Type: application/json
Authorization: Bearer [accessToken]
Signature: [signature]

{  
   "url":"",
   "result":"OK",
   "transactionId":123,
   "orderId":"",
   "resultType":"SUCCESSFUL",
   "resultDescription":"Credit request correctly received."
}

Refund/request

Mediante este método, el comercio inicia el proceso de creación de devolución.

https://test.instantcredit.net/api/refund/request

Content-Type: application/json
Signature: [signature]

{  
   "orderId":"124",
   "refundId":"15",
   "amount":"240.10",
   "currency":"EUR",
   "country":"ES"
}

Content-Type:application/json
Signature: [signature]

{  
   "orderId":"124",
   "refundId":"15",
   "result":"OK",
   "resultType":"SUCCESSFUL",
   "resultDescription":"Refund Request Successfully Created."
}

Credit/confirmation

Esta llamada se utilizará para confirmar si la transacción ha finalizado correctamente o ha fallado.

https://test.instantcredit.net/api/credit/confirmation

Content-Type: application/json
Signature: [signature]

{  
   "transactionId":"",
   "orderId":"28",
   "amount":"240.10",
   "currency":"EUR",
   "country":"ES",
   "result":"OK",
   "resultType":"SUCCESSFUL",
   "resultDescription":"Credit created and successfully assigned"
}

Content-Type: application/json
Signature: [signature]

{  
   "transactionId":123,
   "orderId":"28",
   "result":"OK",
   "resultType":"SUCCESSFUL",
   "resultDescription":"Acknowledgement"
}

Refund/confirmation

Esta llamada se utilizará para confirmar si la devolución ha finalizado correctamente o ha fallado.

https://test.instantcredit.net/api/refund/confirmation

Content-Type: application/json
Authorization: Bearer [accessToken]
Signature: [signature]

{  
   "orderId":"124",
   "refundId":"15",
   "amount":"240.10",
   "currency":"EUR",
   "country":"ES",
   "result":"OK",
   "resultType":"SUCCESSFUL",
   "resultDescription":"Refund successfully confirmed."
}

Content-Type: application/json
Authorization: Bearer [accessToken]
Signature: [signature]

{  
   "url":"",
   "result":"OK",
   "transactionId":123,
   "orderId":"",
   "resultType":"SUCCESSFUL",
   "resultDescription":"Credit request correctly received."
}