Transaction

Constituye la creación de la transacción base y negociación de los parámetros generales de interacción.

POST /transaction

Debe ser expuesta por el medio de pago digital y será invocada por payválida. A través de este método es posible crear la transacción para el intento de pago y definir la información general del pagador, monto, comercio asociado y parámetros generales del flujo como urls de redirección. El proveedor de pagos debe retornar un la confirmación de creación de la transacción así como la url a la que se redirigirá el usuario para continuar el flujo de pago.

Headers

Name	Type	Description
Accept*	String	Utilizado para definir que tipo de contenido puede procesar el cliente. El valor siempre debe ser application/json.
Content-Type*	String	Utilizado para identificar el media-type del cuerpo de la solicitud. El valor siempre debe ser application/json.
Authorization*	String	Token Oauth2 obtenido en el endpoint Oauth2 expuesto por el medio de pago digital. En caso de que el token tenga un scope, se debe definir previamente. Debe seguir el formato 'token_type access_token'.

Request Body

Name	Type	Description
buyer*	Object	Información del comprador.
transaction*	Object	Información para la creación de la transacción.
commerce*	Object	Información del comercio asociado a la transacción
session*	Object	Parámetros de la sesión de pago.
document*	String	Parte del object buyer. Número de documento del comprador.
document_type*	String	Parte del object buyer. Tipo de documento del comprador. Valores permitidos: CC, CE, PAS, VISA, NIT, DNI, CNPJ, NA, TI, RUT, DPI, DIMEX, CEDULA RESIDENCIA, CEDULA JURÍDICA, PTP, CEDULA DE IDENTIDAD, RUC.
email*	String	Parte del object buyer. Dirección de correo electrónico del comprador.
id*	String	Parte del object transaction. Identificador único de la transacción (UUIDV4).
expiration*	String	Parte del object transaction. Fecha y tiempo de expiración de la transacción (RFC3339)
description*	String	Parte del object transaction. Descripción de la transacción.
reference*	String	Parte del object transaction. Referencia de la transacción para trazabilidad.
value*	String	Parte del object transaction. Monto o valor de pago
currency*	Object	Parte del object transaction. Información de la moneda de pago.
code*	String	Parte del object currency. Código de moneda (ISO 4217).
identification_number*	String	Parte del object commerce. Número de identificación del comercio.
name*	String	Parte del object commerce. Nombre del comercio.
return_url*	String	Parte del object session. URL a la que el usuario debe ser redirigido desde el medio de pago digital.
confirmation_callback_url*	String	Parte del object session. URL del endpoint de confirmación de transacción utilizado exclusivamente para las confirmaciones asíncronas y expuesto por payválida.
oauth2*	Object	Parte del object session. Parámetros de consumo del enpoint Oauth2. El token es necesario para el consumo del endpoint de confirmación asíncrona.
url*	String	Parte del object oauth2. URL de endpoint de emisión de tokens Oauth2.
scope*	String	Parte del object oauth2. Scope necesario para consumo de endpoint de confirmación asíncrona.

200: OK Solicitud procesada correctamente

transaction* (object): Información sobre la transacción creada.

id* (string): Parte del object transaction. Identificador de la transacción recibido en la solicitud.

status* (string): Parte del object transaction. Estatus de transacción después de procesar solicitud. REJECTED, o cualquier estado distinto a CREATED, se interpreta como un rechazo de transacción y por lo tanto implica el fin del proceso de pago. Valores permitidos: CREATED, REJECTED

session* (object): Información de la sesión de pago definida por proveedor de pago.

redirection_url* (string): Parte del object session. URL a la que se debe redireccionar al usuario para iniciar el proceso de autenticación, captura de datos adicionales y exposición de términos de pago.

400: Bad Request La solicitud o los claims del token no tienen la estructura esperada.

403: Forbidden No fue posible identificar al cliente de la solicitud. Asociado a la validación y verificación del token.

404: Not Found La transacción asociada no existe o no se encuentra.

500: Internal Server Error Error del servidor al procesar la solicitud.

Request ejemplo

{
  "buyer": {
    "document": "1234567890",
    "document_type": "CC",
    "email": "[e-mail]"
  },
  "transaction": {
    "id": "0427dfac-ffd8-44f4-be96-5d442c1c1bed",
    "expiration": "2006-01-02T15:04:05Z07:00",
    "description": "Compra de zapatillas deportivas",
    "reference": "123456abcdef",
    "value": "10.25",
    "currency": {
      "code": "USD"
    }
  },
  "commerce": {
    "identification_number": "10122012334",
    "name": "Ecommerce Foobar"
  },
  "session": {
    "return_url": "https://secure-checkout.payvalida.com/foo/bar",
    "confirmation_callback_url": "https://api.payvalida.com/api/medios-digitales/v1/confirmation",
    "oauth2": {
      "url": "https://api.payvalida.com/oauht2/token",
      "scope": "MediosDigitales-Provider:write:transaction"
    }
  }
}

Response ejemplo

{
  "transaction": {
    "id": "0427dfac-ffd8-44f4-be96-5d442c1c1bed",
    "status": "CREATED"
  },
  "session": {
    "redirection_url": "https://payment.provider.com/payment?foo=bar"
  }
}