diff --git a/src/assets/apis/gateway/en.yaml b/src/assets/apis/gateway/en.yaml index 6c555ab..2ea295b 100644 --- a/src/assets/apis/gateway/en.yaml +++ b/src/assets/apis/gateway/en.yaml @@ -216,6 +216,77 @@ paths: - "auth" - "payment" - "instrument" + - title: "CeroPay" + type: "object" + properties: + locale: + type: "string" + description: "Determine the language of the response" + example: "es-CO" + auth: + $ref: "#/components/schemas/Authentication" + payment: + type: "object" + description: "Structure that contains the information about the payment of the transaction required to the web service" + properties: + reference: + type: "string" + minLength: 1 + maxLength: 32 + description: + type: "string" + maxLength: 250 + amount: + title: "Amount" + type: "object" + description: "Structure that contains the information about the payment of the transaction required to the web service" + required: + - "currency" + - "total" + properties: + currency: + type: "string" + enum: + - "COP" + example: "COP" + minLength: 3 + maxLength: 3 + total: + type: "number" + taxes: + type: "array" + items: + $ref: "#/components/schemas/TaxDetail" + details: + type: "array" + items: + $ref: "#/components/schemas/AmountDetail" + instrument: + type: "object" + description: "Structure that contains information about the means of payment to be used in a transaction. This structure is variable according to the request that is generated. Each service requires that one or another data be used." + properties: + redirection: + type: "object" + description: "It represents a redirect payment method, meaning that it requires the user to be sent to another URL to complete the process." + properties: + paymentMethod: + type: "string" + enum: + - "BB_CP" + returnURL: + type: "string" + format: "uri" + example: "http://your-site.com/your-return-route" + maxLength: 250 + description: "URL so that once the payment process is completed, control is returned (when applicable)" + ipAddress: + type: "string" + userAgent: + type: "string" + required: + - "auth" + - "payment" + - "instrument" examples: Ejemplo: value: @@ -475,6 +546,54 @@ paths: - "status" - "provider" - "serviceCode" + - title: "CeroPay" + type: "object" + properties: + status: + $ref: "#/components/schemas/Status" + provider: + type: "string" + example: "BANCO_BOGOTA" + description: "Indicates which provider will be used in the transaction" + serviceCode: + type: "string" + description: "Indicates the code of the service that will process the transaction" + example: "BB_CP" + requireRedirection: + type: "boolean" + description: "Indicates if the payment method is of the redirect type" + cardType: + $ref: "#/components/schemas/CardType" + cardTypes: + type: "array" + description: "Indicates the card types supported by the provider" + items: + $ref: "#/components/schemas/CardType" + displayInterest: + type: "boolean" + description: "Indicates if it is necessary display the interest for transaction" + requiereOtp: + type: "boolean" + description: "Indicates if it is necessary to perform the OTP flow" + requiereCvv2: + type: "boolean" + description: "Indicates whether it is required to send CVV for transaction processing" + threeDS: + type: "string" + enum: + - "optional" + - "required" + - "unsupported" + description: "Indicates if 3DS is necessary" + credits: + type: "array" + description: "Indicates the credits available per supplier" + items: + $ref: "#/components/schemas/Credit" + required: + - "status" + - "provider" + - "serviceCode" examples: Ejemplo: value: @@ -1029,7 +1148,7 @@ paths: type: "string" description: | Type of operation to be performed on the transaction - + `reverse` to reverse a transaction. `reauthorization` to modify a checkin transaction. `checkout` to close and collect a checkin transaction. @@ -1071,7 +1190,7 @@ paths: type: "number" description: | Alphabetical code of the currency to use (ISO 4217 alpha code) - + EJ: `USD` total: type: "number" @@ -1954,15 +2073,15 @@ paths: examples: example: value: "id date transaction_date reference currency_code amount tax payment_method internal_reference status reason merchant terminal authorization refunded installments last_digits bank_currency bank_factor bank_amount issuer_name payer_document payer_first_name payer_last_name payer_email ip_address batch_number line_number type - c42977b5d4ff9d9613320c7ee98e9eb0 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 4113943 USD 2327 442.13 ID_VS 221 APPROVED 000468232 00990101 1 0008 USD 1 2327 Testing Bank 32694548 Miss Joanne Fadel MD Price blangworth@hotmail.com 237.234.250.30 AUTH_ONLY - 315c9ca9e64bed46f24a2e18bdd76468 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 8122 USD 4457 846.83 ID_VS 222 APPROVED 000468232 00990101 1 0008 USD 1 4457 Testing Bank 44056172 Charlotte Maggio Steuber drutherford@gmail.com 164.233.22.247 AUTH_ONLY - fd239e99125c326e92137197fd5d1959 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 753446151 USD 3798 721.62 ID_VS 223 APPROVED 000468232 00990101 1 0008 USD 1 3798 Testing Bank 51751981 Mr. Abdiel Schroeder DDS McKenzie leonard.beier@runte.com 250.136.231.200 AUTH_ONLY - be945b27ff13291409b929cc9cb15274 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 482657 USD 1401 266.19 ID_VS 224 APPROVED 0468232 00990101 1 0008 USD 1 1401 Testing Bank 98958097 Dr. Mia Abshire Douglas antonia.blanda@wyman.com 32.1.213.30 AUTH_ONLY - 3aaa74df49cf3634276675c95e49f2af 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 77616851 USD 1921 364.99 ID_VS 225 APPROVED 000468232 00990101 1 0008 USD 1 1921 Testing Bank 6211299 Dr. Marcelina Huel I Considine vlangworth@emard.biz 249.218.136.4 AUTH_ONLY - 6e89e692975bb117db78360c8ebf0a00 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 74141 USD 773 146.87 ID_VS 226 APPROVED 000468232 00990101 1 0008 USD 1 773 Testing Bank 22736252 Melody Goodwin DDS Gerlach iblock@ohara.com 168.87.8.132 AUTH_ONLY - b50e4e8cca851a578fa40917030397a3 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 828 USD 473 89.87 ID_VS 227 APPROVED 000468232 00990101 1 0008 USD 1 473 Testing Bank 9397147 Freeman Kirlin Aufderhar drobel@kshlerin.com 21.185.38.170 AUTH_ONLY - b66ffe1bff91a15986cba677bbaeaa7f 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 581122 USD 1767 335.73 ID_VS 228 APPROVED 0468232 00990101 1 0008 USD 1 1767 Testing Bank 62818359 Mrs. Rosina Mann Schaefer ctremblay@gmail.com 15.8.188.238 AUTH_ONLY - 135afcb2f872cf55168461e7e874242a 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 3896507 USD 7 1.33 ID_VS 229 APPROVED 0468232 00990101 1 0008 USD 1 7 Testing Bank 10597030 Kristy Purdy IV Mills clyde68@hotmail.com 148.232.85.97 AUTH_ONLY + c42977b5d4ff9d9613320c7ee98e9eb0 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 4113943 USD 2327 442.13 ID_VS 221 APPROVED 000468232 00990101 1 0008 USD 1 2327 Testing Bank 32694548 Miss Joanne Fadel MD Price blangworth@hotmail.com 237.234.250.30 AUTH_ONLY + 315c9ca9e64bed46f24a2e18bdd76468 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 8122 USD 4457 846.83 ID_VS 222 APPROVED 000468232 00990101 1 0008 USD 1 4457 Testing Bank 44056172 Charlotte Maggio Steuber drutherford@gmail.com 164.233.22.247 AUTH_ONLY + fd239e99125c326e92137197fd5d1959 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 753446151 USD 3798 721.62 ID_VS 223 APPROVED 000468232 00990101 1 0008 USD 1 3798 Testing Bank 51751981 Mr. Abdiel Schroeder DDS McKenzie leonard.beier@runte.com 250.136.231.200 AUTH_ONLY + be945b27ff13291409b929cc9cb15274 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 482657 USD 1401 266.19 ID_VS 224 APPROVED 0468232 00990101 1 0008 USD 1 1401 Testing Bank 98958097 Dr. Mia Abshire Douglas antonia.blanda@wyman.com 32.1.213.30 AUTH_ONLY + 3aaa74df49cf3634276675c95e49f2af 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 77616851 USD 1921 364.99 ID_VS 225 APPROVED 000468232 00990101 1 0008 USD 1 1921 Testing Bank 6211299 Dr. Marcelina Huel I Considine vlangworth@emard.biz 249.218.136.4 AUTH_ONLY + 6e89e692975bb117db78360c8ebf0a00 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 74141 USD 773 146.87 ID_VS 226 APPROVED 000468232 00990101 1 0008 USD 1 773 Testing Bank 22736252 Melody Goodwin DDS Gerlach iblock@ohara.com 168.87.8.132 AUTH_ONLY + b50e4e8cca851a578fa40917030397a3 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 828 USD 473 89.87 ID_VS 227 APPROVED 000468232 00990101 1 0008 USD 1 473 Testing Bank 9397147 Freeman Kirlin Aufderhar drobel@kshlerin.com 21.185.38.170 AUTH_ONLY + b66ffe1bff91a15986cba677bbaeaa7f 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 581122 USD 1767 335.73 ID_VS 228 APPROVED 0468232 00990101 1 0008 USD 1 1767 Testing Bank 62818359 Mrs. Rosina Mann Schaefer ctremblay@gmail.com 15.8.188.238 AUTH_ONLY + 135afcb2f872cf55168461e7e874242a 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 3896507 USD 7 1.33 ID_VS 229 APPROVED 0468232 00990101 1 0008 USD 1 7 Testing Bank 10597030 Kristy Purdy IV Mills clyde68@hotmail.com 148.232.85.97 AUTH_ONLY 19868ea1110eca766186806ef0e38f71 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 68490 USD 4987 947.53 ID_VS 230 APPROVED 000468232 00990101 1 0008 USD 1 4987 Testing Bank 32385057 Mr. Harley Howe Rogahn oreilly.onie@hotmail.com 87.121.113.190 AUTH_ONLY " 425: description: "When the request is made before the report is finished generating" @@ -2636,7 +2755,7 @@ components: description: "Structure that contains the token information associated with the card. For entry, only the token or subtoken and the cvv are necessary if it is an operation where the user is present. - + For output if all data is returned when tokenizing." properties: token: diff --git a/src/assets/apis/gateway/es.yaml b/src/assets/apis/gateway/es.yaml index 3fc32f3..3bc9da3 100644 --- a/src/assets/apis/gateway/es.yaml +++ b/src/assets/apis/gateway/es.yaml @@ -215,6 +215,78 @@ paths: - "auth" - "payment" - "instrument" + - title: "CeroPay" + type: "object" + properties: + locale: + type: "string" + description: "Determina el idioma de la respuesta" + example: "es-CO" + auth: + $ref: "#/components/schemas/Authentication" + payment: + type: "object" + description: "Estructura que contiene la información acerca del pago de la transacción requerida al servicio web" + properties: + reference: + type: "string" + minLength: 1 + maxLength: 32 + description: + type: "string" + maxLength: 250 + amount: + title: "Amount" + type: "object" + description: "Estructura que contiene la información acerca del pago de la transacción requerida al servicio web" + required: + - "currency" + - "total" + properties: + currency: + type: "string" + enum: + - "COP" + example: "COP" + minLength: 3 + maxLength: 3 + total: + type: "number" + taxes: + type: "array" + items: + $ref: "#/components/schemas/TaxDetail" + details: + type: "array" + items: + $ref: "#/components/schemas/AmountDetail" + instrument: + type: "object" + description: "Estructura que contiene la información acerca del medio de pago a usar en una transacción, esta estructura es variable de acuerdo a la solicitud que se genere, cada servicio requiere que se usen unos u otros datos." + properties: + redirection: + type: "object" + description: "Representa un medio de pago de redirección, es decir que requiere que se envíe el usuario a otra URL para completar el proceso." + properties: + paymentMethod: + type: "string" + enum: + - "BB_CP" + returnURL: + type: "string" + format: "uri" + example: "http://your-site.com/your-return-route" + maxLength: 250 + description: "URL para que una vez se termine el proceso de pago se retorne el control." + + ipAddress: + type: "string" + userAgent: + type: "string" + required: + - "auth" + - "payment" + - "instrument" examples: Ejemplo: value: @@ -474,6 +546,54 @@ paths: - "status" - "provider" - "serviceCode" + - title: "CeroPay" + type: "object" + properties: + status: + $ref: "#/components/schemas/Status" + provider: + type: "string" + example: "BANCO_BOGOTA" + description: "Indica cual proveedor será utilizado en la transacción" + serviceCode: + type: "string" + description: "Indica el código del servicio que procesará la transacción" + example: "BB_CP" + requireRedirection: + type: "boolean" + description: "Indica si el medio de pago es del tipo redirección" + cardType: + $ref: "#/components/schemas/CardType" + cardTypes: + type: "array" + description: "Indica los tipos de tarjeta soportados por el proveedor" + items: + $ref: "#/components/schemas/CardType" + displayInterest: + type: "boolean" + description: "Indica si es requerido mostrar los intereses de la transacción" + requiereOtp: + type: "boolean" + description: "Indica si es necesario realizar el flujo de OTP" + requiereCvv2: + type: "boolean" + description: "Indica si es requerido enviar CVV para el procesamiento de la transacción" + threeDS: + type: "string" + enum: + - "optional" + - "required" + - "unsupported" + description: "Indica si es necesario 3DS" + credits: + type: "array" + description: "Indica los créditos disponibles por proveedor" + items: + $ref: "#/components/schemas/Credit" + required: + - "status" + - "provider" + - "serviceCode" examples: Ejemplo: value: @@ -1030,7 +1150,7 @@ paths: type: "string" description: | Tipo de operación a realizar sobre la transacción - + `reverse` para revesar una transacción. `reauthorization` para modificar una transacción de checkin. `checkout` para cerrar y cobrar una transacción de checkin. @@ -1755,11 +1875,11 @@ paths: operationId: "post-report-obtain" responses: 200: - description: "OK + description: "OK Una vez se tiene el reporte retorna la información, el cúal es un archivo separado por tabs con los siguientes encabezados - La columna de type es agragada cuando el reporte usa el filtro de type + La columna de type es agragada cuando el reporte usa el filtro de type ``` @@ -1800,15 +1920,15 @@ paths: examples: example: value: "id date transaction_date reference currency_code amount tax payment_method internal_reference status reason merchant terminal authorization refunded installments last_digits bank_currency bank_factor bank_amount issuer_name payer_document payer_first_name payer_last_name payer_email ip_address batch_number line_number type - c42977b5d4ff9d9613320c7ee98e9eb0 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 4113943 USD 2327 442.13 ID_VS 221 APPROVED 000468232 00990101 1 0008 USD 1 2327 Testing Bank 32694548 Miss Joanne Fadel MD Price blangworth@hotmail.com 237.234.250.30 AUTH_ONLY - 315c9ca9e64bed46f24a2e18bdd76468 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 8122 USD 4457 846.83 ID_VS 222 APPROVED 000468232 00990101 1 0008 USD 1 4457 Testing Bank 44056172 Charlotte Maggio Steuber drutherford@gmail.com 164.233.22.247 AUTH_ONLY - fd239e99125c326e92137197fd5d1959 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 753446151 USD 3798 721.62 ID_VS 223 APPROVED 000468232 00990101 1 0008 USD 1 3798 Testing Bank 51751981 Mr. Abdiel Schroeder DDS McKenzie leonard.beier@runte.com 250.136.231.200 AUTH_ONLY - be945b27ff13291409b929cc9cb15274 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 482657 USD 1401 266.19 ID_VS 224 APPROVED 0468232 00990101 1 0008 USD 1 1401 Testing Bank 98958097 Dr. Mia Abshire Douglas antonia.blanda@wyman.com 32.1.213.30 AUTH_ONLY - 3aaa74df49cf3634276675c95e49f2af 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 77616851 USD 1921 364.99 ID_VS 225 APPROVED 000468232 00990101 1 0008 USD 1 1921 Testing Bank 6211299 Dr. Marcelina Huel I Considine vlangworth@emard.biz 249.218.136.4 AUTH_ONLY - 6e89e692975bb117db78360c8ebf0a00 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 74141 USD 773 146.87 ID_VS 226 APPROVED 000468232 00990101 1 0008 USD 1 773 Testing Bank 22736252 Melody Goodwin DDS Gerlach iblock@ohara.com 168.87.8.132 AUTH_ONLY - b50e4e8cca851a578fa40917030397a3 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 828 USD 473 89.87 ID_VS 227 APPROVED 000468232 00990101 1 0008 USD 1 473 Testing Bank 9397147 Freeman Kirlin Aufderhar drobel@kshlerin.com 21.185.38.170 AUTH_ONLY - b66ffe1bff91a15986cba677bbaeaa7f 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 581122 USD 1767 335.73 ID_VS 228 APPROVED 0468232 00990101 1 0008 USD 1 1767 Testing Bank 62818359 Mrs. Rosina Mann Schaefer ctremblay@gmail.com 15.8.188.238 AUTH_ONLY - 135afcb2f872cf55168461e7e874242a 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 3896507 USD 7 1.33 ID_VS 229 APPROVED 0468232 00990101 1 0008 USD 1 7 Testing Bank 10597030 Kristy Purdy IV Mills clyde68@hotmail.com 148.232.85.97 AUTH_ONLY + c42977b5d4ff9d9613320c7ee98e9eb0 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 4113943 USD 2327 442.13 ID_VS 221 APPROVED 000468232 00990101 1 0008 USD 1 2327 Testing Bank 32694548 Miss Joanne Fadel MD Price blangworth@hotmail.com 237.234.250.30 AUTH_ONLY + 315c9ca9e64bed46f24a2e18bdd76468 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 8122 USD 4457 846.83 ID_VS 222 APPROVED 000468232 00990101 1 0008 USD 1 4457 Testing Bank 44056172 Charlotte Maggio Steuber drutherford@gmail.com 164.233.22.247 AUTH_ONLY + fd239e99125c326e92137197fd5d1959 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 753446151 USD 3798 721.62 ID_VS 223 APPROVED 000468232 00990101 1 0008 USD 1 3798 Testing Bank 51751981 Mr. Abdiel Schroeder DDS McKenzie leonard.beier@runte.com 250.136.231.200 AUTH_ONLY + be945b27ff13291409b929cc9cb15274 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 482657 USD 1401 266.19 ID_VS 224 APPROVED 0468232 00990101 1 0008 USD 1 1401 Testing Bank 98958097 Dr. Mia Abshire Douglas antonia.blanda@wyman.com 32.1.213.30 AUTH_ONLY + 3aaa74df49cf3634276675c95e49f2af 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 77616851 USD 1921 364.99 ID_VS 225 APPROVED 000468232 00990101 1 0008 USD 1 1921 Testing Bank 6211299 Dr. Marcelina Huel I Considine vlangworth@emard.biz 249.218.136.4 AUTH_ONLY + 6e89e692975bb117db78360c8ebf0a00 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 74141 USD 773 146.87 ID_VS 226 APPROVED 000468232 00990101 1 0008 USD 1 773 Testing Bank 22736252 Melody Goodwin DDS Gerlach iblock@ohara.com 168.87.8.132 AUTH_ONLY + b50e4e8cca851a578fa40917030397a3 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 828 USD 473 89.87 ID_VS 227 APPROVED 000468232 00990101 1 0008 USD 1 473 Testing Bank 9397147 Freeman Kirlin Aufderhar drobel@kshlerin.com 21.185.38.170 AUTH_ONLY + b66ffe1bff91a15986cba677bbaeaa7f 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 581122 USD 1767 335.73 ID_VS 228 APPROVED 0468232 00990101 1 0008 USD 1 1767 Testing Bank 62818359 Mrs. Rosina Mann Schaefer ctremblay@gmail.com 15.8.188.238 AUTH_ONLY + 135afcb2f872cf55168461e7e874242a 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 3896507 USD 7 1.33 ID_VS 229 APPROVED 0468232 00990101 1 0008 USD 1 7 Testing Bank 10597030 Kristy Purdy IV Mills clyde68@hotmail.com 148.232.85.97 AUTH_ONLY 19868ea1110eca766186806ef0e38f71 2021-01-13T01:54:50-05:00 2021-01-13T01:54:50-05:00 68490 USD 4987 947.53 ID_VS 230 APPROVED 000468232 00990101 1 0008 USD 1 4987 Testing Bank 32385057 Mr. Harley Howe Rogahn oreilly.onie@hotmail.com 87.121.113.190 AUTH_ONLY " 425: description: "Cuando la petición se realiza antes de que se termine de generar el reporte" @@ -2487,7 +2607,7 @@ es variable de acuerdo a la solicitud que se genere, cada servicio requiere que description: "Estructura que contiene la información del token que asocia a la tarjeta Para la entrada solo es necesario el token o el subtoken y el cvv si se trata de una operación donde el usuario está presente - + Para la salida si se devuelven todos los datos al tokenizar " properties: diff --git a/src/pages/en/gateway/api/reference/information.mdx b/src/pages/en/gateway/api/reference/information.mdx index 56f07b8..621c160 100644 --- a/src/pages/en/gateway/api/reference/information.mdx +++ b/src/pages/en/gateway/api/reference/information.mdx @@ -151,6 +151,49 @@ export const apiRefs = ['/gateway/information', '/gateway/interests', '/gateway/ "userAgent": "Testing" }' ``` + ```bash {{ title: 'CeroPay' }} + 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" + }, + "payer": { + "name": "Camila", + "surname": "Cardenas", + "email": "camila@cardenas.com", + "documentType": "CC", + "document": "2504950080", + "mobile": "3006108300" + }, + "payment": { + "reference": "91275", + "description": "CeroPay", + "amount": { + "total": 100000, + "currency": "COP", + "taxes": [ + { + "kind": "valueAddedTax", + "amount": 2000 + } + ] + } + }, + "instrument": { + "redirection": { + "paymentMethod": "BB_CP", + "returnURL": "https://your-site.com/your-return-path", + } + }, + "ipAddress": "127.0.0.1", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36" + }' + ``` @@ -414,6 +457,26 @@ export const apiRefs = ['/gateway/information', '/gateway/interests', '/gateway/ "credits": [] } ``` + ```json {{ title: 'CeroPay' }} + { + "status": { + "status": "OK", + "reason": "00", + "message": null, + "date": "2024-12-04T08:14:54-05:00" + }, + "provider": "BANCO_BOGOTA", + "serviceCode": "BB_CP", + "requireRedirection": true, + "cardType": null, + "cardTypes": null, + "displayInterest": false, + "requireOtp": false, + "requireCvv2": false, + "threeDS": "unsupported", + "credits": [] + } + ``` @@ -609,4 +672,4 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/balance \ ---- \ No newline at end of file +--- diff --git a/src/pages/en/gateway/api/reference/transaction.mdx b/src/pages/en/gateway/api/reference/transaction.mdx index 76373b5..f944728 100644 --- a/src/pages/en/gateway/api/reference/transaction.mdx +++ b/src/pages/en/gateway/api/reference/transaction.mdx @@ -665,6 +665,49 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36", "sourcePlatform": "microsites" }' +``` +```bash {{ title: 'CeroPay' }} +curl -X "POST" https://api-co-dev.placetopay.ws/gateway/process \ +-H "Content-Type: application/json" \ +-d '{ + "locale": "es_CO", + "auth": { + "login": "6dd490faf9cb87a9862245da41170ff2", + "tranKey": "iVrCs2xc60jWqW9bAD0rEHdqZG1O0y+jh9s+urOlkzI=", + "seed": "2021-10-14T19:44:06.820Z", + "nonce": "NHJqNXcz" + }, + "payer": { + "name": "Camila", + "surname": "Cardenas", + "email": "camila@cardenas.com", + "documentType": "CC", + "document": "2504950080", + "mobile": "3006108300" + }, + "payment": { + "reference": "91275", + "description": "CeroPay", + "amount": { + "total": 100000, + "currency": "COP", + "taxes": [ + { + "kind": "valueAddedTax", + "amount": 2000 + } + ] + } + }, + "instrument": { + "redirection": { + "paymentMethod": "BB_CP", + "returnURL": "https://your-site.com/your-return-path", + } + }, + "ipAddress": "127.0.0.1", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36" +}' ``` @@ -1211,6 +1254,60 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ "notificationURL": "https://mysite.com/notification-path" } ``` + ```json {{ title: 'CeroPay' }} + { + "status": { + "status": "PENDING", + "reason": "?-", + "message": "Transacción pendiente. Por favor consulte con su entidad financiera si el débito fue realizado", + "date": "2024-12-04T00:19:42-05:00" + }, + "date": "2024-12-04T00:19:42-05:00", + "transactionDate": "2024-12-04T00:19:42-05:00", + "internalReference": 437981, + "reference": "TEST_20210526_141005", + "paymentMethod": "BB_CP", + "franchise": "banco_bogota", + "franchiseName": "Ceropay", + "issuerName": "Banco Bogota", + "amount": { + "currency": "COP", + "total": 1000 + }, + "conversion": { + "from": { + "currency": "COP", + "total": 1000 + }, + "to": { + "currency": "COP", + "total": 1000 + }, + "factor": 1 + }, + "authorization": "000000", + "receipt": "000000437981", + "type": "AUTH_ONLY", + "refunded": false, + "lastDigits": null, + "provider": "BANCO_BOGOTA", + "discount": null, + "processorFields": { + "id": "8e9a67c5f922c4ee17aedf130669aa3b", + "b24": "?-", + "paymentURL": "https://bancobogota.labdigbdbstgpb.com/?trazabilityCode=000000437981" + }, + "additional": {}, + "redirection": { + "paymentMethod": "BB_CP", + "processURL": "https://bancobogota.labdigbdbstgpb.com/?trazabilityCode=000000437981", + "returnURL": "https://your-site.com/your-return-path", + "additional": { + "bankCode": "0001" + } + } + } + ``` diff --git a/src/pages/gateway/api/reference/information.mdx b/src/pages/gateway/api/reference/information.mdx index 00db960..08e72c5 100644 --- a/src/pages/gateway/api/reference/information.mdx +++ b/src/pages/gateway/api/reference/information.mdx @@ -50,13 +50,13 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ 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" }, - "locale": "es_CO", "payer": { "name": "Dr. Wilfredo Cole Sr.", "surname": "Corwin", @@ -88,13 +88,13 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ 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" }, - "locale": "es_CO", "payer": { "name": "Dr. Wilfredo Cole Sr.", "surname": "Corwin", @@ -126,13 +126,13 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ 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" }, - "locale": "es_CO", "payer": { "name": "Dr. Wilfredo Cole Sr.", "surname": "Corwin", @@ -158,6 +158,49 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ "ipAddress": "127.0.0.1", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36" }' +``` +```bash {{ title: 'CeroPay' }} +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" + }, + "payer": { + "name": "Camila", + "surname": "Cardenas", + "email": "camila@cardenas.com", + "documentType": "CC", + "document": "2504950080", + "mobile": "3006108300" + }, + "payment": { + "reference": "91275", + "description": "CeroPay", + "amount": { + "total": 100000, + "currency": "COP", + "taxes": [ + { + "kind": "valueAddedTax", + "amount": 2000 + } + ] + } + }, + "instrument": { + "redirection": { + "paymentMethod": "BB_CP", + "returnURL": "https://your-site.com/your-return-path", + } + }, + "ipAddress": "127.0.0.1", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36" +}' ``` @@ -446,6 +489,27 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ "threeDS": "unsupported", "credits": [] } +``` + +```json {{ title: 'CeroPay' }} +{ + "status": { + "status": "OK", + "reason": "00", + "message": null, + "date": "2024-12-04T08:14:54-05:00" + }, + "provider": "BANCO_BOGOTA", + "serviceCode": "BB_CP", + "requireRedirection": true, + "cardType": null, + "cardTypes": null, + "displayInterest": false, + "requireOtp": false, + "requireCvv2": false, + "threeDS": "unsupported", + "credits": [] +} ``` diff --git a/src/pages/gateway/api/reference/transaction.mdx b/src/pages/gateway/api/reference/transaction.mdx index 70c50b2..a2bebb0 100644 --- a/src/pages/gateway/api/reference/transaction.mdx +++ b/src/pages/gateway/api/reference/transaction.mdx @@ -675,6 +675,50 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ "sourcePlatform": "microsites" }' ``` +```bash {{ title: 'CeroPay' }} +curl -X "POST" https://api-co-dev.placetopay.ws/gateway/process \ +-H "Content-Type: application/json" \ +-d '{ + "locale": "es_CO", + "auth": { + "login": "6dd490faf9cb87a9862245da41170ff2", + "tranKey": "iVrCs2xc60jWqW9bAD0rEHdqZG1O0y+jh9s+urOlkzI=", + "seed": "2021-10-14T19:44:06.820Z", + "nonce": "NHJqNXcz" + }, + "payer": { + "name": "Camila", + "surname": "Cardenas", + "email": "camila@cardenas.com", + "documentType": "CC", + "document": "2504950080", + "mobile": "3006108300" + }, + "payment": { + "reference": "91275", + "description": "CeroPay", + "amount": { + "total": 100000, + "currency": "COP", + "taxes": [ + { + "kind": "valueAddedTax", + "amount": 2000 + } + ] + } + }, + "instrument": { + "redirection": { + "paymentMethod": "BB_CP", + "returnURL": "https://your-site.com/your-return-path", + } + }, + "ipAddress": "127.0.0.1", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36" +}' +``` + @@ -1220,6 +1264,60 @@ curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \ "notificationURL": "https://mysite.com/notification-path" } ``` + ```json {{ title: 'CeroPay' }} + { + "status": { + "status": "PENDING", + "reason": "?-", + "message": "Transacción pendiente. Por favor consulte con su entidad financiera si el débito fue realizado", + "date": "2024-12-04T00:19:42-05:00" + }, + "date": "2024-12-04T00:19:42-05:00", + "transactionDate": "2024-12-04T00:19:42-05:00", + "internalReference": 437981, + "reference": "TEST_20210526_141005", + "paymentMethod": "BB_CP", + "franchise": "banco_bogota", + "franchiseName": "Ceropay", + "issuerName": "Banco Bogota", + "amount": { + "currency": "COP", + "total": 1000 + }, + "conversion": { + "from": { + "currency": "COP", + "total": 1000 + }, + "to": { + "currency": "COP", + "total": 1000 + }, + "factor": 1 + }, + "authorization": "000000", + "receipt": "000000437981", + "type": "AUTH_ONLY", + "refunded": false, + "lastDigits": null, + "provider": "BANCO_BOGOTA", + "discount": null, + "processorFields": { + "id": "8e9a67c5f922c4ee17aedf130669aa3b", + "b24": "?-", + "paymentURL": "https://bancobogota.labdigbdbstgpb.com/?trazabilityCode=000000437981" + }, + "additional": {}, + "redirection": { + "paymentMethod": "BB_CP", + "processURL": "https://bancobogota.labdigbdbstgpb.com/?trazabilityCode=000000437981", + "returnURL": "https://your-site.com/your-return-path", + "additional": { + "bankCode": "0001" + } + } + } + ```