diff --git a/src/pages/en/gateway/api-reference/3ds.mdx b/src/pages/en/gateway/api-reference/3ds.mdx deleted file mode 100644 index 367370d..0000000 --- a/src/pages/en/gateway/api-reference/3ds.mdx +++ /dev/null @@ -1,94 +0,0 @@ -export const apiRefs = ['/gateway/mpi/lookup', '/gateway/mpi/query'] - -## 3DS Lookup {{ id: 'mpi-lookup-request', tag: 'POST', label: '/gateway/mpi/lookup' }} - - - - Performs the initial 3DS validation process, returning the data so that the user can continue with the process - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/mpi/lookup \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Testing Payment", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - } - }, - "returnUrl": "https://www.your-site.com/return?reference=1234567890" - }' - ``` - - - - ---- - -## 3DS Query {{ id: 'mpi-query-request', tag: 'POST', label: '/gateway/mpi/query' }} - - - - Once the user has completed the authentication process in 3DS, this endpoint is used to obtain the result of their operation - - > ### Important Note - > - > *When consuming this service **NOT** the transaction is being authenticated by default, the value of `data` must be taken from the response and sent in the `instrument.threeDS`* - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/mpi/query \ - -H "Content-Type: application/json" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - } - }, - "id": "1" - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/en/gateway/api-reference/information.mdx b/src/pages/en/gateway/api-reference/information.mdx deleted file mode 100644 index 8528dc8..0000000 --- a/src/pages/en/gateway/api-reference/information.mdx +++ /dev/null @@ -1,108 +0,0 @@ -export const apiRefs = ['/gateway/information', '/gateway/interests'] - -## Information request {{ id: 'information-request', tag: 'POST', label: '/gateway/information' }} - - - - This service provides information about the user's card that is going to be processed, such as what services will be used for it and the types of credit, if applicable, that are available for it. If there are no types of credit, an arrangement is returned. empty and if there are, each type of credit must be iterated with the installments found in the arrangement. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Test", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - }, - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Interest Calculation (Ecuador only) {{ id: 'interests-request', tag: 'POST', label: '/gateway/interests' }} - - - - This service should be consumed if the card requires interest to be displayed (displayInterest set to true) and as an example of this way the values ​​are displayed in the redirection service. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/interests \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payer": { - "name": "John", - "email": "john.doe@example.com" - }, - "payment": { - "reference": "1122334455", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - }, - "credit": { - "code": "1", - "type": "02", - "groupCode": "P", - "installment": "24" - } - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/en/gateway/api-reference/otp.mdx b/src/pages/en/gateway/api-reference/otp.mdx deleted file mode 100644 index bbd67f2..0000000 --- a/src/pages/en/gateway/api-reference/otp.mdx +++ /dev/null @@ -1,111 +0,0 @@ -export const apiRefs = ['/gateway/otp/generate', '/gateway/otp/validate'] - -## OTP generation (Ecuador only) {{ id: 'otp-ec-request', tag: 'POST', label: '/gateway/otp/generate' }} - - - - This service is consumed if the OTP is required for the card provided by the client (requireOtp is true) and the user must be allowed to enter the OTP to send it later in the processing service, as an example this is captured in the interface redirection - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/otp/generate \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payer": { - "name": "John", - "email": "john.doe@example.com" - }, - "payment": { - "reference": "1234567890", - "amount": { - "currency": "USD", - "total": "3" - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - } - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## OTP validation (Ecuador only) {{ id: 'otp-validate-ec-request', tag: 'POST', label: '/gateway/otp-validate' }} - - - - It allows you to validate that the OTP provided matches the one sent by the provider and will provide a signature that serves to authenticate the transaction - - > Important Note - > - > It is necessary to send the returned value as `signature` in the response as `instrument.otp` in the processing request so that it is recorded in the transaction - - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/otp-validate \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payer": { - "name": "John", - "email": "john.doe@example.com" - }, - "payment": { - "reference": "1234567890", - "amount": { - "currency": "USD", - "total": "3" - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - }, - "otp": "123456" - }, - }' - ``` - - - diff --git a/src/pages/en/gateway/api-reference/pinpad.mdx b/src/pages/en/gateway/api-reference/pinpad.mdx deleted file mode 100644 index 3c94532..0000000 --- a/src/pages/en/gateway/api-reference/pinpad.mdx +++ /dev/null @@ -1,81 +0,0 @@ -export const apiRefs = ['/security/pinpad/transaction', '/security/pinpad/pinblock'] - -## PinPad request {{ id: 'rest-security-transaction-request', tag: 'POST', label: '/security/pinpad/transaction' }} - - - - A PINPAD is an electronic device used in a debit, credit, or smart card transaction to accept and encrypt the cardholder's personal identification number (PIN). - - This API provides a PinPad service with encrypted PinBlock generation according to ISO 9564. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/security/pinpad/transaction \ - -H "Content-Type: application/json" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "card": { - "number": "4110760000000008" - } - } - }' - ``` - - - - ---- - -## Generation of PinBlock from PinPad {{ id: 'rest-security-pinblock-request', tag: 'POST', label: '/security/pinpad/pinblock' }} - - - - Allows you to generate the PinBlock with a transaction based on the positions provided by the user that were selected from the PinPad - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/security/pinpad/pinblock \ - -H "Content-Type: application/json" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "card": { - "number": "4110760000000008" - }, - "pinPad": { - "transactionId": "b0c62f97-3b06-4c33-b68f-e281e95eb4bb", - "positions": "0123" - } - } - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/en/gateway/api-reference/report.mdx b/src/pages/en/gateway/api-reference/report.mdx deleted file mode 100644 index dbf0bc7..0000000 --- a/src/pages/en/gateway/api-reference/report.mdx +++ /dev/null @@ -1,77 +0,0 @@ -export const apiRefs = ['/gateway/report', '/gateway/report/obtain'] - -## Request a report {{ id: 'report-request', tag: 'POST', label: '/gateway/report' }} - - - - Allows you to request that a transaction report be generated and returns an identifier for the process, which once the callback is called can be obtained at the following endpoint - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/report \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "filters": { - "startDate": "2023-06-07 14:59:34", - "endDate": "2023-06-08 14:59:34", - "state": [ - "APPROVED", - "REJECTED" - ] - }, - "callbackUrl": "https://dnetix.co/ping/report" - }' - ``` - - - - ---- - -## Obtain a previously requested report {{ id: 'report-obtain-request', tag: 'POST', label: '/gateway/report/obtain' }} - - - - Allows you to obtain a previously generated report. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/report/obtain \ - -H "Content-Type: application/json" \ - -H "Accept-Encoding: gzip" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "id": 0 - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/en/gateway/api-reference/tokenize.mdx b/src/pages/en/gateway/api-reference/tokenize.mdx deleted file mode 100644 index 60df595..0000000 --- a/src/pages/en/gateway/api-reference/tokenize.mdx +++ /dev/null @@ -1,92 +0,0 @@ -export const apiRefs = ['/gateway/tokenize', '/invalidate'] - -## Tokenization (tokenize) {{ id: 'tokenize-request', tag: 'POST', label: '/gateway/tokenize' }} - - - - This service allows you to store a payment instrument such as: credit cards or bank account safely, through a request that contains its information, a token will be generated that can be used in the processing service and for all Indeed, in PlacetoPay it is equivalent to a credit card or bank account, the difference is that the token structure is sent instead of card or account. - - > Prior to consuming this service, the information must be consulted to know whether or not it is necessary to generate an OTP for the client and, if necessary, request the token from the person and send it during consumption. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/tokenize \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Test", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123", - "installments": "2" - }, - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Tokenization (invalidate) {{ id: 'tokenize-invalidate-request', tag: 'POST', label: '/invalidate' }} - - - - This service allows you to invalidate and delete a token associated with a credit card. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/invalidate \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "token": { - "token": "239bd2573205e974c4bed7c99cc1125c464f6350a905565333fff041d8f5ef79" - } - } - }' - ``` - - - diff --git a/src/pages/en/gateway/api-reference/transaction.mdx b/src/pages/en/gateway/api-reference/transaction.mdx deleted file mode 100644 index bde6ae5..0000000 --- a/src/pages/en/gateway/api-reference/transaction.mdx +++ /dev/null @@ -1,161 +0,0 @@ -export const apiRefs = ['/gateway/process', '/gateway/query', '/gateway/search', '/gateway/transaction'] - -## Transaction processing {{ id: 'process-request', tag: 'POST', label: '/gateway/process' }} - - - - This service allows the payment to be made to the user's card, the parameters of the instrument are variables, if type of credit or OTP is not requested, it is not necessary to send these variables, payer is always required, buyer is optional but recommended. - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Test", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123", - "installments": "2" - }, - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Transaction query by internal reference {{ id: 'query-request', tag: 'POST', label: '/gateway/query' }} - - - - Allows you to consult a particular transaction using its internal reference. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/query \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "internalReference": "230364" - }' - ``` - - - - ---- - -## Transaction search {{ id: 'search-request', tag: 'POST', label: '/gateway/search' }} - - - - This service allows the search for transactions by reference and amount, it is usually used in case of loss of communication when creating a transaction to obtain the internal reference again. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/search \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "reference": "TEST_20171108_144400" - "amount": { - "currency": "COP", - "total": "1000" - } - }' - ``` - - - - ---- - -## Operations on a transaction {{ id: 'transaction-request', tag: 'POST', label: '/gateway/transaction' }} - - - - Allows you to perform a reversal, re-authorization, refund or cash out on an existing transaction - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/transaction \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "action": "reverse", - "internalReference": "1505723583", - "authorization": "999999" - }' - ``` - - - diff --git a/src/pages/gateway/api-reference/3ds.mdx b/src/pages/gateway/api-reference/3ds.mdx deleted file mode 100644 index ff5bcd3..0000000 --- a/src/pages/gateway/api-reference/3ds.mdx +++ /dev/null @@ -1,94 +0,0 @@ -export const apiRefs = ['/gateway/mpi/lookup', '/gateway/mpi/query'] - -## 3DS Lookup {{ id: 'mpi-lookup-request', tag: 'POST', label: '/gateway/mpi/lookup' }} - - - - Realiza el proceso inicial de validación de 3DS retornando los datos para que el usuario pueda continuar con el proceso - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/mpi/lookup \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Testing Payment", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - } - }, - "returnUrl": "https://www.your-site.com/return?reference=1234567890" - }' - ``` - - - - ---- - -## 3DS Query {{ id: 'mpi-query-request', tag: 'POST', label: '/gateway/mpi/query' }} - - - - Una vez el usuario ha terminado el proceso de autenticación en 3DS se usa este endpoint para obtener el resultado de su operación - - > ### Nota Importante - > - > *Al consumir este servicio **NO** se está autenticando la transacción por defecto, se debe tomar de la respuesta el valor de `data` y enviarlo en el `instrument.threeDS`* - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/mpi/query \ - -H "Content-Type: application/json" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - } - }, - "id": "1" - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/gateway/api-reference/information.mdx b/src/pages/gateway/api-reference/information.mdx deleted file mode 100644 index d724ad0..0000000 --- a/src/pages/gateway/api-reference/information.mdx +++ /dev/null @@ -1,107 +0,0 @@ -export const apiRefs = ['/gateway/information', '/gateway/interests'] - -## Solicitud de Información {{ id: 'information-request', tag: 'POST', label: '/gateway/information' }} - - - - Este servicio proporciona información sobre la tarjeta del usuario que se va a procesar, tal como qué servicios son los que se usarán para ella y los tipos de crédito, si aplica, que hay para esta, si no hay tipos de crédito se retorna un arreglo vacío y si los hay, se debe iterar cada tipo de crédito con los installments que se encuentran en el arreglo. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Prueba", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - }, - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Cálculo de Intereses (solo Ecuador) {{ id: 'interests-request', tag: 'POST', label: '/gateway/interests' }} - - - - Este servicio se debe consumir si la tarjeta requiere que se muestren los intereses (displayInterest en true) y como ejemplo de esta manera se muestran los valores en el servicio de redirección. - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/interests \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payer": { - "name": "John", - "email": "john.doe@example.com" - }, - "payment": { - "reference": "1122334455", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - }, - "credit": { - "code": "1", - "type": "02", - "groupCode": "P", - "installment": "24" - } - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/gateway/api-reference/otp.mdx b/src/pages/gateway/api-reference/otp.mdx deleted file mode 100644 index abdac44..0000000 --- a/src/pages/gateway/api-reference/otp.mdx +++ /dev/null @@ -1,110 +0,0 @@ -export const apiRefs = ['/gateway/otp/generate', '/gateway/otp/validate'] - -## Generación de OTP (solo Ecuador) {{ id: 'otp-ec-request', tag: 'POST', label: '/gateway/otp/generate' }} - - - - Este servicio se consume si es necesario el otp para la tarjeta provista por el cliente (requireOtp en true) y debe permitirsele al usuario ingresar el OTP para enviarlo posteriormente en el servicio de procesamiento, a manera de ejemplo de esta manera se captura en la interfaz de redirección - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/otp/generate \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payer": { - "name": "John", - "email": "john.doe@example.com" - }, - "payment": { - "reference": "1234567890", - "amount": { - "currency": "USD", - "total": "3" - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - } - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Validación de OTP (solo Ecuador) {{ id: 'otp-validate-ec-request', tag: 'POST', label: '/gateway/otp-validate' }} - - - - Permite validar que el OTP provisto concuerde con el enviado por el proveedor y proporcionará una firma que sirve para autenticar la transacción - - > Nota Importante - > - > Es necesario enviar el valor retornado como `signature` en la respuesta como `instrument.otp` en la petición de procesamiento para que se registre en la transacción - - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/otp-validate \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payer": { - "name": "John", - "email": "john.doe@example.com" - }, - "payment": { - "reference": "1234567890", - "amount": { - "currency": "USD", - "total": "3" - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123" - }, - "otp": "123456" - }, - }' - ``` - - - diff --git a/src/pages/gateway/api-reference/pinpad.mdx b/src/pages/gateway/api-reference/pinpad.mdx deleted file mode 100644 index ad046a0..0000000 --- a/src/pages/gateway/api-reference/pinpad.mdx +++ /dev/null @@ -1,81 +0,0 @@ -export const apiRefs = ['/security/pinpad/transaction', '/security/pinpad/pinblock'] - -## Solicitud de PinPad {{ id: 'rest-security-transaction-request', tag: 'POST', label: '/security/pinpad/transaction' }} - - - - Un PINPAD es un dispositivo electrónico que se utiliza en una transacción de débito, crédito o tarjeta inteligente para aceptar y cifrar el número de identificación personal (PIN) del titular de la tarjeta. - - Esta API proporciona un servicio PinPad con generación de PinBlock cifrada según ISO 9564. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/security/pinpad/transaction \ - -H "Content-Type: application/json" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "card": { - "number": "4110760000000008" - } - } - }' - ``` - - - - ---- - -## Generación de PinBlock a partir de PinPad {{ id: 'rest-security-pinblock-request', tag: 'POST', label: '/security/pinpad/pinblock' }} - - - - Permite generar el pinblock con una transaccion en base a las posiciones entregadas por el usuario que se seleccionaron del PinPad - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/security/pinpad/pinblock \ - -H "Content-Type: application/json" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "card": { - "number": "4110760000000008" - }, - "pinPad": { - "transactionId": "b0c62f97-3b06-4c33-b68f-e281e95eb4bb", - "positions": "0123" - } - } - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/gateway/api-reference/report.mdx b/src/pages/gateway/api-reference/report.mdx deleted file mode 100644 index 3a7f1fa..0000000 --- a/src/pages/gateway/api-reference/report.mdx +++ /dev/null @@ -1,77 +0,0 @@ -export const apiRefs = ['/gateway/report', '/gateway/report/obtain'] - -## Solicitar un reporte {{ id: 'report-request', tag: 'POST', label: '/gateway/report' }} - - - - Permite solicitar que se genere un reporte de transacciones y retorna un identificador para el proceso, el cúal una vez sea llamado el callback puede ser obtenido en el endpoint siguiente - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/report \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "filters": { - "startDate": "2023-06-07 14:59:34", - "endDate": "2023-06-08 14:59:34", - "state": [ - "APPROVED", - "REJECTED" - ] - }, - "callbackUrl": "https://dnetix.co/ping/report" - }' - ``` - - - - ---- - -## Obtener un reporte previamente solicitado {{ id: 'report-obtain-request', tag: 'POST', label: '/gateway/report/obtain' }} - - - - Permite obtener un reporte previamente generado. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/report/obtain \ - -H "Content-Type: application/json" \ - -H "Accept-Encoding: gzip" \ - -d '{ - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "id": 0 - }' - ``` - - - \ No newline at end of file diff --git a/src/pages/gateway/api-reference/tokenize.mdx b/src/pages/gateway/api-reference/tokenize.mdx deleted file mode 100644 index 5d5191f..0000000 --- a/src/pages/gateway/api-reference/tokenize.mdx +++ /dev/null @@ -1,91 +0,0 @@ -export const apiRefs = ['/gateway/tokenize', '/invalidate'] - -## Tokenización (tokenize) {{ id: 'tokenize-request', tag: 'POST', label: '/gateway/tokenize' }} - - - - Este servicio permite almacenar un instrumento de pago como: tarjetas de crédito o cuenta bancaria de manera segura, a través de una petición que contenga la información de la misma, se generará un token que puede ser usado en el servicio de procesamiento y para todos los efectos, en PlacetoPay equivale a una tarjeta de crédito o cuenta bancaria, la diferencia es que se envía la estructura token en vez de card o account. - - > Previamente al consumo de este servicio se debe consultar el de información para saber si es necesario o no generar un OTP al cliente y en caso de ser necesario, solicitar el token a la persona y enviarlo en el consumo. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/tokenize \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Prueba", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123", - "installments": "2" - }, - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Tokenización (invalidate) {{ id: 'tokenize-invalidate-request', tag: 'POST', label: '/invalidate' }} - - - - Este servicio permite invalidar y eliminar un token asociado a una tarjeta de crédito. - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/invalidate \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "instrument": { - "token": { - "token": "239bd2573205e974c4bed7c99cc1125c464f6350a905565333fff041d8f5ef79" - } - } - }' - ``` - - - diff --git a/src/pages/gateway/api-reference/transaction.mdx b/src/pages/gateway/api-reference/transaction.mdx deleted file mode 100644 index 74c4576..0000000 --- a/src/pages/gateway/api-reference/transaction.mdx +++ /dev/null @@ -1,161 +0,0 @@ -export const apiRefs = ['/gateway/process', '/gateway/query', '/gateway/search', '/gateway/transaction'] - -## Procesamiento de transacción {{ id: 'process-request', tag: 'POST', label: '/gateway/process' }} - - - - Este servicio permite que se realice el cobro a la tarjeta del usuario, los parámetros del instrument son variables, si no se pide tipo de crédito ni otp no es necesario enviar esas variables, payer es siempre requerido, buyer es opcional pero recomendado. - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "payment": { - "reference": "1122334455", - "description": "Prueba", - "amount": { - "currency": "USD", - "total": 100 - } - }, - "instrument": { - "card": { - "number": "4110760000000008", - "expiration": "12/20", - "cvv": "123", - "installments": "2" - }, - }, - "ipAddress": "127.0.0.1", - "userAgent": "Testing" - }' - ``` - - - - ---- - -## Consulta de transacción por referencia interna {{ id: 'query-request', tag: 'POST', label: '/gateway/query' }} - - - - Permite consultar una transacción en particular usando su referencia interna. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/query \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "internalReference": "230364" - }' - ``` - - - - ---- - -## Búsqueda de transacciones {{ id: 'search-request', tag: 'POST', label: '/gateway/search' }} - - - - Este servicio permite la búsqueda de transacciones por referencia y monto, suele utilizarse en caso de pérdida de comunicación al crear una transacción para obtener la referencia interna nuevamente. - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/search \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "reference": "TEST_20171108_144400" - "amount": { - "currency": "COP", - "total": "1000" - } - }' - ``` - - - - ---- - -## Operaciones sobre una transacción {{ id: 'transaction-request', tag: 'POST', label: '/gateway/transaction' }} - - - - Permite realizar un reverso, re-autorización, reembolso o cash out sobre una transacción existente - - - - - - - ```bash {{ title: 'cURL' }} - curl -X "POST" https://api-co-dev.placetopay.ws/gateway/transaction \ - -H "Content-Type: application/json" \ - -d '{ - "locale": "es_CO", - "auth": { - "login":"c51ce410c124a10e0db5e4b97fc2af39", - "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", - "nonce":"NjE0OWVkODgwYjNhNw==", - "seed":"2021-09-21T09:34:48-05:00" - }, - "action": "reverse", - "internalReference": "1505723583", - "authorization": "999999" - }' - ``` - - -