Checkout

- x-api-keystringrequiredDescription
- x-access-tokenstringrequiredDescription
- content-typestringrequiredDescription
- totalNumberrequiredDescription
- descriptionstringrequiredDescription
- currencystringrequiredDescription
- referencestringrequiredDescription
- testBooleanDescription
- return_urlstringDescription
- webhookstringDescription
- itemsArrayDescription
- optionsObjectDescription
- themeBooleanDescription
- embedBooleanDescription
- domainstringDescription
- emitNotificationsBooleanDescription
- emitCustomerSuccessNotificationBooleanDescription
- emitCustomerFailureNotificationBooleanDescription
- emitCustomerWaitingNotificationBooleanDescription
- closeOrReturnOnResultBooleanDescription
- closeOrReturnTimeoutIntegerDescription
- showNoInterestLabelsBooleanDescription
- showWalletbooleanDescription
- softDescriptorstringDescription
- sourcesArrayDescription
- installmentsArrayDescription
- customerObjectrequiredDescription
- emailstringrequiredDescription
- namestringrequiredDescription
- identificationstringrequiredDescription
- phonestringrequiredDescription
- uidstringrequiredDescription
- {metadata}ObjectDescription
- createdAtintegerrequiredDescription
- birthdateobjectrequiredDescription
- dayintegerrequiredDescription
- monthintegerrequiredDescription
- yearintegerrequiredDescription
- splitArrayDescription
- timeoutNumberDescription
- intentstringDescription
- multicardBooleanDescription
- addressesArrayrequiredDescription
- addresses[$].typestringrequiredDescription
- addresses[$].countrystringrequiredDescription
- addresses[$].streetstringrequiredDescription
- addresses[$].streetNumberstringrequiredDescription
- addresses[$].streetNotesstringrequiredDescription
- addresses[$].zipCodestringrequiredDescription
- addresses[$].citystringrequiredDescription
- addresses[$].statestringrequiredDescription
- webhooksTypeStringDescription
- merchantsArrayDescription
- merchants.[$].uidstringrequiredDescription
- merchants.[$].intentstringDescription
var client = new RestClient("https://api.bdp.gire.com/p/checkout");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
request.AddHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@" ""total"": ""100.53"",
" + "\n" +
@" ""description"": ""Checkout de Prueba"",
" + "\n" +
@" ""reference"": ""260520210954"",
" + "\n" +
@" ""currency"": ""ARS"",
" + "\n" +
@" ""test"": true,
" + "\n" +
@" ""return_url"": ""https://gire.com/return_url"",
" + "\n" +
@" ""webhook"": ""https://gire.com/webhook"",
" + "\n" +
@" ""customer"": {
" + "\n" +
@" ""email"": ""[email protected]"",
" + "\n" +
@" ""name"": ""Cliente Demo"",
" + "\n" +
@" ""identification"": ""12123123""
" + "\n" +
@" }
" + "\n" +
@"}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);curl --location --request POST 'https://api.bdp.gire.com/p/checkout' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \
--header 'Content-Type: application/json' \
--data-raw '{
"total": "100.53",
"description": "Checkout de Prueba",
"reference": "260520210954",
"currency": "ARS",
"test": true,
"return_url": "https://gire.com/return_url",
"webhook": "https://gire.com/webhook",
"customer": {
"email": "[email protected]",
"name": "Cliente Demo",
"identification": "12123123"
}
}'import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient httpClient = HttpClient.newBuilder().version(HttpClient.Version.HTTP_2).build();
String data = "{\n\t\"total\": 100.2,\n\t\"currency\": \"ars\",\n\t\"reference\": \"2982-2XtPXlgSaWccqUyobuv4sEmLYMV0N6oX6MoridMw\",\n\t\"description\": \"Descripción de la Venta\",\n\t\"return_url\": \"https://mobbex.com/sale/return?session=56789\",\n\t\"webhook\": \"https://mobbex.com/sale/webhook?user=1234\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.POST(HttpRequest.BodyPublishers.ofString(data))
.uri(URI.create("https://api.bdp.gire.com/p/intent"))
.setHeader("x-api-key", MobbexClient.xApiKey)
.setHeader("x-lang", "es")
.setHeader("x-access-token", MobbexClient.xAccessToken)
.setHeader("Content-Type", "application/json")
.build();
HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());var data = JSON.stringify({
"total": "100.53",
"description": "Checkout de Prueba",
"reference": "260520210954",
"currency": "ARS",
"test": true,
"return_url": "https://api.bdp.gire.com/return_url",
"webhook": "https://gire.com/webhook",
"multivendor":"active",
"merchants": [
{
"uid": "demo_uid"
}
],
"customer": {
"email": "[email protected]",
"name": "Cliente Demo",
"identification": "12123123"
}
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.bdp.gire.com/p/checkout");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);import requests
import json
url = "https://api.bdp.gire.com/p/checkout"
payload = json.dumps({
"total": "100.53",
"description": "Checkout de Prueba",
"reference": "260520210954",
"currency": "ARS",
"test": True,
"return_url": "https://gire.com/return_url",
"webhook": "https://gire.com/webhook",
"customer": {
"email": "[email protected]",
"name": "Cliente Demo",
"identification": "12123123"
}
})
headers = {
'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"result": true,
"data": {
"id": "EC27WUC5YH5MHT0J9I",
"url": "https://gire.com/p/checkout/v2/EC27WUC5YH5MHT0J9I",
"description": "Checkout de Prueba",
"currency": "ARS",
"total": 100.53,
"created": 1622033797494
}
}Ejemplos del nodo addresses:
{
"addresses": [
{
"type": "billing",
"country": "AR",
"street": "Dirección",
"streetNumber": "1234",
"streetNotes": "",
"zipCode": "2000",
"city": "Cordoba",
"state": "C"
}
]
}Ejemplos del nodo items:
{
"items": [
{
"image": "https://www.gire.com/wp-content/uploads/2019/03/web_logo.png",
"quantity": 1,
"description": "Pago de servicio 1",
"total": 50
},
{
"image": "https://www.gire.com/wp-content/uploads/2019/04/web_logo.png",
"quantity": 5,
"description": "Mi Producto",
"total": 150
}
]
}
Ejemplos del nodo sources:
{
"sources": ["visa", "mastercard"]
}Ejemplo del nodo options para el parámetro softDescriptor:
{
"options": {
"softDescriptor": "descripciónResumen"
}
}
Ejemplos del nodo installments:
Eisten 3 formas de Limitar Planes:
- Ocultar determinados planes de todo el conjunto de planes existentes:
Estos planes se pueden oxcultar por referencia o por ID de plan
{
"installments": ["-ahora_12", "-ahora_18"]
}- Limitar los Planes a las elegidos en el Array:
Estos planes se pueden limitar por referencia o por ID de plan
{
"installments": ["1", "3", "ahora_12"]
}- Mostrar planes especiales basado en Reglas Avanzadas:
{
"installments": ["+uid:XPDhreMoG7","+uid: ID Regla Avanzada"]
}
Para conocer las opciones disponibles de medios de pago sources y planes installments ver Métodos de pago y cuotas
Para el caso especial de los Planes Ahora (Argentina) las referencias siempre serán fijas: ahora_3, ahora_6, ahora_12, ahora_18
Duración del Checkout
El checkout creado sólo podrá ser utilizado por 60 ( o el tiempo definido en la variable Timeout ) minutos, luego de esto expirará. Si el cliente intenta pagar luego de este periodo será redireccionado a la url declarada en return_url con status 401 (Expirado).
Atributo "reference"
Este atributo es utilizado para evitar pagos duplicados. Debe ser único para cada operación de pago a identificar.
Importante
Al momento de la creación del checkout, no se aceptan solicitudes desde el frontend del cliente, por motivos de seguridad, ya que sino se exponen las credenciales. En este caso se bloqueará la petición.
Postman
Retorno y WebHooks
Transacción Finalizada
Al definir el parámetro return_url el servicio redireccionará a la URL provista mediante HTTP Get una vez finalizada la transacción. A esta url se le agregará el Estado de la misma mediante el parámetro status, el tipo de transacción generada por el usuario mediante el parámetro type (cash/card) y el identificador de la transacción mediante el parámetro transactionId.
Ejemplo:
https://gire.com/thank_you?status=200&type=cash&transactionId=NfkvurRUX
Transacción Cancelada
Si el usuario cancela la operación status será 0 y type será none. Esto como se señala indica que el usuario no finalizó la operación y decidió volver al sitio.
Ejemplo:
https://gire.com/thank_you?status=0&type=none&transactionId=-1
Referencia de estados posibles
Es muy importante revisar la documentación sobre estados y tipos de documentación ya que el manejo de los mismos será utilizado durante la homologación del comercio. Esta documentación puede ser encontrada en el siguiente link: Códigos de EstadoCódigo de Estado
Vencimiento del Checkout
Para evitar que un Checkout quede pendiente de pago luego de cierto tiempo los Checkout tienen un tiempo límite por defecto de 60 minutos que puede ser personalizado via el parámetro "timeout" al crear el checkout enviando la cantidad de minutos máximos que se desea que el checkout siga activo. El mínimo de minutos es 1 minuto.
Cuando un Checkout Expira o se Vence el servicio envía automáticamente una notificación via Webhook notificando dicho vencimiento. Este Webhook tiene un formado especial descripto a continuación. Se debe tener en cuenta que este Webhook no es similar a los Webhooks de la operatoria.
{
"data": {
"checkout": {
"items": [
{
"_id": "63b47c090038d225bcba1297",
"categoryId": "",
"description": "Mi Producto",
"entity": "",
"image": "https://picsum.photos/200/300?grayscale&blur=2",
"productId": "",
"quantity": 2,
"reference": "",
"sku": "",
"total": 50,
"type": "third_party",
"uid": "f2d29353-8e09-4237-a7a7-e551cd759ff6",
"unitPrice": 0
},
{
"_id": "63b47c090038d225bcba1298",
"categoryId": "",
"description": "Mi otro producto",
"entity": "",
"image": "https://picsum.photos/200/300?grayscale&blur=2",
"productId": "",
"quantity": 1,
"reference": "",
"sku": "",
"total": 50.2,
"type": "third_party",
"uid": "51182c25-c341-4000-b048-5ce48d541fc5",
"unitPrice": 0
}
],
"reference": "d0246167-533c-4f3e-a56d-467eee21dbe5",
"uid": "CHK:D5TCT76SEAM4C1TRW9"
},
"data": null,
"status": {
"code": 401
}
},
"type": "checkout:expired"
}Al recibir este Webhook se entiende que el Checkout ya no podrá pagarse y se recomienda devolver el Stock o tomar las acciones necesarias desde su Backend.
El campo "data" será enviado cuando haya habido intentos infructuosos de pago, este campo sirve como control de la operación
{
"data": {
"checkout": {
"items": [
{
"_id": "63bb874426a735b851538775",
"categoryId": "",
"description": "Mi Producto",
"entity": "",
"image": "https://picsum.photos/200/300?grayscale&blur=2",
"productId": "",
"quantity": 2,
"reference": "",
"sku": "",
"total": 50,
"type": "third_party",
"uid": "4f104654-b81f-48f1-9bf9-14fd2abb7b82",
"unitPrice": 0
},
{
"_id": "63bb874426a735b851538776",
"categoryId": "",
"description": "Mi otro producto",
"entity": "",
"image": "https://picsum.photos/200/300?grayscale&blur=2",
"productId": "",
"quantity": 1,
"reference": "",
"sku": "",
"total": 50.2,
"type": "third_party",
"uid": "9637ae7c-337f-42ae-8d8f-3c1e346492da",
"unitPrice": 0
}
],
"reference": "ref_test_checkout_ent_1",
"uid": "CHK:02RH4B42JS9AULEHX0"
},
"data": {
"customer": {
"email": "[email protected]",
"identification": "12123123",
"name": "Demo Gire"
},
"entity": {
"name": "Mi Ready",
"uid": "myready"
},
"payment": {
"created": "2023-01-09T03:18:36.589Z",
"currency": {
"code": "TEST",
"locale": "es",
"symbol": "T$",
"text": "Test Money"
},
"description": "Descripción de la Venta",
"id": "QL18TN2SG5ETDMAEFMP951",
"operation": {
"type": "payment.v2"
},
"reference": "ref_test_checkout_ent_1",
"riskAnalysis": {
"band": "N/A",
"level": "N/A"
},
"source": {
"cardholder": {
"identification": "12123123",
"name": "Demo"
},
"expiration": {
"month": "12",
"year": "34"
},
"installment": {
"amount": 10,
"count": 1,
"description": "Débito",
"reference": "1"
},
"name": "Visa Débito",
"number": "450799******0010",
"reference": "visa.debit",
"transaction": {
"authorizationCode": "869348355213",
"batchNo": "",
"resultCode": "0",
"retrievalReferenceNo": "",
"ticketNo": "740135094293",
"transactionId": "QL18TN2SG5ETDMAEFMP951"
},
"type": "card"
},
"status": {
"code": "400",
"data": {},
"message": "Estado 400",
"resultCode": "0",
"text": "Rechazado",
"view": "default"
},
"total": 10,
"updated": "2023-01-09T03:18:47.212Z"
},
"result": true,
"source": {
"name": "Visa Débito",
"reference": "visa.debit",
"type": "card"
},
"user": {
"email": "[email protected]",
"name": "Demo Gire"
},
"view": {
"type": "card"
}
},
"status": {
"code": 401
}
},
"type": "checkout:expired"
}Este webhook especial NO será enviado cuando haya una operación en los siguientes estados:
- 200
- 3
- 210
- 300
- 301
- 2
- 100
WebhooksType Parameter
Se debe utilizar este parámetro para limitar los Webhooks recibidos, por ejemplo cuando sólo querramos ser notificados cuando una operación llegue a un estado final pero no cuando haya intentos infructuosos de pago.
Opciones de Tipo de Webhook:
- all: Esta es la opción por defecto y el servicio enviará todo intento de transacción que realice el cliente durante el pago del Checkout.
- final: Aquí sóolo se enviarán Webhooks cuando el cliente llegue a un estado final, como un pago Aprobado. Todo el resto de los estados no será enviado aunque el estado del checkout será enviado en el Webhook de Expiración o Vencimiento tratado antes. Estados que serán notificados: 200, 3, 300, 301, 2.
- intermediateAndFinal: A la opción anterior seran enviados los estados intermedios, por ejemplo una operación en revisión por fraude. Estados adicionales al tipo "final" que serán enviados: 100, 210.
- none: En esta opción ningún Webhook será enviado incluso si se define la url del checkout. Solo utilizar esta opción en casos especiales. Si utiliza esta opción deberá obtener el estado del checkout via API utilizando el "reference" definido.
Si el checkout expira y la operación cambia de estado, por ejemplo de "En Espera (2)" a "Rechazado (400)" la notificación será enviada en los tipos "all", "final" e "intermediateAndFinal", sólo no será enviado en el tipo "none"
- IDstringrequiredDescription
- x-api-keystringrequiredDescription
- x-access-tokenstringrequiredDescription
fetch("https://api.bdp.gire.com/p/checkout/EC27WUC5YH5MHT0J9I", {
"method": "GET",
"headers": {
"Accept": "application/json",
"x-api-key": "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj",
"x-access-token": "d31f0721-2f85-44e7-bcc6-15e19d1a53cc"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});{
"name": "Cake's name",
}