Pago

Se identifica como pago, a una transacción realizada por el usuario dentro de una sesión de pago.

Reembolsos

El endpoint de reembolsos permite revertir una transacción aprobada. Ver más en Reembolsos

POST/api/reverse

Reembolsar pago

Permite reembolsar un pago aprobado con el código de referencia interna internalReference.

Solicitud

  • Name
    auth
    Type
    Authentication
    is Required
    REQUIRED
    Description

    La autenticación del sitio. Ver más en Autenticación

  • Name
    internalReference
    Type
    integer
    is Required
    REQUIRED
    Description

    Referencia interna única de la transacción

    Ejemplo:543423
  • Name
    amount
    Type
    Amount
    is optional
    Description

    Información del monto a cobrar. Esta propiedad se envía cuando se desea realizar un reembolso con un valor menor al monto total de la transacción.

Solicitud

POST
/api/reverse
curl -X "POST" https://checkout-test.placetopay.com/api/session/000000 \
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login": "aabbccdd1234567890aabbccdd123456",
        "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
        "nonce": "NjE0OWVkODgwYjNhNw==",
        "seed": "2021-09-21T09:34:48-05:00"
    },
    "internalReference": 1
}'

Respuesta

OK

  • Name
    status
    Type
    Status
    is optional
    Description

    Estructura que contiene la información de la respuesta sobre una solicitud o pago, e informa el estado actual de la misma.

  • Name
    payment
    Type
    PaymentResponse
    is optional
    Description

Respuesta

{
    "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Aprobada",
        "date": "2021-12-07T16:01:19-05:00"
    },
    "payment": {
        "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Aprobada",
        "date": "2021-12-07T16:01:18-05:00"
        },
        "internalReference": 1,
        "paymentMethod": "visa",
        "paymentMethodName": "Visa",
        "issuerName": "JPMORGAN CHASE BANK, N.A.",
        "amount": {
        "from": {
            "currency": "USD",
            "total": 100
        },
        "to": {
            "currency": "USD",
            "total": 100
        },
        "factor": 1
        },
        "authorization": "123456",
        "reference": "12345",
        "receipt": "230955511860",
        "franchise": "PS_VS",
        "refunded": false,
        "processorFields": [
        {
            "keyword": "merchantCode",
            "value": "1465675",
            "displayOn": "none"
        },
        {
            "keyword": "terminalNumber",
            "value": "00990099",
            "displayOn": "none"
        },
        {
            "keyword": "credit",
            "value": {
            "code": "1",
            "type": "00",
            "groupCode": "C",
            "installments": 1
            },
            "displayOn": "none"
        },
        {
            "keyword": "totalAmount",
            "value": 52,
            "displayOn": "none"
        },
        {
            "keyword": "interestAmount",
            "value": 0,
            "displayOn": "none"
        },
        {
            "keyword": "installmentAmount",
            "value": 0,
            "displayOn": "none"
        },
        {
            "keyword": "iceAmount",
            "value": 0,
            "displayOn": "none"
        },
        {
            "keyword": "bin",
            "value": "411111",
            "displayOn": "none"
        },
        {
            "keyword": "expiration",
            "value": "1223",
            "displayOn": "none"
        },
        {
            "keyword": "lastDigits",
            "value": "1111",
            "displayOn": "none"
        },
        {
            "keyword": "id",
            "value": "a10fe0690cfe557283310ba90746e159",
            "displayOn": "none"
        },
        {
            "keyword": "b24",
            "value": "00",
            "displayOn": "none"
        }
        ]
    }
}
POST/api/transaction

Acciones de transacción

Permite realizar operaciones básicas de preauthorización como checkout, reauthorization, (No aplica para Puerto Rico) por otro lado también permite revertir un pago aprobado con el código de referencia interna reverse.

Solicitud

Estructura que permite realizar solicitudes de preauthorización como checkout, reauthorization y reverse

  • Name
    auth
    Type
    Authentication
    is Required
    REQUIRED
    Description

    La autenticación del sitio. Ver más en Autenticación

  • Name
    action
    Type
    string
    is Required
    REQUIRED
    Description

    Tipo de operación a realizar sobre la transacción

    reverse para reembolsar una transacción.
    reauthorization para modificar una transacción de checkin.
    checkout para cerrar y cobrar una transacción de checkin.

    Valores permitidos:checkoutreauthorizationreverse
    Ejemplo:checkout
  • Name
    internalReference
    Type
    integer
    is Required
    REQUIRED
    Description

    Referencia interna única de la transacción

    Ejemplo:543423
  • Name
    amount
    Type
    Amount
    is optional
    Description

    Información del monto a cobrar

Solicitud

