Crear un objeto Payment

POST /v3/payment/

Ambiente	URL base API	Portal de comercio
Sandbox	https://api.virtualpos-sandbox.com	comercios.virtualpos-sandbox.com
Producción	https://api.virtualpos.cl	comercios.virtualpos.cl

Headers

Nombre	Tipo	Requerido	Descripción
Content-Type	string	No	Por defecto: application/json.
Authorization	string	Sí	API KEY del comercio
Signature	string	Sí	Firma del mensaje

Body

Campo	Tipo	Requerido	Descripción
amount	integer (int32)	Sí	Monto de la transacción, total a pagar por el cliente.
email	string	Sí	Correo electrónico del cliente.
social_id	string	Sí	Identificador social del cliente. Para Chile utilizar RUT
first_name	string	Sí	Nombre del cliente pagador.
last_name	string	Sí	Apellido del cliente pagador
phone	string	Sí	Teléfono, formato 569NNNNNNNN
description	string	Sí	Breve descripción del pago
merchant_internal_code	string	No	Identificador de su negocio que representa el pago, ejemplo: número de pedido, factura, etc.
merchant_internal_channel	string	No	Nombre del canal del pago utilizado por su negocio: Portal, App, etc.
return_url	string	No	URL de retorno al finalizar el pago, debe estar codificada en Base64
callback_url	string	No	URL Webhook, debe estar codificada Base64
rule_set_uuid	string	No	Identificador de la regla(ruleset) que se utilizará para evaluar los medios de pago a desplegar en el checkout.

Ejemplo de request

curl -X POST 'https://api.virtualpos-sandbox.com/v3/payment/' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE" \
  -d '{
  "amount": 0,
  "email": "<email>",
  "social_id": "<social_id>",
  "first_name": "<first_name>",
  "last_name": "<last_name>",
  "phone": "<phone>",
  "description": "<description>",
  "merchant_internal_code": "<merchant_internal_code>",
  "merchant_internal_channel": "<merchant_internal_channel>",
  "return_url": "<return_url>",
  "callback_url": "<callback_url>",
  "rule_set_uuid": "<rule_set_uuid>"
}'

Respuestas

200 OK

{
  "status": "OK",
  "code": 200,
  "commerce": {
    "commerce_id": "76123456-7",
    "name": "Comercial Andes"
  },
  "payment": {
    "client": {
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "social_id": "12345678-9",
      "phone": "56961934502"
    },
    "order": {
      "uuid": "57276136aad3ecad",
      "status": "pendiente",
      "created_at": "2023-01-30 23:48:48",
      "card_number": "",
      "authorized_at": "",
      "auth_code": "",
      "installment_amount": "",
      "installment_number": "",
      "payment_type_code": "",
      "amount": 9990,
      "merchant_internal_code": "OC_TEST_1234",
      "merchant_internal_channel": "portal_pagos",
      "deposits": []
    }
  },
  "url_redirect": "https://pay.virtualpos-sandbox.com/preview/57276136aad3ecad"
}

400 Bad Request

{
  "status": "NOK",
  "code": 400,
  "error": {
    "error_code": "E-###",
    "message": "detalle del error",
    "doc_url": "https://virtualpos.readme.io/reference/objeto-error"
  }
}