POST
/api/transaction
curl -X "POST" https://checkout-test.placetopay.com/api/transaction \
    -H "Content-Type: application/json" \
    -d "{
        "auth": {
            "login": "aabbccdd1234567890aabbccdd123456",
            "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
            "nonce": "NjE0OWVkODgwYjNhNw==",
            "seed": "2021-09-21T09:34:48-05:00"
        },
        "internalReference": 640,
        "amount": {
            "currency": "USD",
            "total": "500"
        },
        "action": "checkout"
    }"

Respuesta

OK

  • Name
    reference
    Type
    string
    is Required
    REQUIRED
    Description

    Referencia única del pago. compuesta por hasta 32 caracteres alfanuméricos y símbolos permitidos EJ: PAYMENT_0001_ABC, Venta_1234-ABCD#2024/03/15$500, Ord: 1001/2023

    Ejemplo:PAYMENT_0001_ABC
  • Name
    description
    Type
    string
    is Required
    REQUIRED
    Description

    Descripción del proceso a realizar, permitiendo hasta 250 caracteres alfanuméricos, acentuados y símbolos comunes.

    Ejemplo:Cita con el Dr. Pérez a las 10:00 am. 5/12/2024, por $100.00
  • Name
    amount
    Type
    Amount
    is Required
    REQUIRED
    Description

    Información del monto a cobrar

  • Name
    allowPartial
    Type
    boolean
    is optional
    Description

    Define si el monto a ser cobrado puede ser pagado en varias transacciones. Cuando es true el usuario podrá completar el pago en varias transacciones.

    Valor por defecto:false
  • Name
    shipping
    Type
    Person
    is optional
    Description

    Estructura para relacionar información de envío.

  • Name
    items
    Type
    array[Item]
    is optional
    Description

    Estructura para relacionar productos o artículos en el proceso.

  • Name
    fields
    Type
    array[NameValuePair]
    is optional
    Description

    Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales

  • Name
    recurring
    Type
    object
    is optional
    Description

    Estructura para indicar la frecuencia de un cobro recurrente.

  • Name
    subscribe
    Type
    boolean
    is optional
    Description

    Cuando se envía true, se genera una sesión de pago con suscripción.

    En el proceso de pago, el usuario puede elegir si quiere o no guardar su medio de pago para que sea usado en futuros cobros.

    Valor por defecto:false
  • Name
    dispersion
    Type
    array[DispersionDetail]
    is optional
    Description

    Cuando se define, se genera una sesión de pago con dispersión. El pago generado puede ser dividido en diferentes destinos según las condiciones dadas.

  • Name
    modifiers
    Type
    array[Modifiers]
    is optional
    Description

    Estructura para definir modificadores en el cobro.

    Aplica para leyes de impuestos en paises especificos.

  • Name
    processorFields
    Type
    array[NameValuePair]
    is optional
    Description

    Estructura que puede variar en el tiempo según la información disponible para el medio de pago. Ver más en Datos de procesamiento


Respuesta

{
    "reference": "12345",
    "description": "Prueba de pago",
    "amount": {
        "currency": "COP",
        "total": 2000,
        "taxes": [
        {
            "kind": "valueAddedTax",
            "amount": 1000,
            "base": 0
        }
        ],
        "details": [
        {
            "kind": "discount",
            "amount": 1000
        }
        ]
    },
    "allowPartial": false,
    "shipping": {
        "document": "1122334455",
        "documentType": "CC",
        "name": "John",
        "surname": "Doe",
        "company": "Evertec",
        "email": "[email protected]",
        "mobile": "+5731111111111",
        "address": {
            "street": "Calle falsa 123",
            "city": "Medellín",
            "state": "Poblado",
            "postalCode": "55555",
            "country": "CO",
            "phone": "+573111111111"
        }
    },
    "items": [
        {
        "sku": "12345",
        "name": "product_1",
        "category": "physical",
        "qty": "1",
        "price": 1000,
        "tax": 0
        }
    ],
    "fields": [
        {
        "keyword": "_test_field_value_",
        "value": "_test_field_",
        "displayOn": "approved"
        }
    ],
    "recurring": {
        "periodicity": "D",
        "interval": "1",
        "nextPayment": "2019-08-24",
        "maxPeriods": 1,
        "dueDate ": "2019-09-24",
        "notificationUrl ": "https://checkout.placetopay.com"
    },
    "subscribe": false,
    "dispersion": [
        {
        "agreement": "1299",
        "agreementType": "MERCHANT",
        "amount": {
            "currency": "USD",
            "total": 200
        }
        }
    ],
    "modifiers": [
        {
        "type": "FEDERAL_GOVERNMENT",
        "code": 17934,
        "additional": {
            "invoice": "123345"
        }
        }
    ]
}