Número de cuenta del cliente de destino no válido.
400
Solicitud incorrecta
200000
Subcuenta de cliente de destino no válida.
400
Solicitud incorrecta
200000
ID de participación en el programa no válido.
400
Solicitud incorrecta
200000
Se han encontrado demasiados programas entre comerciantes.
400
Solicitud incorrecta
200000
Programa no existe entre comerciantes.
400
Solicitud incorrecta
200000
El programa está inactivo.
400
Solicitud incorrecta
200000
Simbolo no valido.
400
Solicitud incorrecta
200000
Se requiere información del cliente y de pago para la identificación de suscripción cero.
400
Solicitud incorrecta
200000
Capacidad 3DS no válida.
400
Solicitud incorrecta
200000
Algoritmo 3DS Cavv no válido.
400
Solicitud incorrecta
200000
ID de 3DS no válido.
400
Solicitud incorrecta
200000
ID trans. de 3DS Ds no válido.
400
Solicitud incorrecta
200000
ID de transacción de 3DS Acs no válido.
400
Solicitud incorrecta
200000
Los parámetros de solicitud de Threeds deben contener parámetros de verificación de 3DS o parámetros de error para que sean válidos.
400
Solicitud incorrecta
200000
Problema con el formato de dígito de atributo.
400
Solicitud incorrecta
200000
Problema con el tipo de datos.
400
Solicitud incorrecta
200000
ID de programa no válido.
400
Solicitud incorrecta
200000
Intervalo de fechas no válido.
401
No autorizado
N/A
simbolo no valido
403
Prohibido
100020
Prohibido
404
Extraviado
100101
Ficha de pago no válida.
404
Extraviado
100104
Objeto de búsqueda no encontrado.
500
Error interno del servidor
100103
Error de transacción.
500
Error interno del servidor
100105
No se pudo completar la transacción requerida para crear un token de pago.
500
Error interno del servidor
100106
Hubo un error interno, o un error de la base de datos y la acción solicitada no se pudo completar, o el enlace de datos está inactivo para el usuario.
500
Error interno del servidor
100107
La dirección IP en la que el cliente intentaba autenticarse no estaba en el rango válido.
500
Error interno del servidor
100108
La cuenta del cliente ha sido desactivada para su uso en el sistema Datalink o el cliente no puede realizar la acción solicitada.
500
Error interno del servidor
100109
El cliente ha iniciado sesión sin éxito en el sistema 3 o más veces en la última hora. El cliente debe esperar una hora antes de intentar iniciar sesión nuevamente y se le recomienda que revise la información de inicio de sesión.
500
Error interno del servidor
100110
Limitado, el número de transacciones ha alcanzado el límite.
500
Error interno del servidor
100111
Limitado, la cantidad total de dinero ha alcanzado el límite.
500
Error interno del servidor
100112
No se puede determinar si se requiere 3DS.
500
Error interno del servidor
100113
No se puede recuperar la cantidad autorizada.
Códigos de error de autenticación de 3DS
Código de estado HTTP
Tipo de estado HTTP
Código de error
Mensaje de error
500
Error interno del servidor
200000
Autorización fallida debido a un problema desconocido.
500
Error interno del servidor
200001
La autorización falló debido a una respuesta inesperada de un SCA externo.
500
Error interno del servidor
200400
La autorización falló debido a una solicitud incorrecta a un SCA de terceros.
500
Error interno del servidor
200401
La autorización falló debido a una solicitud no autorizada a un SCA de terceros.
500
Error interno del servidor
200500
No se pudo autenticar la transacción.
500
Error interno del servidor
200501
La API no pudo analizar JSON.
400
Solicitud incorrecta
200502
El token de pago no existe.
400
Solicitud incorrecta
200503
No hay tarjeta asociada con el token de pago.
500
Error interno del servidor
200600
No se pudo recuperar el estado.
500
Error interno del servidor
200601
La API no pudo analizar JSON.
404
Solicitud incorrecta
200602
ID de transacción no encontrado.
400
Solicitud incorrecta
200603
Error de validación ID de transacción UUID no válido.
400
Solicitud incorrecta
200604
El ID de correlación del error de validación no es un UUID válido.
400
Solicitud incorrecta
200605
Error de validación El formato actualizado de la transacción no es YYYY-MM-DD HH:mm:ss zzz.
API de transacciones RESTful de CCBill
Descripción
La función principal de la API RESTful de CCBill es permitir a los comerciantes crear fichas de pago y utilícelos para cobrar a los clientes.
La API RESTful de CCBill le permite aprovechar al máximo la plataforma de pago de CCBill sin utilizar CCBill formularios de pago alojados.
Con la API, solo necesita solicitar a los clientes la información de pago una vez. Para cualquier transacción posterior, puede usar sus datos tokenizados.
Puede desarrollar aplicaciones back-end y orientadas al cliente para acceder a los recursos de la API RESTful mediante programación e integrar sin problemas las soluciones de procesamiento de pagos de CCBill en los flujos de pago.
Utilice la API RESTful para ofrecer una experiencia de pago atractiva y sin fricciones, independientemente del dispositivo o la plataforma que utilice el cliente.
Cómo Empezar
Los comerciantes necesitan crear aplicaciones que capturen los datos de pago de los clientes y envíen información estructurada. Llamadas API a CCBill RESTful Puntos finales API. Las solicitudes de API deben estructurarse de acuerdo con la documentación de la API RESTful de CCBill.
Antes de proceder con el Integración de API, los comerciantes deben abrir una cuenta de procesamiento de pagos y registrar sus aplicaciones en CCBill.
1. Abra una cuenta comercial de CCBill
Si no tiene una cuenta CCBill Merchant, comuníquese con Ventas CCBill en IRS.gov o use la REGISTRATE botón en nuestro sitio web.
CCBill emplea un equipo dedicado de profesionales para ayudar a los comerciantes y garantizar que el proceso de incorporación se complete con la mínima fricción.
El Servicio de Atención al Comerciante está disponible las 24 horas del día, los 7 días de la semana y ofrece soporte técnico y administrativo completo con respecto a los servicios de CCBill.
2. Registre la aplicación con CCBill
La API de transacción RESTful de CCBill utiliza tokens de portador para autenticar y autorizar solicitudes de API. Antes de acceder a la API, debe registrar su aplicación con Servicios de soporte de CCBill.
Al registrarse, a su aplicación se le asignará un ID de aplicación de comerciante y llave secreta.
El flujo de pago
1. Generar token de portador CCBill OAuth
Utilice el ID de la aplicación del comerciante y la clave secreta para generar un token de portador al proporcionarlos al servidor de autorización.
Una vez que haya generado un Token de acceso (que no debe confundirse con un token de pago), inclúyalo en el encabezado de Autorización de cada solicitud de API.
Tenga en cuenta que este paso no se puede realizar desde el navegador y debe realizar la llamada desde su backend.
El token de acceso adquirido es una cadena de datos aleatorios que no contiene datos confidenciales ni tiene valor.
Funciona solo como una herramienta de autenticación y autorización y otorga a su aplicación acceso a la API RESTful.
Los comerciantes pueden diseñar formularios de pago personalizados y aplicaciones para capturar la información de la tarjeta de crédito del cliente.
La información de pago del cliente (como el número de tarjeta de crédito, la fecha de caducidad, el nombre en la tarjeta, etc.) debe enviarse como una solicitud de API al punto final de API correcto.
La API RESTful de CCBill utiliza los datos capturados para crear un token de pago único.
El Widget avanzado de CCBill permite a los comerciantes automatizar las solicitudes de token de pago. Los comerciantes pueden diseñar su propia interfaz para llamar al widget y generar tokens de pago.
El widget de JavaScript está alojado en una ubicación accesible para los comerciantes, lo que les permite consultar e importar el widget en sus sitios web.
Para mantener el cumplimiento de PCI en todo momento, use el widget avanzado de CCBill y asegúrese de que los detalles de pago se envíen directamente a CCBill sin que se envíen a través de su servidor. Cargue siempre las bibliotecas de JavaScript de CCBill a través de https://js.ccbill.com para seguir cumpliendo. No agrupe ni aloje los scripts usted mismo.
Después de haber generado un ficha al portador y identificador de token de pago, puede usar estos dos tokens para cargar la tarjeta de crédito del consumidor.
Envío de una solicitud de API al /actas endpoint le permite cargar un token de pago o recuperar datos en un cargo.
Una vez que se ha cargado el token de pago, un Notificación HTTP POST de webhooks se activará para que pueda capturar la información de la transacción. Este evento de webhooks será un “UpSaleÉxito.
Los objetos de la API de transacción de CCBill están formateados para seguir el formato de archivo de estándar abierto JSON (JavaScript Object Notation) y utilizan el application/json tipo de contenido.
Utilice esta lista completa de objetos de la API RESTful de CCBill para determinar qué parámetros se requieren para las solicitudes de punto final y qué parámetros se devuelven como respuestas.
Error de validacion
Elementos de la opcional errores formación. solo devuelto el 400 Bad Request errores por errores de validación.
PARÁMETRO
TIPO
DESCRIPCIÓN
campo
cadena (requerido)
El campo en error.
mensaje
cadena (requerido)
Mensaje fácil de usar.
Ejemplo de error de validación
{
"field": "string",
"message": "string"
}
Error
Respuesta si la acción falló o no se pudo completar.
El servicio CCBill Transaction API utiliza códigos de respuesta HTTP convencionales para indicar errores. Generalmente, los códigos en el rango de 4xx indicar un error debido a la información proporcionada en la solicitud. Códigos en el rango de 5xx indica un error debido a un problema inesperado.
CÓDIGO DE ERROR
DESCRIPCIÓN
400
La respuesta no se pudo completar debido a un encabezado / parámetro no válido en la solicitud.
401
La respuesta no pudo completarse debido a un problema de autorización.
403
No se pudo completar la respuesta porque el acceso al recurso está prohibido.
404
La respuesta no se pudo completar debido a un recurso no válido.
405
La respuesta no se pudo completar debido a un método de solicitud no válido.
406
La respuesta no se pudo completar debido a un tipo de medio inaceptable en la solicitud.
415
La respuesta no se pudo completar debido a un tipo de medio no compatible en la solicitud.
Parámetros para generar un token de pago para el comerciante/cliente especificado. Requiere una participación activa en el programa y permite a los comerciantes crear tokens de pago para oportunidades de venta cruzada con otros comerciantes.
El CVV2 / CVC2 / CID debe estar en la tarjeta, pero el comerciante indica que no lo está.
U
El Emisor no está certificado o no ha proporcionado a Visa claves de cifrado.
Respuestas AVS
VALOR
DESCRIPCIÓN
A
Las direcciones de las calles coinciden pero el código postal/ZIP no lo hace, o la solicitud no incluye el código postal/ZIP.
B
Coincidencia de direcciones de calles. El código postal no se verifica debido a formatos incompatibles (se enviaron tanto la dirección como el código postal).
C
La dirección postal y el código postal no se verificaron debido a formatos incompatibles. (tanto la dirección como el código postal fueron enviados)
D
Las direcciones y los códigos postales coinciden
F
La dirección y el código postal coinciden. (Tarjetas emitidas en el Reino Unido)
G
El emisor no es un participante de AVS, o los datos de AVS estaban presentes en la solicitud, pero el emisor no devolvió un resultado de AVS, o Visa realiza AVS en nombre del emisor y no había un registro de dirección en el archivo de esta cuenta.
O
La información de la dirección no está verificada.
M
La dirección y el código postal coinciden.
N
No coincide. La transacción contenía solo código postal / postal, o solo dirección de calle, o código postal y dirección de calle. También se usa cuando la transacción solicita AVS pero no envía datos AVS.
P
Los códigos postales coinciden. Se enviaron el código postal y la dirección postal, pero la dirección postal no se verificó debido a formatos incompatibles.
R
Rever; El sistema no está disponible o se agotó el tiempo de espera.
S
AVS actualmente no es compatible
U
No hay datos de la plataforma de Emisor / Autorización
V
Coincidencias de código postal de nueve caracteres; la dirección no coincide
X
Coincidencia de código postal y dirección de nueve caracteres
Y
Coincidencia de dirección y código postal
Z
Postal / ZIP coincide, la dirección postal no coincide o la dirección postal no se incluye en la solicitud.
1
El nombre del titular de la tarjeta y el código postal coinciden
2
El nombre, la dirección y el código postal del titular de la tarjeta coinciden
3
El nombre y la dirección del titular de la tarjeta coinciden
4
Coincidencias con el nombre del titular de la tarjeta
5
El nombre del titular de la tarjeta es incorrecto, el código postal coincide
6
Nombre del titular de la tarjeta incorrecto; coincidencia de dirección y código postal
7
El nombre del titular de la tarjeta es incorrecto, la dirección coincide
8
El nombre, la dirección y el código postal del titular de la tarjeta no coinciden
Este documento describe los recursos y puntos finales del servicio API RESTful de CCBill Transaction. Está destinado a programadores, técnicos y otras personas con conocimientos avanzados de codificación.
La API de transacción RESTful de CCBill permite a los comerciantes crear tokens de pago y usarlos para cobrar a los clientes.
Recursos de la API
La URL base de la API es https://api.ccbill.com y proporciona los puntos finales enumerados a continuación.
Los objetos de la API de transacción de CCBill están formateados para seguir el formato de archivo de estándar abierto JSON (JavaScript Object Notation) y utilizan el aplicación / json tipo de contenido.
NOMBRE DEL ENCABEZADO
TIPO DE CONTENIDO
Content-Type
aplicación / json
Con cada solicitud POST, proporcione el tipo de medio del cuerpo de la solicitud como un encabezamiento.
Los posibles valores de versión de la API incluyen:
Preste especial atención a la versión en la ruta URI, ya que el número de versión afecta los tipos de datos del esquema.
/ fichas de pago
Use el / fichas de pago recurso para crear un token que identifique a un usuario en el sistema. El token se puede pasar al sistema en una solicitud de transacción, lo que le permite facturar a un cliente.
SUB-RECURSO
MÉTODO
DESCRIPCIÓN
/solo para comerciantes
PUBLICAR
Genera un token de pago para un comerciante/cliente específico.
/comerciante-solo-verificar
PUBLICAR
Genera un token de pago para un comerciante/cliente específico. Se requiere CVV2 para transacciones con tarjeta.
/{pagoTokenId}
Recupera los detalles del token de pago especificado (timeToLive, fecha de creación, etc.).
/tres-requerido
Recupera si se requiere o no 3DS/SCA para una determinada tarjeta de crédito.
/{pagoTokenId}/tres-requerido
Recupera si se requiere o no 3DS/SCA para un token de pago.
/programa-especificado
PUBLICAR
Genera un token de pago para el participante del programa especificado.
/cliente-objetivo
PUBLICAR
Genera un token de pago para el comerciante/cliente especificado. Requiere participación activa en el programa.
/ fichas-de-pago / solo-comerciante
Punto final utilizado para crear un token de pago.
La solicitud se ha realizado correctamente. Extrae el ID de token de pago cadena para crear un cargo para el cliente.
Nota: en PaymentTokenVerifyV2 ID de suscripción se devuelve como una cadena. En el ejemplo v1 a continuación, ID de suscripción se vuelve a sintonizar como un número / entero.
La URL RELATIVA que ha causado este error. Ejemplo: "/ programas / 123"
errores
ValidationError [objeto]
Opcional, solo se devuelve en 400 errores de solicitud incorrecta por errores de validación
errores. Campo requerido)
cadena
Campo en error
errores. mensaje requerido)
cadena
Mensaje descriptivo
generalMessage (obligatorio)
cadena
Un mensaje legible por humanos
errorCode (obligatorio)
cadena
Código de error definido por el producto. Patrón de validación: ^ [0-9 -] * $
marca de tiempo (obligatorio)
datetime
Marca de tiempo de la llamada
/ fichas-de-pago / solo-comerciante-verificar
El recurso se utiliza para mejorar la autenticación durante la creación del token de pago. Este punto final incluye cvvRespuesta y avsRespuesta parámetros en la respuesta. Estos parámetros ayudan a reducir las tasas de devolución de cargo para los comerciantes.
La URL RELATIVA que ha causado este error. Ejemplo: "/ programas / 123"
errores
ValidationError [objeto]
Opcional, solo se devuelve en 400 errores de solicitud incorrecta por errores de validación
errores. Campo requerido)
cadena
Campo en error
errores. mensaje requerido)
cadena
Mensaje descriptivo
generalMessage (obligatorio)
cadena
Un mensaje legible por humanos
errorCode (obligatorio)
cadena
Código de error definido por el producto. Patrón de validación: ^ [0-9 -] * $
marca de tiempo (obligatorio)
datetime
Marca de tiempo de la llamada
/tokens-de-pago/cliente-objetivo
Este punto final genera un token de pago para el comerciante/cliente especificado.
Requiere una participación activa en el programa y permite a los comerciantes crear tokens de pago para oportunidades de venta cruzada con otros comerciantes.
La solicitud se ha realizado correctamente. Extrae el ID de token de pago cadena para crear un cargo para el cliente.
Nota: en PaymentTokenVerifyV2 ID de suscripción se devuelve como una cadena. En el ejemplo v1 a continuación, ID de suscripción se vuelve a sintonizar como un número / entero.
La URL RELATIVA que ha causado este error. Ejemplo: "/ programas / 123"
errores
ValidationError [objeto]
Opcional, solo se devuelve en 400 errores de solicitud incorrecta por errores de validación
errores. Campo requerido)
cadena
Campo en error
errores. mensaje requerido)
cadena
Mensaje descriptivo
generalMessage (obligatorio)
cadena
Un mensaje legible por humanos
errorCode (obligatorio)
cadena
Código de error definido por el producto. Patrón de validación: ^ [0-9 -] * $
marca de tiempo (obligatorio)
datetime
Marca de tiempo de la llamada
/pago-tokens/programa-especificado
Este punto final permite a los comerciantes generar tokens de pago para oportunidades de venta cruzada con otros participantes específicos del programa (comerciantes).
La solicitud se ha realizado correctamente. Extrae el ID de token de pago cadena para crear un cargo para el cliente.
Nota: en PaymentTokenVerifyV2 ID de suscripción se devuelve como una cadena. En el ejemplo v1 a continuación, ID de suscripción se vuelve a sintonizar como un número / entero.
La URL RELATIVA que ha causado este error. Ejemplo: "/ programas / 123"
errores
ValidationError [objeto]
Opcional, solo se devuelve en 400 errores de solicitud incorrecta por errores de validación
errores. Campo requerido)
cadena
Campo en error
errores. mensaje requerido)
cadena
Mensaje descriptivo
generalMessage (obligatorio)
cadena
Un mensaje legible por humanos
errorCode (obligatorio)
cadena
Código de error definido por el producto. Patrón de validación: ^ [0-9 -] * $
marca de tiempo (obligatorio)
datetime
Marca de tiempo de la llamada
/actas
Utilice el extremo Transacciones para crear un cargo para un cliente existente o nuevo, o para recuperar datos sobre un cargo.
Un cargo puede representar una transacción en los detalles de facturación de un cliente por parte de un patrocinador, en función de un token obtenido de un afiliado que identifica a uno de sus clientes.
Subrecurso utilizado para facturar a un cliente o recuperar detalles sobre un cargo.
/transacciones/pago-tokens/{pago_token_id}/tres
PUBLICAR
Subrecurso utilizado para facturar a un cliente o recuperar detalles sobre un cargo con verificación 3DS.
El OBTENER / transacciones / fichas-de-pago / {payment_token_id} La llamada API permite a los comerciantes recuperar detalles sobre un cargo que se realizó en el sistema.
Use el POST / transacciones / tokens-de-pago / {payment_token_id} Llamada API para facturar a un cliente.
El POST / transacciones / tokens-de-pago / {payment_token_id} La llamada API creará una solicitud de transacción para un cliente.
El cliente se identifica mediante un token que se obtiene de un afiliado. Si el token es de corta duración y esta es la primera facturación para este cliente, se devuelve un token de mayor duración.
Proporcione el ID del token de pago como Parámetro URI.
El usuario ha incluido su dominio en la lista blanca con la ayuda de Soporte CCBill.
El usuario tiene experiencia con RESTful Web Services.
El usuario tiene experiencia con formatos JSON.
La API de transacciones RESTful solo admite TLS 1.2.
Importante: Para mantener el cumplimiento de PCI en todo momento, use el widget avanzado de CCBill y asegúrese de que los detalles de pago se envíen directamente a CCBill sin que se envíen a través de su servidor. Cargue siempre las bibliotecas de JavaScript de CCBill a través de https://js.ccbill.com para seguir cumpliendo. No agrupe ni aloje los scripts usted mismo.
Terminología
Cuenta comercial: Cada comerciante de CCBill recibe un número de cuenta con fines de seguimiento. El formato estándar es 9xxxxx-xxxx, donde 9xxxxx es la cuenta principal. La cuenta principal es un número de seis (6) dígitos. Por ejemplo: "999999".
Subcuenta comercial: Los comerciantes de CCBill pueden abrir una o más subcuentas. La subcuenta es un número de cuatro (4) dígitos. El formato estándar es: xxxx. Por ejemplo: "1234". La subcuenta es parte de la cuenta principal.
Ficha de pago: Un token de pago identifica una entidad facturable dentro del sistema.
Identificación de suscripción: Número de identificación de la suscripción a la transacción
Identificación de la aplicación del comerciante: Esta es la ID de cliente que el comerciante recibió al registrarse para usar la API RESTful de CCBill.
Secreto del comerciante: Esta es la contraseña que se configuró para la autenticación con la API RESTful de CCBill.
Autenticación fuerte del cliente (SCA): leyes europeas (PSD2) requieren el uso de SCA, como el 3DS protocolo, para el procesamiento de pagos en línea. La SCA se inicia cuando un titular de tarjeta con sede en la UE realiza un pago en línea. Los comerciantes pueden usar el Widget avanzado de CCBill y sus funciones para facilitar una fuerte autenticación del cliente.
El flujo de pago
A continuación se detallan los 3 pasos esenciales para cobrar al consumidor mediante un token de pago:
1. Genere el token de portador CCBill OAuth
La solicitud para generar el token CCBill OAuth debe enviarse desde sus servicios back-end directamente a la API de CCBill y no puede solicitarse desde el navegador.
2. Crear el token de pago
3. Cobrar el token de pago
El siguiente diagrama de secuencia describe el flujo para crear y cobrar tokens de pago sin verificación 3DS. Haga clic en la imagen para verla en tamaño completo.
Si bien todos los pasos anteriores se pueden completar realizando solicitudes desde su backend a nuestros puntos finales de API, también puede usar el Widget avanzado de CCBill (biblioteca JS) a:
crear los tokens de pago
comprobar si se requiere la verificación 3DS o no, y
realizar una autenticación fuerte del cliente (SCA) desde el navegador
El siguiente diagrama de secuencia describe el flujo para crear y cargar tokens de pago con verificación 3DS. Haga clic en la imagen para verla en tamaño completo.
Creación de la CCBill OAuth token y tokens de pago de carga no son compatibles con el Widget avanzado de CCBill y debe realizarse haciendo llamadas a la API desde sus servicios de back-end.
1. Generar token de portador CCBill OAuth
La API de transacción RESTful de CCBill utiliza OAuth autenticación y autorización basadas. Antes de acceder a la API, debe registrar su aplicación con CCBill para recibir un ID de aplicación de comerciante y llave secreta.
Utilice estas credenciales para generar un token al proporcionarlas al servidor de autorización.
Tenga en cuenta que este paso no se puede realizar desde el navegador y debe realizar la llamada desde su backend.
Una vez que haya generado un token de acceso (que no debe confundirse con un token de pago), proporciónelo en el encabezado de Autorización de cada solicitud de API. Tendrá acceso hasta que el token de acceso caduque o sea revocado.
El token adquirido es una cadena de datos aleatorios que no contiene información o valor confidencial. Es una herramienta de autenticación y autorización que otorga a sus aplicaciones acceso a los recursos de la API RESTful de CCBill.
Ejemplo de token de portador en el encabezado de la solicitud
2. Crear token de pago (Widget avanzado de CCBill)
El Widget avanzado de CCBill facilita la creación de tokens de pago al encapsular las llamadas API que deben realizarse en una función de JavaScript que se puede usar desde su página web.
La biblioteca está alojada en la red de distribución de contenido (CDN) de CCBill, lo que hace que la importación a los sitios web de los comerciantes sea rápida y sencilla desde cualquier lugar del mundo.
Las siguientes instrucciones describen cómo configurar y utilizar el Widget avanzado de CCBill biblioteca.
Paso 1. Agregar enlace precargado y elementos HTML
Agregue un enlace precargado y elementos HTML de secuencia de comandos a la página HTML del cliente que se conectará al widget avanzado de CCBill.
La versión de API en este ejemplo de URI es v1.2.2. Preste especial atención a la versión en la ruta URI ya que el número de versión puede estar sujeto a cambios.
Paso 2. Definir ID de campo
El widget avanzado puede extraer los campos de formulario relevantes basándose en los atributos de ID predeterminados o utilizando el atributo de elemento HTML personalizado data-ccbill. El data-ccbill Se recomienda el atributo ya que es menos intrusivo y proporciona más flexibilidad.
Cuando se usa el atributo personalizado, el formato correcto es:
Formato
<input type="text" data-ccbill="[corresponding field name]" />
Cuando se utilizan los ID predeterminados, el formato correcto es:
<input type="text" id="_ccbillId_[corresponding field name]" />
La tabla muestra los valores que se deben establecer para el data-ccbill atributo o, alternativamente, en los campos de atributos de ID predeterminados.
data-ccbill
ID predeterminados
nombre en la tarjeta
_ccbillId_nameOnCard
número de tarjeta
_ccbillId_cardNumber
expMes
_ccbillId_expMonth
expaño
_ccbillId_expYear
nombre de pila
_ccbillId_nombre
apellido
_ccbillId_apellido
address1 (opcional)
_ccbillId_dirección1 (opcional)
address2 (opcional)
_ccbillId_dirección2 (opcional)
ciudad (opcional)
_ccbillId_ciudad (opcional)
país
_ccbillId_país
estado (opcional)
_ccbillId_estado (opcional)
código postal
_ccbillId_postalCode
número de teléfono (opcional)
_ccbillId_phoneNumber (opcional)
correo electrónico,
_ccbillId_email
código de moneda (Un código de moneda de tres dígitos para la moneda utilizada en la transacción. Obligatorio para SCA).
_ccbillId_currencyCode (Un código de moneda de tres dígitos para la moneda utilizada en la transacción. Obligatorio para SCA).
dirección IP (opcional, campo oculto recomendado autocompletado por JavaScript)
_ccbillId_ipAddress (opcional, campo oculto recomendado autocompletado por JavaScript)
navegadorHttpAceptar (opcional, campo oculto recomendado autocompletado por JavaScript)
_ccbillId_browserHttpAceptar (opcional, campo oculto recomendado autocompletado por JavaScript)
browserHttpAcceptEncoding (opcional, campo oculto recomendado autocompletado por javascript)
_ccbillId_browserHttpAcceptEncoding (opcional, campo oculto recomendado autocompletado por javascript)
navegadorHttpAceptarIdioma (opcional, campo oculto recomendado autocompletado por javascript)
_ccbillId_browserHttpAceptarIdioma (opcional, campo oculto recomendado autocompletado por javascript)
Paso 3. Crear método JavaScript
Cree un método de JavaScript que llamará al widget avanzado de CCBill crearPagoToken() función. El ejemplo proporcionado se puede modificar según sea necesario.
Esta es la función principal que los comerciantes deben incorporar en sus llamadas de JavaScript para crear Tokens de pago.
Para generar un token, se deben pasar varios parámetros mediante la función:
PARÁMETRO
TIPO
DESCRIPCIÓN
token de autorización
cadena (requerido)
Entrada requerida que utiliza un token de Oauth para realizar la creación del token de pago. Debe ser un token de Oauth válido para la cuenta de cliente proporcionada.
clienteAccnum
entero (requerido)
Número de cuenta mercantil.
clienteSubacc
entero (requerido)
Número de subcuenta de comerciante.
clearPaymentInfo
booleano (opcional)
Un indicador opcional que, si se establece en verdadero, dará como resultado la eliminación de los campos de información del cliente cuando el crear el token de pago se llama a la función. Si nulo se proporciona, por defecto será falso y los campos de información de pago no se borrarán.
Nota: Aunque este parámetro es opcional, este campo debe establecerse en 'nulo' si no se usa.
clearCustomerInfo
booleano (opcional)
Un indicador opcional que, si se establece en verdadero, dará como resultado la eliminación de los campos de información del cliente cuando el crear el token de pago se llama a la función. Si nulo se proporciona, por defecto será falso y los campos de información del cliente no se borrarán.
Nota: Aunque este parámetro es opcional, este campo debe establecerse en 'nulo' si no se usa.
tiempo para vivir
entero (opcional)
El intervalo de tiempo que define cuánto tiempo debe ser válido el token (horas).
numeroDeUso
entero (opcional)
Número total de veces que se puede usar el token de pago para compras.
Nota: Aunque este parámetro es opcional, este campo debe establecerse en 'nulo' si no se usa.
const result = widget.createPaymentToken(oauthToken, clientAccnum, clientSubacc);
Uso de indicadores de limpieza de campo
const result = widget.createPaymentToken(oauthToken, clientAccnum, clientSubacc, clearPaymentInfo, clearCustomerInfo);
Usando numberOfUse y timeToLive pero sin banderas
const result = widget.createPaymentToken(oauthToken, clientAccnum, clientSubacc, null, null, timeToLive, numberOfUse);
Uso de todos los parámetros
const result = widget.createPaymentToken(oauthToken, clientAccnum, clientSubacc, clearPaymentInfo, clearCustomer, timeToLive, numberOfUse);
Paso 4. Token de pago generado
El resultado contendrá el token de pago recién creado, que se puede convertir en JSON.
En caso de cualquier entrada no válida, la respuesta incluirá errores de validación que se encontraron durante la validación de la entrada.
También puede incluir cualquier error que haya ocurrido durante el proceso de generación del token de pago.
Validación de datos de campo
El crear el token de pago La función validará los valores de los campos. Si alguno de los valores no pasa la validación, no se creará ningún token. Si ese es el caso, el sistema generar una matriz de violaciones indicando qué campos no son válidos.
PARÁMETRO
TIPO
REQUISITO
clienteAccnum
entero (requerido)
Número de cuenta mercantil. Un rango entre 90000 y 999999 y debe ser un número.
clienteSubacc
entero (requerido)
Número de subcuenta de comerciante. Un rango de 0-9999 y debe ser un número.
tiempo para vivir
entero (opcional)
Tiene un rango de 0-2147483647 y debe ser un número. Si se desea el valor máximo, omita esto (o pase nulo).
numeroDeUso
entero (opcional)
El número total de veces que se puede usar el token de pago para compras. Tiene un rango de 0-2147483647 y debe ser un número. Si se desea el valor máximo, omita esto (o pase nulo).
número de tarjeta
cadena (requerido)
Debe ser un número de tarjeta de crédito válido.
expMes
cadena (requerido)
Mes de caducidad de la tarjeta en mm formato. Se requiere un rango de 1-12, y debe ser un número.
expaño
cadena (requerido)
Año de caducidad de la tarjeta en aaaa formato. Se requiere un rango de 2018-2100, y debe ser un número.
nombre de pila
cadena (requerido)
Nombre del cliente.
apellido
cadena (requerido)
Apellido del cliente.
address1
cadena (opcional)
Dirección del cliente.
ciudad
cadena (opcional)
Ciudad del cliente.
país
cadena (requerido)
País del cliente. Debe estar representado como un código de país de dos letras como se define en ISO-3166 1.
estado
cadena (opcional)
Estado del cliente. Si se proporciona, debe ser un código de estado de dos letras como se define en ISO-3166 2.
código postal
cadena (requerido)
Código postal del cliente. Es un código postal válido para el país proporcionado.
número de teléfono
cadena (opcional)
Número de teléfono del cliente. Si se proporciona, debe ser un número de teléfono válido.
correo electrónico,
cadena (requerido)
Dirección de correo electrónico del cliente.
dirección IP
cadena (opcional)
Dirección IP del cliente.
La matriz de violaciones es un objeto del siguiente objeto:
En este momento, la página del cliente deberá resolver cualquier error, mostrar el mensaje correcto en el que los campos no eran válidos o usar el nuevo token de pago provisto.
Autenticación fuerte del cliente
CCBill Advanced Widget también permite a los comerciantes integrarse con el proveedor 3DS de CCBill e incorporar una fuerte autenticación de clientes en sus transacciones.
Como alternativa, los comerciantes pueden enviar los resultados de SCA (3DS) obtenidos de un proveedor de 3DS de su elección. Para iniciar cargos con un token de pago, los parámetros SCA deben enviarse junto con otros parámetros obligatorios.
isScaFunción requerida
El isScaRequerido determina si se necesita una fuerte autenticación del cliente. El sistema verifica el número de tarjeta de crédito, el número de cuenta del comerciante, el número de subcuenta y el código de moneda proporcionados.
Una entrada válida da como resultado una Promesa, que eventualmente se resolverá en una respuesta con parámetros SCA o se convertirá en un rechazo, debido a un error.
Ejemplo
const result = widget.isScaRequired(authToken, clientAccnum, clientSubacc);
PARÁMETRO
TIPO
DESCRIPCIÓN
token de autorización
cadena (requerido)
Debe ser un token de Oauth válido para la cuenta de comerciante proporcionada.
clienteAccnum
entero (requerido)
Número de cuenta mercantil.
clienteSubacc
entero (requerido)
Número de subcuenta de comerciante.
El formulario de pago del comerciante debe contener un campo de entrada de texto (oculto si es necesario) o un elemento de selección (oculto si es necesario) para el código de moneda valor. El valor representa un código de moneda de tres dígitos (norma ISO 4217) para la moneda utilizada en la transacción.
El widget avanzado recopilará automáticamente la código de moneda valor si sigue las convenciones de nomenclatura estándar. Los comerciantes pueden:
Utilice el atributo de ID predeterminado.
Especifique el ID del código de moneda utilizando la biblioteca.
Utilice la data-ccbill atributo para especificar el campo de código de moneda.
El isScaRequiredForPaymentToken La función determina si se requiere una autenticación fuerte del cliente. basado en la ID del token de pago proporcionado y el código de moneda.
Una entrada válida da como resultado una Promesa, que eventualmente se resolverá en una respuesta con parámetros SCA o se convertirá en un rechazo, debido a un error.
PARÁMETRO
TIPO
DESCRIPCIÓN
token de autorización
cadena (requerido)
Debe ser un token de Oauth válido para la cuenta de comerciante proporcionada.
Id. de token de pago
cadena (requerido)
El identificador del token de pago. Una cadena única que identifica el token de pago, debe coincidir con la expresión regular <strong><em>[a-zA-Z0-9]+$</em></strong>
Ejemplo
const result = widget.isScaRequiredForPaymentToken(authToken, paymentTokenId);
El formulario de pago del comerciante debe contener un campo de entrada de texto o un elemento de selección para el código de moneda valor. El valor representa un código de moneda de tres dígitos (norma ISO 4217) para la moneda utilizada en la transacción.
El widget avanzado recopilará automáticamente la código de moneda valor si sigue las convenciones de nomenclatura estándar. Los comerciantes pueden:
Utilice el atributo de ID predeterminado.
Especifique el ID del código de moneda utilizando la biblioteca.
Utilice la data-ccbill atributo para especificar el campo de código de moneda.
El autenticarCliente La función permite a los comerciantes obtener el resultado de la autenticación del cliente antes de iniciar una transacción 3DS y llamar al extremo de la API Merchant Connect (RESTful) de CCBill. Si la llamada falla, devolverá un error.
Se deben pasar varios parámetros para facilitar una autenticación sólida del cliente.
PARÁMETRO
TIPO
DESCRIPCIÓN
token de autorización
cadena (requerido)
Debe ser un token de Oauth válido para la cuenta de comerciante proporcionada.
formulario
cadena (opcional)
Una referencia de formulario debe ser un selector válido o un elemento de formulario HTML que exista en la página web del comerciante. Tenga en cuenta que si el no se proporciona formId, el widget encontrará el primer elemento HTML del formulario en la página y supondrá que ese es el formulario de pago.
iframeId
cadena (opcional)
El proceso de autenticación 3DS presenta un iframe en la página web para realizar su funcionalidad. El script Advanced Widget genera un iframe y lo inyecta en la página web del comerciante si el parámetro no está definido. Si el valor proporcionado es nulo o una cadena vacía, se regenera para ajustarse a los requisitos técnicos mínimos.
Id. de token de pago
cadena (opcional)
Utilice este campo opcional en lugar del número de tarjeta, el mes de vencimiento de la tarjeta y el año de vencimiento de la tarjeta. La información de la tarjeta debe estar presente en el formulario HTML asociado si no se proporciona la identificación del token.
Ejemplo usando solo los parámetros requeridos
const result = widget.authenticateCustomer(authToken);
Ejemplo usando formulario
const result = widget.authenticateCustomer(authToken, form);
Ejemplo usando iframeId y formulario
const result = widget.authenticateCustomer(authToken, form, iframeId);
Ejemplo usando todos los parámetros
const result = widget.authenticateCustomer(authToken, form, iframeId, paymentTokenId);
Validación de datos de campo
PARÁMETRO
TIPO
DESCRIPCIÓN
Id. de token de pago
cadena (requerido)
Debe coincidir con la expresión regular ^ [a-zA-Z0-9] + $
formulario
cadena (opcional)
Una referencia de formulario debe ser un selector válido o un elemento de formulario HTML que exista en la página web del comerciante. Si es no siempre, el sistema intentará recopilar las entradas SCA requeridas del primer formulario HTML que encuentre en la página.
iframeId
cadena (opcional)
El proceso de autenticación 3DS presenta un iframe en la página web para realizar su funcionalidad. El script Advanced Widget genera un iframe y lo inyecta en la página web del comerciante si el parámetro no está definido. Si el valor proporcionado es nulo o una cadena vacía, se regenera para ajustarse a los requisitos técnicos mínimos.
Después de generar un nuevo token de OAuth y después de generar un token de pago, puede usar esos dos tokens nuevos para cargar la tarjeta de crédito del consumidor.
Devuelva un nuevo token de pago para transacciones posteriores o no.
clienteAccnum
entero (requerido)
Número de cuenta mercantil.
clienteSubacc
entero (requerido)
Número de subcuenta de comerciante.
precio inicial
flotar (requerido)
Precio de transacción inicial.
periodo inicial
entero (requerido)
La duración (en días) del período de facturación inicial.
Precio recurrente
flotar (opcional)
El monto que se le cobrará al consumidor por cada factura recurrente.
período recurrente
entero (opcional)
El tiempo entre refacturaciones.
refacturaciones
entero (opcional)
El número total de veces que se volverá a facturar la suscripción.
código de moneda
entero (opcional)
Código de moneda de tres dígitos (norma ISO 4217) para la moneda utilizada en la transacción.
LifeTimeSubscription
booleano (opcional)
La presencia de esta variable con un valor de 1 indica que la transacción es una suscripción de por vida.
crear nuevo token de pago
booleano (opcional)
Devuelva un nuevo token de pago para transacciones posteriores o no.
passThroughInfo
Matriz [cualquiera] (opcional)
Información emparejada que se pasa al servicio de transacciones.
tresdsCardToken
entero (requerido)
El número de tarjeta de pago (PAN).
tresdsEci
cadena (requerido)
Un Indicador de Comercio Electrónico (ECI). Valores: '0','1','2','5','6', o'7'.
estado de tresds
cadena (requerido)
El estado de la verificación 3DS ('Y','N','A', etc.)
versión de threeds
cadena (requerido)
La versión del protocolo 3DS que se seguirá para esta tarjeta y transacción específicas. Las versiones disponibles son 1.0.2 y 2.1.0
tresdsXid
cadena (opcional/requerido)
El identificador de la transacción (XID) es un número de seguimiento único establecido por el comerciante para 3DS. Es un parámetro requerido para threedsVersion 1.0.2
tresdscavv
cadena (opcional/requerido)
Una firma digital que prueba que la transacción ha sido verificada en 3DS. La firma se obtiene a través de un flujo de verificación 3DS y es un parámetro requerido para threedsVersion 1.0.2
algoritmo threedsCavv
cadena (opcional/requerido)
Algoritmo CAVV para solicitud de threeds. Se requiere el parámetro threedsCavvAlgorithm para threedsVersion 1.0.2
tresdsDsTransId
cadena (opcional/requerido)
ID de transacción del servidor de directorio. El parámetro threedsDsTransId es necesario para threedsVersion 2.1.0
tresdsAcsTransId
cadena (opcional/requerido)
ID de transacción del servidor de control de acceso. Se requiere el parámetro threedsAcsTransId para threedsVersion 2.1.0
tresdsSdkTransId
cadena (opcional)
El ID de transacción del proveedor de 3DS.
tipo de autenticación de threeds
cadena (opcional)
Una firma digital que prueba que la transacción ha sido verificada en 3DS. La firma se obtiene a través de un flujo de verificación 3DS (v2.1.0).
valor de autenticación de threeds
cadena (opcional)
Una firma digital que prueba que la transacción ha sido verificada en 3DS. La firma se obtiene a través de un flujo de verificación 3DS (v2.1.0).
threedsClientTransactionId
cadena (requerido)
El widget avanzado genera automáticamente el parámetro. Su propósito es identificar el origen de la transacción de autenticación 3DS.
tresdséxito
booleano (opcional)
Verificación del éxito o fracaso de la autenticación 3DS.
tresdsCantidad
entero (opcional)
La cantidad a cobrar (igual que precio inicial).
tresdsmoneda
entero (opcional)
El código de moneda de 3 dígitos para la moneda que se utilizará en esta transacción. Valor de ejemplo: 840
tresdsError
cadena (opcional/requerido)
Error recibido del proveedor de 3DS durante el proceso de autenticación sólida del cliente. El parámetro es obligatorio si no se proporciona threedsVersion.
tresdsErrorDetalle
cadena (opcional)
Detalles del error relacionados con el tresdsError.
Una vez que se ha cargado el token de pago, un Notificación HTTP POST de webhooks se activará para que pueda capturar la información de la transacción. Este evento de webhooks será un “UpSaleÉxito.
Leer ID de token de pago
Utilice esta llamada a la API para obtener datos sobre un cargo realizado anteriormente. Deberá identificar el cargo por la ID del token de pago e incluir la ID como un elemento URI.
Conexión comercial es un mercado diseñado para reunir a los comerciantes en una ubicación centralizada. CCBill está mejorando una vez más la experiencia de compra en línea de los consumidores al proporcionar una nueva forma de realizar nuevas compras de diferentes comerciantes sin volver a ingresar la información de pago.
Diseñado para simplificar y asegurar el proceso de compra mientras aumenta los ingresos, Merchant Connect permite a su empresa llegar a nuevos mercados y consumidores con la flexibilidad y la innovación que ofrece CCBill.
Con Merchant Connect, hemos creado una experiencia de usuario simple que permite a los comerciantes conectarse rápida y fácilmente entre sí, asociándose para aumentar el tráfico y los ingresos para ambas partes. Puede enumerar su programa y presentarlo en la red de comerciantes de CCBill, o encontrar rápidamente un programa de socios con el que compartir su tráfico.
Caracteristicas
Listado de programas con capacidad de búsqueda. Todos los patrocinadores de Merchant Connect serán visibles para todos los comerciantes, incluidos los detalles de su programa. De esta lista, puede seleccionar rápidamente los programas con los que está interesado en asociarse y unirse de inmediato
Pagos flexibles y confiables. Ya sea Pago por Venta y Reparto de Ingresos a través de CCBill o administrado por un patrocinador, Merchant Connect viene con una variedad de opciones de pago para usted.
Proceso de integración simplificado. Merchant Connect viene con un script prediseñado para manejar las funciones del comerciante afiliado. Dedique menos tiempo a la integración y más tiempo a ganar dinero.
Venta cruzada SIN volver a ingresar la información de pago. Amplíe el éxito de nuestro sistema de venta cruzada para agregar ventas promocionales a su sitio como una herramienta de posventa y elimine la necesidad de ingresar información de pago para que sus consumidores puedan obtener lo que desean sin demora.
Agregue fácilmente productos relacionados a su sitio. Trabaje con socios ya establecidos para agregar un elemento tangible, una compra de cámara o un sitio de citas para sus miembros. Aproveche los beneficios de las compras de complementos sin asumir los gastos generales o la carga de trabajo de una solución con la que no está familiarizado.
Automatizar el proceso de compra. Una vez configurada, puede dejar que la función se ejecute sola. Reciba notificaciones automáticas cuando se realicen compras y reciba notificaciones si cambia la configuración del programa. Dedique más tiempo a hacer crecer su negocio y menos tiempo a preocuparse por las configuraciones de su socio.
Cómo funciona Merchant Connect
Básicamente, CCBill juega como casamentero entre los comerciantes patrocinadores y los comerciantes afiliados. La plataforma permite transacciones con un solo clic entre todos los comerciantes, por lo que su audiencia puede realizar compras instantáneas de otros comerciantes. Un comerciante afiliado envía un miembro o comprador a un número seleccionado de comerciantes patrocinados por CCBill y ofrece su producto que se puede comprar con un solo clic del botón del mouse. CCBill rastrea estas transacciones con un solo clic, y realizamos un seguimiento y pago de la participación en los ingresos, todo dentro de la plataforma Merchant Connect.
¿Qué me convierte en patrocinador o comerciante afiliado?
¿Qué lo convierte en un comerciante patrocinador?
¿Qué lo convierte en un comerciante afiliado?
Le gustaría ofrecer su producto o servicio a otros propietarios de sitios web de CCBill.
Tiene consumidores existentes o anteriores que han comprado a través de CCBill.
Le gustaría aumentar su tráfico entrante y automatizar su reparto de ingresos.
Le gustaría aumentar sus ingresos ofreciendo otro producto o servicio a sus consumidores.
Le gustaría hacer crecer su propia base de clientes con nuevas ventas cruzadas de socios.
Le gustaría automatizar su flujo de ventas y simplificar el proceso de venta superior en su sitio.
Si se ve a sí mismo en alguno de los roles mencionados anteriormente, entonces no hay nada que se interponga en su camino para recibir o enviar tráfico a través de Merchant Connect.
Requisitos
Merchant Connect se considera una función avanzada. Como tal, este documento asume lo siguiente:
El usuario ya ha habilitado la API de CCBill.
El usuario posee habilidades de programación de nivel intermedio a avanzado.
El usuario posee las habilidades de programación necesarias para crear scripts e implementarlos en el contexto de este documento.
El usuario posee conocimientos de SOAP, HTML, XML y otras tecnologías de desarrollo web.
El usuario ya ha configurado la Gestión de usuarios, si lo desea.
Terminología
Comerciante patrocinador. El comerciante patrocinador es un comerciante que desea que otros comerciantes les recomienden ventas mediante la función Merchant Connect.
Comerciante afiliado. El comerciante afiliado es un comerciante que asume el papel de un afiliado con el fin de utilizar Merchant Connect para referir a sus consumidores existentes a un comerciante patrocinador a cambio de una parte de los ingresos generados por esa venta.
Cuenta API. La cuenta API también se conoce como "Extracto de enlace de datos".
Cuenta de API de enlace de datos
La implementación de Merchant Connect requiere que tanto el comerciante patrocinador como los comerciantes afiliados usen CCBill Sistema de extracción de enlace de datos. Data Link se habilitará para su cuenta cuando configure un programa, o puede comunicarse con nuestro Departamento de asistencia comercial al merchandisingupport@ccbill.com para tener esto habilitado si desea familiarizarse con el sistema antes de crear programas.
API CCBill
La implementación de Merchant Connect requiere que tanto el comerciante patrocinador como el comerciante afiliado utilicen el API CCBill. Este es un componente de Data Link que facilita el uso del método avanzado para implementar Merchant Connect. Este método se analiza con más detalle a continuación.
Controles de velocidad
CCBill Velocity Controls es una función avanzada de la API de CCBill y le permite limitar las transacciones de los clientes por el número de transacciones y / o por el monto en efectivo de las transacciones dentro de un período de tiempo específico. Esto significa que puede establecer el número de transacciones para un cliente específico dentro de un período de tiempo determinado. Las reglas se aplican a todos los tipos de pago y se pueden implementar en una sola subcuenta o en todas las subcuentas.
Cuando se aplica, a cada cliente se le asigna una identificación única en función de su información financiera y antecedentes de seguridad. Al configurar CCBill Velocity Controls, limita las posibilidades de fraude y, de manera individual, permite que los buenos clientes leales continúen comprando más allá de los límites establecidos. Si está interesado en esta función avanzada, comuníquese con merchandisingupport@ccbill.com para configurar controles de velocidad de acuerdo con los requisitos de su negocio.
Casos de uso
La implementación del sistema Merchant Connect será diferente para casi todas las situaciones. Este documento tiene la intención de brindarle una descripción general del proceso y las llamadas necesarias para los métodos admitidos de envío y recuperación; Deberá utilizar la información proporcionada y adaptarla a su propia configuración.
Se incluyen cuatro posibles maneras en las que Merchant Connect podría utilizarse.
Caso de uso n. ° 1: redireccionar a los consumidores a un recorrido
1. El consumidor visita el sitio del comerciante afiliado e inicia sesión en su cuenta.
2. Desde el sitio del comerciante afiliado, el consumidor hace clic en un banner o enlace para el programa del comerciante patrocinador.
3. Merchant Connect redirige al consumidor a la página del programa del comerciante patrocinador con un token adjunto que contiene la información de identificación del consumidor (el token no es visible para el consumidor).
4. Merchant Connect presenta una oferta al consumidor del comerciante patrocinador.
5. El consumidor acepta los términos de la transacción.
6. Merchant Connect utiliza la información del token para procesar la transacción sin que el consumidor ingrese ninguna información de pago.
7. El Comerciante Patrocinador completa el cumplimiento del pedido y el Comerciante Afiliado recibe crédito por recomendar al consumidor al Comerciante Patrocinador.
Caso de uso n. ° 2: cobrar a un consumidor de inmediato
1. El consumidor visita el sitio del comerciante afiliado e inicia sesión en su cuenta.
2. Desde el sitio del comerciante afiliado, el consumidor hace clic en un banner o enlace para el programa del comerciante patrocinador.
3. Merchant Connect redirige al consumidor a la página del programa del comerciante patrocinador con un token adjunto que contiene la información de identificación del consumidor (el token no es transparente para el consumidor).
4. Durante la redirección, se cobra al consumidor utilizando la información del token.
5. El consumidor es redirigido al sitio del comerciante patrocinador con una transacción exitosa.
6. Se acredita al comerciante afiliado por recomendar al consumidor al comerciante patrocinador.
Caso de uso n. ° 3: cobrar a un consumidor con un sessionId
1. El consumidor visita el sitio del comerciante afiliado e inicia sesión en su cuenta.
2. Mientras está registrado en el sitio del comerciante afiliado, el consumidor hace clic en un banner o enlace para el programa del comerciante patrocinador.
3. Merchant Connect redirige al consumidor a la página del programa del comerciante patrocinador con un token adjunto que contiene la información de identificación del consumidor (el token no es visible para el consumidor).
4. El comerciante patrocinador utiliza información de token para generar una sesión de información del consumidor (las sesiones no caducan y pueden usarse indefinidamente para cobrar al consumidor sin volver a ingresar la información de pago).
5. Merchant Connect utiliza la información de la sesión para procesar la transacción sin que el consumidor ingrese ninguna información de pago.
6. El Comerciante Patrocinador completa el cumplimiento del pedido y el Comerciante Afiliado recibe crédito por recomendar al consumidor al Comerciante Patrocinador.
Caso de uso n. ° 4: crear un perfil para un consumidor
1. El consumidor visita el sitio del comerciante afiliado e inicia sesión en su cuenta.
2. Mientras está registrado en el sitio del comerciante afiliado, el consumidor hace clic en un banner o enlace para el programa del comerciante patrocinador.
3. Merchant Connect redirige al consumidor a la página del programa del comerciante patrocinador con un token adjunto que contiene la información de identificación del consumidor (el token no es transparente para el consumidor).
4. El comerciante afiliado agrega información adicional a la URL de redireccionamiento como detalles delimitados por barra (/ variable1 / valor1 / variable2 / valor2).
5. El comerciante patrocinador recibe información del sitio del comerciante afiliado y crea un perfil para el consumidor.
6. Merchant Connect utiliza la información del token para procesar la transacción sin que el consumidor ingrese ninguna información de pago.
7. El consumidor ha iniciado sesión en el sitio del comerciante patrocinador con una transacción exitosa y su nuevo perfil.
8. El Comerciante Patrocinador completa el cumplimiento del pedido y el Comerciante Afiliado recibe crédito por recomendar al consumidor al Comerciante Patrocinador.
Métodos de implementación
Hay dos métodos de implementación de Merchant Connect:
Método avanzado. Se prefiere este método. El método avanzado requiere la integración completa del comerciante afiliado con la API de CCBill y la gestión de usuarios, pero proporciona la experiencia más fluida para los consumidores. Este es el método que utiliza el script PHP predeterminado proporcionado por Merchant Connect.
Método simple. El método simple es un método alternativo para los comerciantes afiliados, pero puede resultar en una mayor intervención del consumidor; incluyendo verificación de identificación y / o reingreso de pago e información de usuario. Hay dos subopciones disponibles para el método simple:
Con ID de suscripción requiere la menor intervención del comerciante afiliado.
Con nombre de usuario se requiere la integración del comerciante afiliado con la gestión de usuarios.
Método avanzado
El método avanzado requiere que los comerciantes afiliados se integren completamente con la API de CCBill. Luego, el Afiliado utiliza las llamadas "Obtener token de venta cruzada" en la API de CCBill para generar y devolver un token autenticado a través de un script cuando un consumidor hace clic en el banner o material promocional en el sitio del comerciante afiliado. El comerciante afiliado luego reemplaza ese token con una versión modificada que contiene su ID de participación en el programa.
El sitio del comerciante patrocinador utilizará la API de CCBill para realizar una llamada de "Cargo por token" a la API de CCBill para completar la compra. En el caso de que el token no esté autenticado (el período de autenticación ha caducado), el consumidor deberá proporcionar alguna verificación de identidad para obtener un token verificado y volver a enviar la llamada "Cargo por token". El período de autenticación predeterminado es de 24 horas.
Este método, aunque requiere más programación, crea una experiencia más fluida para el usuario.
Método simple
El método simple requiere menos programación de los comerciantes afiliados para implementar, pero resulta en más información del consumidor para completar la compra.
En el método simple, los comerciantes afiliados adjuntan información de identificación sobre el titular de la suscripción al código de enlace de referencia en lugar de generar un token de API de CCBill. El consumidor es dirigido a través de Merchant Connect, donde se crea un token no autenticado que incluye la información del comerciante afiliado y la información de identificación del consumidor y se envía al sitio del comerciante patrocinador.
El consumidor hace clic para confirmar la compra, lo que activa la llamada "Cargo por token" a la API de CCBill, que a su vez reconoce el estado no autenticado del token y solicita al consumidor la verificación de identidad. Si la identidad se verifica con éxito, la API de CCBill redirigirá al parámetro "url" pasado por el comerciante patrocinador (también se puede proporcionar una "URL de falla" para los casos en los que el consumidor no se identifica correctamente).
El método simple tiene dos "subopciones" disponibles. La única diferencia entre los dos son los parámetros que deben enviarse del comerciante afiliado a Merchant Connect.
Integración API
La API de Merchant Connect se implementa como llamada SOAP. El punto de acceso es https://bill.ccbill.com/dss.
Las respuestas están en formato SOAP y contienen errorCode y errorDesc junto con información adicional, si corresponde.
Todas las operaciones incluyen los siguientes parámetros para fines de autenticación:
información de autenticación
MerchantAccnum
Entero
Número de cuenta comercial de CCBill
ComercianteSubacc
Short
Número de subcuenta del comerciante de CCBill
usandoMerchantSubacc
Short
Número de subcuenta del comerciante de CCBill (cuando corresponda y MerchantSubacc es nulo)
nombre de usuario
Cordón
Nombre de usuario de la API de CCBill
la contraseña
Cordón
Contraseña de la API de CCBill
Ejemplos de funciones
Funciones del comerciante patrocinador
getCrossSaleSessionInfo / getCrossSaleTokenInfo
IN
información de autenticación
IN
sessionId / tokeninfo
cadena
sessionId representa un identificador único para la relación de consumidor entre el comerciante afiliado y el comerciante patrocinador; tokeninfo es un objeto de datos transitorio que incluye información que se utilizará para crear o buscar una sesión.
OUT
correo electrónico,
cadena
Dirección de correo electrónico registrada para el consumidor del comerciante afiliado.
OUT
isAuthLocked
byte
1 = El consumidor ha fallado demasiadas veces para ser autenticado y debe intentarlo de nuevo más tarde; 0 = El consumidor no ha agotado sus intentos de autenticación
OUT
está autenticado
byte
1 = El consumidor ha validado su código postal o se trata de un token avanzado; 0 = El consumidor no ha validado su código postal, su ventana de validación ha expirado o un token avanzado ha expirado.
OUT
URL de autenticación
cadena
Si isAuthenticated = 0, el usuario deberá ser redirigido a esta URL para validar su identidad; Los siguientes parámetros se pueden transferir a este sistema: * url = URL para redirigir a una validación exitosa (si no se proporciona, redirigirá a HTTP_REFERER) * failureUrl = URL a la que redirigir tras una validación fallida (si no se proporciona, se redirigirá al parámetro "url")
OUT
esUsuarioCreado
byte
1 = El patrocinador ha registrado correctamente un usuario para el consumidor utilizando el método createUserForCrossSale; 0 = El patrocinador aún no ha registrado un usuario para el consumidor mediante el método createUserForCrossSale.
OUT
pagoUniqueId
cadena
Identifica de forma única una cuenta de pago en particular (tarjeta de crédito / fecha de vencimiento, cuenta ACH / número de ruta) utilizando un algoritmo hash. Usado a menudo por los comerciantes patrocinadores con fines de fraude.
OUT
ID de participación del programa
entero
El identificador único que indica la relación entre un comerciante afiliado y el programa de un comerciante patrocinador.
OUT
ID de sesión
cadena
Lo mismo que arriba.
OUT
código de error
entero
0 = No hubo error; consulte el Apéndice A: Códigos de error y descripciones para obtener una lista de otros códigos posibles.
OUT
errorDesc
cadena
Descripción del error devuelto; consulte el Apéndice A: Códigos de error y descripciones para obtener una lista de posibles descripciones.
OUT
ID de suscripción
entero
Si esto está presente, el comerciante patrocinador ha procesado al menos una venta con esta sesión. El subscriptionId proporcionado fue la primera venta procesada.
sessionId representa un identificador único para la relación de consumidor entre el comerciante afiliado y el comerciante patrocinador; tokeninfo es un objeto de datos transitorio que incluye información que se utilizará para crear o buscar una sesión.
IN
precio inicial
entero
Importe del cargo inicial. Basado en dos decimales implícitos. Por ejemplo, $ 2.95 deben pasarse como 295.
IN
periodo inicial
entero
Duración del plazo inicial de suscripción en días.
IN
Precio recurrente
entero
Opcional
Monto de cada cargo recurrente. Basado en dos decimales implícitos. Por ejemplo, se deben pasar $ 29.95 2995.
IN
período recurrente
entero
Opcional
Duración del plazo recurrente de la suscripción en días.
IN
refacturaciones
Corto
Opcional
Número de veces que se debe volver a facturar la suscripción antes de que finalice (99 para ilimitado).
IN
código de moneda
Corto
Opcional
Código de moneda numérico ISO 4217 (es decir, dólares estadounidenses = 840); Predeterminado a 840.
chargeCrossSaleBySession / chargeCrossSaleByToken
IN
pares de paso
pares nombre / valor
Opcional
Datos misceláneos que el Patrocinador puede pasar durante el proceso de registro que se les proporcionará en las publicaciones de antecedentes de aprobación / rechazo.
OUT
aprobado
byte
0 = Rechazado, 1 = Aprobado.
OUT
pagoUniqueId
cadena
Identifica de forma única una cuenta de pago en particular (es decir, tarjeta de crédito / fecha de vencimiento, cuenta ACH / número de ruta) utilizando un algoritmo hash. Algunos comerciantes utilizan esto con fines de fraude de su lado.
OUT
ID de sesión
cadena
ID de sesión representa un identificador único para la relación de consumidor entre el comerciante afiliado y el comerciante patrocinador.
OUT
ID de suscripción
cadena
El ID de suscripción de la transacción recién procesada (asumiendo que fue aprobada).
OUT
ID de negación
entero
El descriptor único del ID.
OUT
decliveCode
entero
El código de rechazo proporcionado por el procesador de la tarjeta de crédito.
OUT
declinarTexto
cadena
Presente si se rechaza la transacción; proporciona una descripción de por qué se rechazó la transacción.
OUT
AuthenticateUrl
cadena
Presente si el token / sesión no está autenticado. Si isAuthenticated = 0, el usuario deberá ser redirigido a esta URL para validar su identidad; Los siguientes parámetros se pueden transferir a este sistema: * url = URL para redirigir a una validación exitosa (si no se proporciona, redirigirá a HTTP_REFERER) * errorUrl = URL a la que redirigir tras una validación fallida (si no se proporciona, se redirigirá al parámetro "url")
ID de sesión representa un identificador único para la relación de consumidor entre el comerciante afiliado y el comerciante patrocinador; tokeninfo es un objeto de datos transitorio que incluye información que se utilizará para crear o buscar una sesión.
IN
Patrocinador Miembro Nombre de usuario
cadena
Opcional
El nombre de usuario que el comerciante patrocinador agregó a su sitio web y nos proporcionó utilizando el createUserForCrossSaleToken or createUserForCrossSaleSession métodos.
IN
Patrocinador Miembro Contraseña
cadena
Opcional
Igual que Patrocinador Miembro Nombre de usuario, excepto la contraseña.
OUT
ID de sesión
cadena
ID de sesión representa un identificador único para la relación de consumidor entre el comerciante afiliado y el comerciante patrocinador.
El ID de suscripción desde el que el comerciante afiliado desea crear el token.
IN
AfiliadoMiembroNombre de usuario
cadena
Opcional
El nombre de usuario que el comerciante afiliado desea incluir en el token (se anulará con el que tenemos registrado si está utilizando nuestra gestión de usuarios).
IN
Afiliado Miembro Contraseña
cadena
Opcional
La contraseña que el comerciante afiliado desea incluir en el token (se anulará con lo que tenemos registrado si está utilizando nuestra gestión de usuarios).
OUT
tokeninfo
cadena
El token autenticado que se crea en base a la información anterior que utilizarán para reenviar al consumidor a través de WMS al sitio web del Patrocinador.
Merchant Connect es un mercado diseñado para reunir a los comerciantes en una ubicación centralizada. Merchant Connect se basa en nuestro sistema de venta cruzada con un solo clic. Puede brindarles a los consumidores una nueva forma de realizar compras adicionales de diferentes comerciantes sin tener que volver a ingresar la información de pago.
Beneficios del comerciante afiliado
Listado de programas con capacidad de búsqueda. Todos los patrocinadores de Merchant Connect son visibles para todos los comerciantes, incluidos los detalles de su programa. De esta lista, seleccione rápidamente un programa con el que le interese asociarse y únase de inmediato.
Pagos flexibles y confiables. Ya sea Pago por Venta y Reparto de Ingresos a través de CCBill o administrado por un patrocinador, Merchant Connect viene con una variedad de opciones de pago para usted.
Proceso de integración simplificado. Merchant Connect contiene un script prediseñado para manejar las funciones de Afiliado, por lo que puede pasar menos tiempo integrando y más tiempo ganando dinero.
Venta cruzada sin volver a ingresar la información de pago. Amplíe el éxito de nuestro sistema de venta cruzada para agregar ventas promocionales a su sitio como una herramienta de posventa, eliminando la necesidad de ingresar información de pago para que sus consumidores puedan obtener lo que desean sin demora.
Agregue fácilmente productos relacionados a su sitio. Trabaje con socios establecidos para agregar un elemento tangible, una compra de cámara o un sitio de citas para sus miembros. Aproveche los beneficios de las compras complementarias sin asumir los gastos generales de una solución con la que no está familiarizado.
Automatizar el proceso de compra. Una vez configurada, la función se ejecuta sola. Recibirá notificaciones automáticas de compras y se le notificará si cambia la configuración del programa. Dedique más tiempo a hacer crecer su negocio y menos tiempo a preocuparse por las configuraciones de su socio.
¿Cómo me uno a un programa Merchant Connect?
Para unirse a un programa Merchant Connect:
1. Inicie sesión en Portal de administración.
2. Haga clic en el megamenú Merchant Connect y, a continuación, haga clic en Explore y únase a programas.
3. Explore la lista de programas Merchant Connect disponibles. Cuando encuentre un programa que le interese, haga clic en Ver más para obtener más información. Ver más muestra la siguiente información:
Reseña del programa
Nombre del programa
Nombre del Programa de Patrocinador disponible.
URL del programa
La URL a la que se dirige a un consumidor desde su sitio.
Tipo de pago
Reparto de ingresos
Paga un porcentaje de la compra del consumidor.
Pago por venta
Paga una cantidad fija en dólares por venta.
Gestionado por el patrocinador
El pago es variable; El comerciante patrocinador proporcionará más información.
Detalles de pago
Pagar por pruebas / iniciales / reembolsos
Muestra qué tipos de transacciones paga el programa.
Frecuencia de pago de nueva factura
La cantidad de facturas que paga el programa.
Porcentaje de pago de venta o monto de pago fijo
Cantidades de pago específicas.
Tiempo de pago
Ya sea que reciba el pago en el momento de la venta inicial o después de que la primera refacturación sea exitosa.
Método
Simple y avanzado / avanzado
Método de venta cruzada seleccionado para el programa.
Detalles del programa
Instrucciones
Instrucciones generales de Merchant Connect.
Instrucciones especiales
Instrucciones específicas del patrocinador para este programa.
4. Busque un programa que le gustaría promover y haga clic en Unirse al programa.
5. Después de hacer clic Unirse al programa, se envía una notificación al propietario del programa expresando su interés en asociarse con ellos. Cuando el Patrocinador apruebe su solicitud, recibirá un correo electrónico confirmando su aceptación.
Descarga el script PHP
1. Inicie sesión en Portal de administración.
2. Por Conexión comercial mega menú, haga clic en Programas actualmente inscritos para ver sus asociaciones actuales.
3. Busque el programa para el que desea crear un script y haga clic en Ver más.
4. En el Cuenta API sección, haga clic en Generar script PHP.
5. Después de hacer clic en este enlace, se le pedirá que seleccione un Cuenta API utilizar para este script. Seleccione el botón de radio para el nombre de usuario que le gustaría usar y haga clic en Generar PHP.
Una vez que se haga clic en este botón, la descarga comenzará en una nueva pestaña.
¿Cómo puedo comenzar a enviar tráfico?
Después de unirse a los programas que desea promover y descargar el script PHP, solo necesita completar la integración técnica. Haga clic en el Características técnicas en la parte superior de esta página para obtener detalles y ejemplos de casos de uso / flujos para Merchant Connect.
Comerciante patrocinador
Merchant Connect es un mercado diseñado para reunir a los comerciantes en una ubicación centralizada. Al expandir nuestro sistema de venta cruzada con un solo clic, puede brindarles a los consumidores una nueva forma de realizar compras adicionales de diferentes comerciantes sin tener que volver a ingresar la información de pago.
Beneficios del comerciante patrocinador
Listado de programas con capacidad de búsqueda. Todos los patrocinadores de Merchant Connect serán visibles para todos los comerciantes. En lugar de buscar nuevos socios, Merchant Connect permite que toda la base de comerciantes de CCBill encuentre y se una a su programa rápida y fácilmente.
Proceso de integración simplificado. Al proporcionar un script para que lo utilicen los comerciantes afiliados, CCBill ha eliminado las dificultades normalmente asociadas con un sistema como este. Este enfoque simplificado abre más socios potenciales y fuentes de ingresos.
Venta cruzada sin volver a ingresar la información de pago. Las ventas en línea son ventas extremadamente difíciles de capturar. El consumidor está listo para realizar su compra de inmediato y no quiere ingresar la información de la tarjeta de crédito y perder tiempo en obtener lo que desea. Con Merchant Connect, se puede cobrar a los consumidores inmediatamente sin volver a ingresar su información, lo que permite ventas más rápidas y fluidas.
Funciona con cualquier modelo de negocio. Las compras fáciles ya no son el dominio exclusivo de los sitios de cámaras. Ya sea que tenga un producto tangible, un sitio de membresía, servicios de citas o un sitio de cámara, la base de comerciantes de CCBill puede vender su producto rápida y fácilmente.
Expande tu marca. Merchant Connect de CCBill le permite cerrar la brecha entre su producto y nuestra base de usuarios. Al hacer que su nombre y producto sean visibles para más comerciantes, puede alcanzar nuevas fuentes de ingresos que lo beneficiarán tanto ahora como en el futuro.
¿Cómo puedo convertirme en un comerciante patrocinador?
Convertirse en un patrocinador de Merchant Connect requiere la configuración del personal de apoyo al comerciante de CCBill. Por favor contactar merchandisingupport@ccbill.com para comenzar el proceso
Una vez que el personal de CCBill haya configurado su cuenta para ser un patrocinador de Merchant Connect, puede configurar su programa.
¿Cómo creo un programa Merchant Connect?
Para crear un programa Sponsor Merchant Connect:
1. Inicie sesión en Portal de administración.
2. Por Conexión comercial mega menú, haga clic en Crear programa para ver sus asociaciones actuales.
3. El asistente le ayudará a configurar su Conexión comercial Programa. La Crear programa La pantalla contiene los siguientes campos:
Tipo de pago
Reparto de ingresos
Porcentaje de la compra del consumidor pagada por las ventas pagadas por CCBill.
Pago por venta
Monto fijo en dólares pagado por venta pagada por CCBill.
Gestionado por el patrocinador
Si manejará los pagos usted mismo; CCBill no pagará por programas con esta configuración.
Método
Simple y avanzado / avanzado
Métodos de integración de venta cruzada.
Detalles del programa
Instrucciones
Instrucciones generales de Merchant Connect.
Instrucciones especiales
Sus instrucciones específicas para este programa.
4. Complete los campos obligatorios y haga clic en Ahorrar en la parte superior de la página.
¿Cómo administro mis programas?
1. Inicie sesión en Portal de administración.
2. Por Conexión comercial mega menú, haga clic en Administrar mis programas para ver sus asociaciones actuales. Esta pantalla enumerará todos sus Conexión comercial Programas.
3. Seleccione su acción preferida de la Acciones Menú desplegable. Las opciones disponibles son:
Ver / modificar programa
Desactivar programa
Reactivar programa
Ver afiliados asignados.
Ver / modificar programa
Desde dentro del Ver / modificar programa pantalla, tendrá la capacidad de realizar ediciones en la configuración de su programa existente. El sistema CCBill notificará automáticamente a su comerciante Conéctese socios por correo electrónico cuando se realicen cambios en su programa.
1. Hacer clic en Editar en la parte superior izquierda de la pantalla.
2. Actualice los campos donde se necesiten cambios.
3. Hacer clic en Ahorrar en la parte superior izquierda de la pantalla.
Desactivar programa
Si desea desactivar un Conexión comercial Programa puedes hacer esto desde el Administrar mi programa Pantalla.
1. Busque el programa que desea desactivar de su lista de programas.
2. Seleccionar Desactivar programa Desde el menú desplegable.
3. Se le presentará un cuadro de confirmación para desactivar el programa.
4. Seleccionar Sí.
Reactivar programa
Si tiene un programa que ha sido desactivado, puede reactivarlo desde el Administrar mi programa pantalla también.
1. Busque el programa que desea reactivar de su lista de programas.
2. Seleccionar Programa reactivo En el menú desplegable.
3. Se le presentará un cuadro de confirmación para reactivar el programa.
4. Seleccionar Sí.
Ver afiliados asignados
Esta opción le presentará todos Conexión comercial socios actualmente activos en su programa. Desde aquí puede ver los detalles del comerciante o eliminarlos de su programa.
Ver los detalles del comerciante
Para ver los detalles de un socio en particular, simplemente haga clic en Ver más junto a su nombre. Desde esta pantalla podrá ver los detalles que se enumeran a continuación.
NOMBRE
ID de afiliado
ID de participación
Nombre
Correo electrónico
Dirección
Eliminar un afiliado
Tiene dos opciones para eliminar un afiliado de su programa:
Opción 1: desde la página de descripción general
1. Marque la casilla a la izquierda del ID de afiliado del comerciante que desea eliminar. Puede seleccionar varios afiliados para eliminarlos a la vez.
2. Hacer clic en Eliminar al afiliado seleccionado de este programa.
Opción 2: desde la página de detalles
1. Busque el afiliado que desea eliminar de su programa y haga clic en Ver más.
2. Hacer clic en Eliminar afiliado de este programa.
Cola de invitaciones
Todas las solicitudes para unirse a su programa se enviarán al Cola de invitaciones y requieren aprobación antes de que puedan comenzar a promocionar su programa. Cuando un Afiliado solicita unirse a su programa, se le notificará por correo electrónico sobre una invitación pendiente. La visualización y la gestión de la cola de invitaciones se pueden realizar en unos sencillos pasos.
1. Inicie sesión en Portal de administración.
2. Por Conexión comercial mega menú, haga clic en Cola de invitaciones para ver sus invitaciones pendientes. Esta pantalla mostrará una lista de todas sus invitaciones pendientes.
3. Marque la casilla junto a los Afiliados que desea aceptar o rechazar.
4. Haga clic en el botón apropiado (Aceptar invitaciones seleccionadas or Rechazar invitaciones seleccionadas) en la parte superior de la pantalla.
Los afiliados serán notificados por correo electrónico cuando se les acepte o se les niegue el acceso a su programa.
Webhooks
Introducción
Webhooks es un sistema de notificación push impulsado por eventos; cuando ocurre un evento (por ejemplo, una refacturación), entregamos una publicación de datos a un script que usted diseñó en base a nuestra Documentación de webhook.
Webhooks es una alternativa a nuestra función Publicación en segundo plano en URL y una función complementaria para nuestro sistema ENS. El sistema Webhooks es mucho más robusto y proporciona notificaciones en tiempo real, además de cubrir una mayor variedad de tipos de eventos.
¿Qué es un Webhook?
En terminología general, Webhooks es un concepto de API para enviar notificaciones push en tiempo real a puntos finales de Webhook.
Su Punto final de webhook es su URL previamente definida. Todas las notificaciones de eventos se enviarán a su URL.
An Evento es un hecho relacionado con su cuenta, por ejemplo, un usuario que reactiva su suscripción o una venta exitosa. Siempre que se produzca un evento de pago, recibirá una notificación automática.
An POST HTTP es el proceso de enviar datos a un recurso específico. Los datos enviados no se almacenan en el historial del navegador ni en los registros del servidor web; necesitará un script que lea los datos y los almacene en su base de datos. Cuando se trata de enviar datos, esta es una seguro y seguro método de transferencia de datos.
En pocas palabras, cuando sucede algo (un evento) con su cuenta, los Webhooks de CCBill enviarán una notificación a su URL (Punto final de webhook), lo que le proporciona información valiosa sobre su negocio en línea.
¿Por qué querría utilizar webhooks?
Para los comerciantes, Webhooks es una forma de recibir información valiosa tan pronto como ocurre, en lugar de verificar los datos de su cuenta continuamente y no obtener datos valiosos la mayor parte del tiempo. En muchos sentidos, Webhooks es como recibir notificaciones automáticas en su teléfono inteligente, es decir, Facebook le envía una notificación cada vez que recibe una solicitud de amistad. De manera similar, CCBill Webhooks le enviará una notificación si, por ejemplo, se realizó con éxito una nueva venta. Puede escribir estos datos en una base de datos para mantener registros o pasarlos a otro script.
Los webhooks son especialmente útiles para:
Calcula tus impuestos puede resultar molesto, pero con CCBill Webhooks puede realizar un seguimiento de sus pagos más fácilmente al iniciar sesión en una entrada de contabilidad cada vez que se le notifique sobre una venta exitosa.
Si no utiliza el sistema de gestión de CCBill, Webhooks le ayudará enormemente a actualizar las membresías de los clientes.
Manejo de contracargos y reembolsos. Se le notificará sobre devoluciones de cargo y reembolsos de inmediato, lo que le dará un tiempo precioso para actuar en consecuencia.
Cómo funcionan los webhooks
Un Webhook es una operación HTTP POST que se produce cuando sucede algo (por ejemplo, una venta). Es como un punto final de API invertido; en lugar de realizar una llamada a la API, puede hacer que se envíe información a su URL de devolución de llamada. Registra una URL que le notificaremos cada vez que ocurra un evento en la cuenta.
El siguiente diagrama ejemplifica cómo funcionan los Webhooks de CCBill:
¿Qué es exactamente un evento?
Como se señaló, un Evento es una acción relacionada con su cuenta. Cada notificación de inserción se envía como un paquete de datos XML y su URL debe ser un script, como CGI, PHP, ASP, etc., programado para recibir y analizar la información publicada por CCBill.
A continuación, encontrará un ejemplo de publicación de Webhooks.
Desde el Administrador de subcuenta, haga clic en el Webhooks enlace en el lado izquierdo de la pantalla.
Ingrese la URL a la que desea que se dirijan las publicaciones en el URL del webhook campo.
Seleccione los tipos de publicaciones a las que desea suscribirse (haga clic en Todas las para seleccionar todos los tipos, o seleccionar y elegir cualquier combinación de tipos de publicaciones seleccionando la casilla de verificación junto a ella).
Seleccione la pestaña Ubicaciones satélite desde el que los Webhooks deberían enviarte mensajes. Intente elegir una ubicación que esté geográficamente cerca del servidor que la URL que seleccionó en el paso 2 para asegurarse de que las publicaciones lleguen a su URL lo más rápido posible. Las ubicaciones de los satélites son actualmente:
Phoenix, Arizona
Ashburn, Virginia
Amsterdam, Países Bajos
Haga clic Actualización para guardar la configuración.
Para obtener una descripción detallada de los tipos de publicaciones de Webhooks, las variables y otra información importante, consulte la Guía del usuario.
Nota:: Recomendamos probar la configuración de Webhook antes de confiar en su precisión. Puede hacerlo creando una cuenta CCBill Test.
¿Puedo tener varias URL que actúen como puntos finales de webhook?
Después de que se haya guardado al menos un Webhook, se le presentará la opción de editar, eliminar o agregar más. Puede agregar hasta cuatro (4) Webhooks, y cada uno puede usar URL diferentes si lo desea.
Este documento se proporciona como recurso técnico para los comerciantes de CCBill.
La información contenida en este documento se refiere al establecimiento y uso de la Interfaz de Programa de Aplicación (API) del servicio al consumidor del lado del comerciante. La secuencia de comandos de administración de suscripciones reemplaza la secuencia de comandos de cancelación personalizada y proporciona nuevas funciones adicionales. La información contenida en este documento describe la funcionalidad de Gestión de Suscripciones y su interacción con el Sistema de Gestión de Usuarios CCBill. Se requiere una configuración adecuada del sistema de extracción de enlace de datos antes de que se pueda utilizar la API de CCBill.
API CCBill
El gestión de suscripciones.cgi La secuencia de comandos reemplaza la secuencia de comandos customCancel.cgi en el Sistema de extracción de enlace de datos. La API de CCBill tiene características adicionales que no se incluyeron en customCancel.cgi.
Antes de que el gestión de suscripciones.cgi Se puede utilizar el script. Su sistema debe estar configurado para acceder al Sistema de Extracción de Enlace de Datos CCBill.
El sistema de extracción de enlace de datos de CCBill permite a los comerciantes de CCBill acceder a los datos de transacciones de la base de datos de CCBill con un script CGI. Puedes consultar nuestra Guía del usuario de Data Link Extract para obtener más información sobre Data Link Extract.
Parámetros necesarios para la autenticación
clienteAccnum
Este parámetro especifica el número de cuenta comercial CCBill principal del comerciante que solicita los datos. El valor debe ser un número de seis dígitos.
nombre de usuario
Este es el nombre de usuario que se configuró para la autenticación en el sistema Data Link Extract.
la contraseña
Esta es la contraseña que se configuró para la autenticación en el sistema Data Link Extract.
DE ACTUAR!
Esta es la función que se realizará dentro de la API de CCBill. Consulte Acciones admitidas para obtener una lista completa de las opciones disponibles.
La tabla enumera los parámetros que siempre se requieren independientemente de si la acción se realizará en la cuenta principal o en una subcuenta:
clienteAccnum
nombre de usuario
la contraseña
DE ACTUAR!
Cuenta principal
X
X
X
Sub-cuenta
X
X
X
Número de cuenta principal - Todos los comerciantes de CCBill reciben un número de cuenta con fines de seguimiento. El formato estándar es 9xxxxx-xxxx, donde 9xxxxx es la cuenta principal. La cuenta principal es un número de 6 dígitos. Por ejemplo: "900000".
Número de subcuenta - Después de que un comerciante se registra para la facturación del sitio web, puede abrir una o más subcuentas. La subcuenta es un número de 4 dígitos. El formato estándar es: xxxx. Por ejemplo: "0002". La subcuenta es parte de la cuenta principal.
Parámetros opcionales
clienteSubacc
Este es el número de subcuenta específico con el que está relacionada la suscripción; debe tener cuatro dígitos. Si se proporciona este parámetro, se le autenticará en una subcuenta específica y no en la cuenta principal. Cualquier acción solicitada debe pertenecer a esta subcuenta; de lo contrario, la operación fallará.
usandoSubacc
Utilice este parámetro si desea autenticarse en la cuenta principal pero no en una subcuenta específica. Este parámetro especifica una subcuenta en la que se realizará una operación solicitada.
Nota:: Si clientSubacc se pasa junto con usingSubacc, deben tener el mismo valor para una autenticación exitosa. Diferentes valores harían que se autenticara en una subcuenta específica y operar en otra.
retornoXML
Si se pasa este parámetro, recibirá la información en formato XML; de lo contrario, la información se devuelve en formato CSV (valores separados por comas).
Acciones admitidas y parámetros requeridos
viewSubscriptionStatus
Informa el estado de la suscripción de un cliente.
Parámetros obligatorios (X) y opcionales (O)
viewSubscriptionStatus
clienteSubacc
usandoSubacc
ID de suscripción
retornoXML
Cuenta principal
O
X
Cuenta principal con XML
O
X
X
Sub-cuenta
X
X
Subcuenta con XML
X
X
X
Información devuelta
Si la suscripción está activa o no.
La fecha de cancelación de una suscripción cancelada.
¿La suscripción es recurrente o es una suscripción de facturación única?
La próxima fecha de facturación para suscripciones recurrentes o la fecha de vencimiento para suscripciones de facturación única.
Si la suscripción ha sido anulada, reembolsada o devuelta y el número de cada ocurrencia.
El estado de la suscripción.
Códigos de estado:
0: la suscripción está inactiva.
1 - La suscripción está activa pero el cliente ha cancelado la suscripción (se refiere a las suscripciones recurrentes).
2 - La suscripción está activa y el cliente NO ha cancelado su suscripción o la suscripción es una suscripción no periódica.
Reporta la información de descuento de una suscripción de consumidor.
Parámetros obligatorios (X) y opcionales (O)
verDescuentoInfo
clienteSubacc
usandoSubacc
ID de suscripción
retornoXML
Cuenta principal
O
X
X
Cuenta principal con XML
O
X
X
Sub-cuenta
X
X
Subcuenta con XML
X
X
X
Información devuelta
¿La suscripción es elegible para un descuento?
Nota: Los descuentos solo se pueden configurar para suscripciones recurrentes. Además, para ser elegible para un descuento, el precio recurrente de la suscripción debe ser de al menos $ 5.00.
¿Hay un descuento configurado actualmente para la suscripción?
Anula la transacción de un consumidor, si aún es elegible. La transacción del consumidor más actual se puede anular durante un período definido antes de que se liquide la transacción.
Permite un reembolso total o parcial. Pasar la cantidad reembolsará esa cantidad; tenga en cuenta que no se pueden otorgar reembolsos por un monto superior al de la transacción inicial. Omitir el valor dará un reembolso completo por el monto de la transacción inicial.
Intentos de anular la transacción. Si la transacción ya no se puede anular porque ha pasado el período definido, se reembolsará la transacción. Los reembolsos parciales se pueden dar pasando en el cantidad parámetro. Si se transfiere el monto pero la transacción puede anularse, la transacción se anulará. Para emitir reembolsos totales o parciales sin intentar anular la transacción, consulte la ReembolsoTransacción sección de este documento.
Agrega manualmente un usuario a la cuenta. El usuario tendrá acceso al sitio hasta la fecha especificada por el 'endDate' parámetro. Esta opción omite el modelo de suscripción.
Parámetros obligatorios (X) y opcionales (O)
manualAdd
clienteSubacc
usandoSubacc
nombre de usuario del cliente
contraseña del cliente
fecha final
generarRandom
retornoXML
Cuenta principal
X
X
X
X
Cuenta principal con XML
X
X
X
X
X
Sub-cuenta
X
X
X
X
Subcuenta con XML
X
X
X
X
X
Cuenta principal con aleatorio
X
X
X
Cuenta principal con XML y aleatorio
X
X
X
X
Subcuenta con aleatorio
X
X
X
Subcuenta con XML y aleatorio
X
X
X
X
Parámetros opcionales
generarRandom
Cuando se utiliza esta opción, el nombre de usuario y la contraseña se generarán de forma aleatoria y, por lo tanto, no se requieren los parámetros nombre de usuario y contraseña.
custUsername / custPassword
Cuando se pasan estos parámetros, el nombre de usuario y la contraseña se establecerán en los valores respectivos y, por lo tanto, no se generarán aleatoriamente.
Información devuelta
El nombre de usuario que se agregó.
La contraseña que se agregó.
EndDate es la fecha en la que se eliminará el acceso del consumidor.
Los argumentos proporcionados para autenticar al comerciante no eran válidos o faltaban.
-2
El ID de suscripción proporcionado no es válido o el tipo de suscripción no es compatible con la acción solicitada.
-3
No se encontró ningún registro para la suscripción dada.
-4
La suscripción dada no era para la cuenta en la que el comerciante estaba autenticado.
-5
Los argumentos proporcionados para la acción solicitada no eran válidos o faltaban.
-6
La acción solicitada no es válida
-7
Hubo un error interno o un error en la base de datos y la acción solicitada no se pudo completar.
-8
La dirección IP en la que el comerciante intentaba autenticarse no estaba en el rango válido.
-9
La cuenta del comerciante se ha desactivado para su uso en el sistema de enlace de datos o el comerciante no está autorizado a realizar la acción solicitada.
-10
El comerciante no está configurado para usar el sistema Datalink.
-11
La suscripción no es elegible para un descuento, precio recurrente menor a $ 5.00.
-12
El comerciante ha iniciado sesión sin éxito en el sistema 3 o más veces en la última hora. El comerciante debe esperar una hora antes de intentar iniciar sesión nuevamente y se le recomienda que revise la información de inicio de sesión.
El comerciante está intentando autenticarse en la cuenta principal 900100. El clienteSubacc El parámetro no se pasa y, por lo tanto, la autenticación se llevará a cabo en la cuenta principal. La solicitud es para ver el estado de suscripción del ID de suscripción 1000000000. Desde el clienteSubacc no se pasó el parámetro, el ID de suscripción puede ser de cualquier subcuenta de la cuenta 900100. Si se hubiera pasado, el ID de suscripción tendría que ser para la subcuenta especificada. El comerciante solicita que la información se devuelva en formato XML.
Respuesta
1.0 20050223 0 20050324 1 0 20050222162551 1 0
Descripción
La fecha y hora de registro inicial de la suscripción fue el 02/22/2005 a las 04:25:51 PM. Es una suscripción recurrente. La fecha de vencimiento de la suscripción es el 03/24/2005. La suscripción está en estado activo; sin embargo, ha sido cancelado por el cliente el 02/23/2005. No hubo reembolsos, anulaciones, reembolsos o devoluciones de cargo para la suscripción.
Ejemplo 2: Versión CSV - Suscripción con descuento
El comerciante está intentando autenticarse en la subcuenta 0002 que está bajo la cuenta 900100. La solicitud es ver la información de descuento para el ID de suscripción 1000000002. Debido a que el comerciante se está autenticando en la subcuenta 0002, la suscripción debe ser para esa subcuenta. No se pasó un returnXML y, por lo tanto, la información se devolverá en formato CSV.
La información informa que hay un descuento configurado para la suscripción. El tipo de descuento que se configuró para el tipo de suscripción es un descuento por lealtad. El descuento comenzará después de 3 refacturaciones. El descuento es de $ 5.00 (el precio recurrente será de $ 5.00 menos). Se puede aplicar un máximo de 2 descuentos a la suscripción. El intervalo entre los descuentos aplicados es 1 refacturación; este es el número de refacturaciones que deben producirse antes de aplicar descuentos sucesivos. El registro de suscripción inicial se produjo el 02/22/2005.
Este documento es un anexo a la API de CCBill y analiza la configuración del comerciante de la API de CCBill para implementar las ventas de productos tangibles de suscripción.
Alcance
La API de CCBill se considera una característica avanzada del sistema de CCBill. Este documento asume lo siguiente:
El usuario ya ha habilitado la API de CCBill.
El usuario posee habilidades de programación de nivel intermedio a avanzado.
La empresa del usuario vende envíos únicos y / o recurrentes y ha completado todos los procesos necesarios para habilitar dicha función en la cuenta y / o subcuenta.
El usuario tiene acceso a los remitentes admitidos; UPS, USPS y / o FedEx.
Descripción
Se han agregado tres acciones a la API de CCBill, crearCumplimiento, actualizaciónCumplimiento y getFulfillmentStatus. Estas acciones permiten insertar y mantener la información del envío en nuestro sistema.
Estructura de acción
Cada acción realizada a través de la API de CCBill al sistema CCBill debe incluir los parámetros estándar de la API de CCBill aplicables (clienteAccnum, clienteSubacc, usandoSubacc, nombre de usuario, la contraseña, retornoXML- no todos son obligatorios. Ver el Guía de la API de CCBill para obtener más información sobre la estructura básica de la API de CCBill.
Acciones
Las acciones y sus respectivos parámetros se enumeran en esta sección. El sistema de CCBill enviará una respuesta a la acción; las posibles respuestas se definen en la sección Respuesta más adelante en este documento.
crearCumplimiento
El crearCumplimiento La acción le permite insertar información de envío en nuestro sistema. La acción consta de los siguientes parámetros obligatorios:
Parámetro
Propósito
Datos
ID de transacción
Identifica la transacción con la que está asociado el envío.
19-20 caracteres numéricos; subscriptionId o ID asociado con la refacturación.
compañía de envios
Identifica el nombre de la empresa que realiza el envío físico.
Los parámetros permitidos son: 1. UPS (United Parcel Service) 2. USPS (Servicio Postal de los Estados Unidos) 3. FedEx (Anteriormente Federal Express) Estos parámetros distinguen entre mayúsculas y minúsculas.
ID de rastreo
Identifica el número de seguimiento de la empresa que realiza el envío físico.
Para UPS: * 4-20 caracteres alfanuméricos. Para USPS (Clase o servicio de correo (con número de identificación de etiqueta de muestra)): * Express Mail® EA 000 000 000 US * Express Mail International® EC 000 000 000 US * Priority Mail International® CP 000 000 000 US * Global Express Guaranteed® 82 000 000 00 *Correo registrado RA 000 000 000 US *Confirmacion de envio 0000 0000 0000 0000 0000 00Para FedEx: * 12 dígitos numéricos
El actualizaciónCumplimiento La acción le permite actualizar el remitente existente y / o el número de seguimiento para un ID de transacción. Cualquier dato que envíe usando esta acción reemplazará al enviado previamente compañía de envios y ID de rastreo parámetros del anterior crearCumplimiento or actualizaciónCumplimiento acciones y reemplazarlo con los datos que se envían.
Los siguientes parámetros son necesarios para actualizaciónCumplimiento acción:
Parámetro
Propósito
Datos
ID de transacción
Identifica la transacción con la que está asociado el envío.
19-20 caracteres numéricos; subscriptionId o ID asociado con la refacturación.
Identificación del envío
Generado por CCBill y enviado con la respuesta createFulfillment original y utilizado para identificar el envío.
Caracteres numéricos de longitud variable, nunca más de 20 caracteres.
compañía de envios
Identifica el nombre de la empresa que realiza el envío físico.
Los parámetros permitidos son: 1. UPS (United Parcel Service) 2. USPS (Servicio Postal de los Estados Unidos) 3. FedEx (Anteriormente Federal Express) Estos parámetros distinguen entre mayúsculas y minúsculas.
ID de rastreo
Identifica el número de seguimiento de la empresa que realiza el envío físico.
Para UPS: * 4-20 caracteres alfanuméricos. Para USPS (Clase o servicio de correo (con número de identificación de etiqueta de muestra)): * Express Mail® EA 000 000 000 US * Express Mail International® EC 000 000 000 US * Priority Mail International® CP 000 000 000 US * Global Express Guaranteed® 82 000 000 00 *Correo registrado RA 000 000 000 US *Confirmacion de envio 0000 0000 0000 0000 0000 00Para FedEx: * 12 dígitos numéricos
El getFulfillmentStatus La acción le permite consultar el sistema CCBill para obtener datos de cumplimiento almacenados previamente para una transacción.
El getFulfillmentStatus action utiliza los siguientes parámetros:
Parámetro
Propósito
Datos
ID de transacción
Identifica la transacción con la que está asociado el envío.
19-20 caracteres numéricos; subscriptionId o ID asociado con la refacturación.
Identificación del envío
Generado por CCBill y enviado con la respuesta createFulfillment original y utilizado para identificar el envío.
Parámetro opcional. Caracteres numéricos de longitud variable, nunca más de 20 caracteres.
Las respuestas correctas se devolverán con algunos o todos los siguientes parámetros:
Respuesta
Propósito
Datos
ID de rastreo
Identifica el número de seguimiento de la empresa que realiza el envío físico.
Para UPS: * 4-20 caracteres alfanuméricos. Para USPS (Clase o servicio de correo (con número de identificación de etiqueta de muestra)): * Express Mail® EA 000 000 000 US * Express Mail International® EC 000 000 000 US * Priority Mail International® CP 000 000 000 US * Global Express Guaranteed® 82 000 000 00 *Correo registrado RA 000 000 000 US *Confirmacion de envio 0000 0000 0000 0000 0000 00Para FedEx: * 12 dígitos numéricos
Identificación del envío
Generado por CCBill y enviado con la respuesta createFulfillment original y utilizado para identificar el envío.
Parámetro opcional. Caracteres numéricos de longitud variable, nunca más de 20 caracteres.
fecha de creación
La fecha y hora en que se creó el registro.
2010-06-01T15:27:11.529-07:00 AAAA-MM-DDTHH: mm: ss.lllooo: 00 * AAAA es el año de 4 dígitos $$$ * MM es el mes de 2 dígitos * DD es el día de 2 dígitos * HH es la hora de 2 dígitos * mm es el minuto de 2 dígitos * ss es el segundo de 2 dígitos * lll son los milisegundos de 3 dígitos * ooo: 00 es el desplazamiento GMT (IE -07: 00 es GMT-7)
nextCheckTime
La próxima vez, el sistema CCBill comprobará el estado del envío.
2010-06-01T15:27:11.529-07:00 AAAA-MM-DDTHH: mm: ss.lllooo: 00 * AAAA es el año de 4 dígitos $$$ * MM es el mes de 2 dígitos * DD es el día de 2 dígitos * HH es la hora de 2 dígitos * mm es el minuto de 2 dígitos * ss es el segundo de 2 dígitos * lll son los milisegundos de 3 dígitos * ooo: 00 es el desplazamiento GMT (IE -07: 00 es GMT-7)
anteriorEnvíoId
Permite a los clientes recuperar información de envío almacenada previamente para una transacción; siempre el más reciente.
Caracteres numéricos de longitud variable, nunca más de 20 caracteres.
checkStatusURL
La URL que utiliza CCBill para verificar el estado del envío.
http://www.shipperurl.com/
ccbillEnvíoEstado
El código de estado que utiliza CCBill para los envíos.
*Mira la sección: Códigos de estado más adelante en este documento para obtener una lista de los códigos de estado de CCBill y sus significados.
compañía de envios
Identifica el nombre de la empresa que realiza el envío físico.
Los parámetros permitidos son: *UPS (United Parcel Service)
El estado inicial de cada Envío que aparece cuando la información de cumplimiento no se ha agregado o no se ha agregado correctamente.
PENDIENTE
Indica que los datos de cumplimiento ingresados por el cliente están esperando ser enviados al remitente para su primera verificación de estado; Se ingresaron los datos de cumplimiento, pero el período de espera de 8 horas para la verificación inicial del remitente aún no ha pasado.
ENVIADO
Este es el estado que indica que un Envío está con el remitente pero aún no lo ha recibido el consumidor.
ENVÍO_ERROR
La empresa de envío ha devuelto un error similar a "estado no disponible" en nuestro sistema durante la verificación de estado más reciente.
Delivered
La empresa de envío nos ha devuelto un estado que indica que el envío ha sido entregado al destinatario.
NO_ENTREGABLE
Indica que un envío no se puede entregar al consumidor por algún motivo, incluidos errores de dirección y rechazos.
DESPEJADO
Un miembro del personal de CCBill borró el estado y lo estableció como OK.
Error
Los errores pueden deberse a varios motivos, siendo los más habituales los errores de validación de datos. A continuación, se muestra una lista de la validación de datos realizada por las funciones de suscripción tangibles:
Se verifica la exactitud del número de cuenta del comerciante, el número de subcuenta, el ID de suscripción o el ID de transacción.
La identificación de seguimiento y el remitente deben estar presentes.
El ID de transacción proporcionado pertenece a la cuenta del comerciante (y la subcuenta, si corresponde).
La identificación de seguimiento proporcionada debe coincidir con uno de los formatos aceptados por el remitente (proporcionado arriba).
Una respuesta de error suele contener dos parámetros:
errorDesc: Esta es una descripción del error que recibió su acción de nuestro sistema.
código de error: Este es el número de código en el que se almacena el error en nuestro sistema.
Todos los posibles errores, junto con la información de solución de problemas, se incluyen en esta tabla:
errorDesc
código de error
Descripción
ERROR_SERVICE_ERROR
-200
Este es un código de error genérico y generalmente indica que el servicio no está disponible temporalmente.
ERROR_MISSING_PARAM
-201
Uno de los parámetros necesarios para la función no se incluyó en la acción. Consulte el cuadro anterior para conocer los parámetros necesarios para la acción que está intentando realizar y verifique que el formato de su acción esté correctamente construido.
ERROR_NO_COINCIDIR_ENVÍO
-202
El parámetro shippingId contiene información de identificación de envío desconocida / no coincidente.
ERROR_INVALID_TRACKING_NUMBER
-203
El parámetro trackingId contiene información no válida. Verifique que el trackingId contenga todos los caracteres esperados, coincida con el formato esperado para el parámetro shippingCompany (consulte la tabla anterior) y verifique el trackingId en el recibo de envío proporcionado por su compañía de envío.
ERROR_NO_COINCIDIR_TRANSACCIÓN
-204
El transactionId proporcionado en la acción no coincide con ningún transactionId previamente conocido para su número de cuenta (y número de subcuenta, si corresponde). Verifique el transactionId y vuelva a enviarlo, si es necesario.
Publicación de fondo
Este documento se proporciona como recurso técnico para los comerciantes de CCBill. Se analizan las características y la implementación del sistema CCBill Background Post. Este documento está destinado a programadores, técnicos y otras personas con habilidades de codificación avanzadas.
Descripción
La publicación de antecedentes de CCBill es un método para pasar datos entre el sistema del comerciante y el sistema de CCBill. La publicación en segundo plano tiene básicamente dos propósitos:
Pase los datos del consumidor al formulario de registro de CCBill. Esto se puede utilizar para completar previamente los datos del consumidor en el formulario o pasar parámetros de seguimiento personalizados que se enviarán a las URL de publicación de aprobación / denegación (ver más abajo). Más adelante en este documento se proporciona una lista de variables del sistema CCBill estándar, que se utilizan para completar previamente los datos del consumidor.
Pasar datos a una URL de publicación de aprobación o una URL de publicación de denegación, dependiendo del resultado de la transacción. Las URL de aprobación y denegación son secuencias de comandos codificadas a medida que capturan los datos de publicación devueltos de CCBill y los procesan de acuerdo con la codificación de la secuencia de comandos. Las URL de publicación de aprobación y denegación están codificadas por el comerciante y son necesarias para utilizar el sistema de publicación en segundo plano. Esta guía discutirá las posibles aplicaciones de estas URL. Para obtener más información sobre cómo configurar las URL de publicación de aprobación y denegación, consulte el archivo de ayuda de CCBill.
Estas dos aplicaciones del sistema de Publicaciones en segundo plano se excluyen mutuamente y no se requiere que ninguna use la otra.
Soporte TLS
La publicación en segundo plano admite el protocolo de seguridad TLS 1.2. Si tiene dificultades y no recibe publicaciones de CCBill, verifique qué protocolo TLS está utilizando.
Pasar variables al formulario de registro
Las variables se pueden pasar al formulario de registro para completar previamente la información del consumidor. Esto se puede implementar con el propósito de formularios de varias partes, seguimiento personalizado y otras implementaciones. Las variables se pasan al formulario de suscripción desde la página que lo precede mediante el uso de un formulario HTML o pasando las variables a través de la cadena URL. A continuación se ofrecen ejemplos de código.
Las variables de seguimiento personalizadas también se pueden enviar al formulario. Estos valores se volverán a publicar mediante la publicación en segundo plano cuando se complete la transacción. Para definir estas variables, simplemente especifique un nombre de variable y un valor de la misma manera que las otras variables que se pasan.
Para completar previamente el formulario, primero debe generar código HTML para el formulario dentro del Administrador de CCBill. (Para obtener más información sobre cómo generar este código, consulte el archivo de ayuda de CCBill). Después de generar su código, las variables de seguimiento personalizadas opcionales se pueden agregar manualmente creando campos de formulario HTML adicionales o pasando las variables adicionales a la cadena de URL, según el método de envío elegido. El siguiente ejemplo muestra el código de botón HTML básico, con dos variables personalizadas agregadas. El botón creado, cuando se haga clic, llevará al consumidor al formulario de registro de CCBill mientras pasa las dos variables personalizadas:
customVarName1 y customVarName2 son solo nombres de ejemplo y pueden ser cualquier cosa que elija. Los valores también son un ejemplo. Puede utilizar un enlace de texto en lugar de un botón. El siguiente ejemplo muestra cómo hacer esto usando datos idénticos a los del ejemplo de formulario anterior:
Ambos métodos tienen el mismo propósito y se pueden utilizar.
La información también se puede pasar al formulario de registro de CCBill utilizando variables dinámicas en un script personalizado. Un formulario HTML personalizado puede llamar al script, que luego envía las variables al formulario de suscripción de CCBill. Los datos fluyen en esta ruta:
El formulario que cree pasará los datos ingresados por el consumidor al siguiente formulario, que luego pasará las variables al formulario de registro de CCBill. Una vez completada la transacción, los datos se enviarán a la URL de publicación de aprobación o denegación. El siguiente ejemplo de código usa código Perl / CGI para generar un campo de formulario HTML oculto usando una variable dinámica:
impresión " ";
Otros lenguajes tendrán diferentes declaraciones y sintaxis para la salida de datos, como declaraciones de impresión o eco en PHP. El código de enlace se puede generar de manera similar al código de formulario HTML anterior, reemplazando cualquier número de valores de variables estáticas con variables dinámicas. Consulte cualquier pregunta que tenga acerca de este tipo de código a un programador calificado.
Publicaciones de aprobación y denegación
Cuando se aprueba o deniega una transacción, los datos se enviarán a la URL de aprobación o denegación, respectivamente. Los datos enviados incluirán todo lo que se pasó al formulario de registro a través de la publicación de antecedentes junto con los datos ingresados en el formulario de pago por el consumidor, excluyendo la información de pago. Estos datos se pueden analizar y manejar de cualquier forma que se codifique el script.
Los datos se pueden capturar de varias formas según el idioma en el que esté escrito el guión de aprobación o denegación. Por ejemplo:
Usando PHP, la línea $fname = $_POST%22customer_fname%22capturará el nombre del consumidor y lo asignará a una variable llamada $fname. La variable $fnamese puede nombrar como quieras.
Usando Perl / CGI, la línea <strong>$fname = param("customer_fname")__</strong> capturará el nombre del consumidor y lo asignará a una variable llamada <strong>$fname</strong>. La variable <strong>$fname</strong> se puede nombrar como quieras.
Otros lenguajes tendrán funciones apropiadas para capturar datos POST. Una lista completa de las variables de CCBill está disponible más adelante en este documento. Tenga en cuenta que los nombres de las variables deben ingresarse exactamente como aparecen en este documento.
Una vez que la secuencia de comandos captura estos valores variables, la secuencia de comandos puede manejar los datos de cualquier manera especificada en la secuencia de comandos, como ingresar la información en una base de datos. La imagen ilustra el proceso de envío y recepción de datos mediante las URL de aprobación y denegación:
Variables
La publicación en segundo plano contiene un conjunto de variables de sistema específicas que se pueden utilizar para extraer datos del sistema de CCBill. Se utilizan dos conjuntos de variables, uno para cada una de las siguientes situaciones:
Formulario de registro. Estas variables se utilizan para rellenar previamente el formulario de registro. Nombrar las variables correctamente, como se enumera a continuación, garantizará que los datos se almacenen correctamente en el sistema de CCBill como se pretende con las variables.
Postback. Estas variables se envían a las URL de publicación de aprobación o denegación, según el resultado de la transacción.
En ambos casos, las variables personalizadas se enviarán exactamente como se ingresaron. Los nombres de las variables del sistema deben ingresarse exactamente como aparecen en esta lista.
Formulario de registro
El siguiente cuadro enumera cada variable que se puede completar previamente en el formulario de registro:
Nombre de la variable
Descripción
nombre_cliente
Nombre del consumidor
nombre_cliente
Apellido del consumidor
address1
Dirección del consumidor
correo electrónico,
Dirección de correo electrónico del consumidor
ciudad
Ciudad consumidora
estado
Estado del consumidor
código postal
Código postal del consumidor
país
País consumidor
número de teléfono
Número de teléfono del consumidor
nombre de usuario
Nombre de usuario del consumidor
la contraseña
Contraseña de consumidor
LifeTimeSubscription
Las siguientes variables también se pueden pasar al formulario de registro, pero no se muestran en el formulario:
Nombre de la variable
Descripción
Valor de ejemplo
ccbill_referer
Número de identificación de afiliado de CCBill. Este valor se pasa como 'revendedor' cuando se usa Traffic Manager para pasar en cascada a los formularios de Epoch.
1626321
nombre del formulario
Código de tres o más caracteres que identifica el formulario.
13cc
confirmar Contraseña
Confirme la contraseña en el formulario de registro.
0 o 1 (sí o no)
suscripciónTypeId
ID de tipo de suscripción.
0108191202000001259
tipos permitidos
Las opciones de suscripción que aparecerán en el formulario; este valor se genera automáticamente en el Admin.
0000003761: 840,0000004607: 840
Postback
Las variables que se enumeran a continuación se vuelven a publicar en las URL de publicación de aprobación o denegación:
Nombre de la variable
Descripción
Tipo de datos (longitud máxima)
Valor de ejemplo
cantidad contable
Precio de pago real en USD que el comerciante recibirá por la compra.
decimal (9,2)
14.83
address1
Dirección del consumidor.
varchar (30)
123 Main Street
filial
Referente no personalizado para transacciones heredadas; cuentas que no son CCBill (EC Suite, etc.)
cadena
1234567
identificación del afiliado
Identificación de participación en el programa.
cadena
3542
sistema_de_filiados
-1– No disponible, recuperar de DataLink 1 - CCBill 2 - Afiliado de WMS 3 - Varios 4 - Rastreador WMS
numérico
-1
tipos permitidos
Valor utilizado para determinar las opciones de precios en el formulario de registro.
N / A (sin límite)
moneda base
Moneda en la que se configuró el precio.
int (3)
840
tipo de tarjeta
Tipo de tarjeta de crédito utilizada.
cadena
VISA o MASTERCARD
ccbill_referer
Número de identificación de afiliado de CCBill. Este valor se pasa como 'revendedor' cuando se usa Traffic Manager para pasar en cascada a los formularios de Epoch.
cadena
1626321
ciudad
Ciudad consumidora.
varchar (30)
Anytown
clienteAccnum
Número de cuenta principal del comerciante de CCBill.
mediumint (6) sin firmar
900100
liquidación impulsada por el cliente
Refleja si la transacción fue aprobada previamente o no mediante un Acuerdo impulsado por el comerciante.
booleano
1 o 0 (sí o no, respectivamente)
clienteSubacc
Número de subcuenta de cliente de CCBill.
smallint (4) zerofill sin firmar
0000
consumidorUniqueId
Número de identificación de consumidor único.
bigint (20)
no firmado
país
País consumidor.
varchar (30)
US
código de moneda
Moneda de tres dígitos en la que se facturó al consumidor.
int (3)
978
nombre_cliente
Nombre del consumidor.
varchar (20)
Juan
nombre_cliente
Apellido del consumidor.
varchar (30)
Smith
ID de negación
El número que identifica la transacción rechazada de un consumidor. NOTA: Este número solo se proporciona con los rechazos y está en blanco con las aprobaciones.
bigint (20) sin firmar
111140501000005157
correo electrónico,
Dirección de correo electrónico del consumidor.
varchar (40)
user@example.com
nombre del formulario
Código de tres o más caracteres para el formulario.
char (255)
13cc
Precio con formato inicial
Precio inicial con entidad HTML para el símbolo de moneda.
cadena
$10.00
periodo inicial
El período inicial de la suscripción (en días).
smallint (4) sin firmar
7
precio inicial
El precio inicial de la suscripción.
decimal (9,2)
4.99
dirección IP
Dirección IP del consumidor.
varchar (31)
192.168.27.4
LifeTimeSubscription
Indica si la transacción es una suscripción de por vida. No se publica si no es positivo.
int
1
la contraseña
Contraseña de consumidor.
varchar (30)
micontraseña
Cuenta de pago
Resumen de hash de la información de facturación del consumidor.
cuerda (32)
e1w4858fgb34e5ab2b0e8bd94cb09565
número de teléfono
Número de teléfono del consumidor; aparece como ingresado por el consumidor.
varchar (20)
(123) 456-7890
precio
Precio del producto en formato HTML como se muestra en el formulario.
cadena
& 36; 5.95 por 30 días (no recurrente)
productoDesc
Descripción del producto.
varchar (50)
motivo de rechazo
El motivo del rechazo (solo URL de publicación de denegación). Descripción de texto de reasonForDeclineCode. Consulte la sección "Códigos de rechazo de devolución" a continuación para obtener una lista completa de códigos.
cadena
El ID de suscripción proporcionado no es válido (Consulte la sección Códigos de rechazo de devolución al final de este documento para obtener una lista completa de los códigos de rechazo y sus descripciones de motivos).
ratioForDeclineBeforeOverride
El error de motivo de rechazo que aparece cuando se rechazó una transacción y luego se aprobó mediante Web Verify.
Cordón
La transacción requiere aprobación adicional: consulte su correo electrónico de confirmación para obtener más instrucciones. (Consulte la sección Códigos de rechazo de devolución al final de este documento para obtener una lista completa de los códigos de rechazo y sus descripciones de motivos).
ratioForDeclineCode
Código de rechazo numérico (solo URL de publicación de rechazo).
cadena
16 (Consulte la sección Códigos de rechazo de devolución al final de este documento para obtener una lista completa de los códigos de rechazo y sus descripciones de motivos).
ratioForDeclineCodeBeforeOverride
El código de error del motivo del rechazo que aparece cuando se rechazó una transacción y luego se aprobó mediante Web Verify.
45 (Consulte la sección Códigos de rechazo de devolución al final de este documento para obtener una lista completa de los códigos de rechazo y sus descripciones de motivos).
refacturaciones
El número total de nuevas facturas. Un valor de '99' se volverá a facturar indefinidamente.
tinyint (2) sin firmar
12
Precio con formato recurrente
Precio recurrente con entidad HTML para el símbolo de moneda.
cadena
$19.95
período recurrente
El período de la suscripción (recurrente, en días).
smallint (4) sin firmar
30
Precio recurrente
El precio de la suscripción (recurrente).
decimal (7,2)
19.99
árbitro
Número de identificación de no afiliado de CCBill. Esta variable es utilizada principalmente por sistemas de terceros.
varchar (16)
1626321
ReferUrl
URL desde la que se hizo referencia a la transacción.
cadena
http://www.example.com
bookingId
Número de identificación de reserva de suscripción del consumidor.
bigint (20) sin firmar
0109072310330002423
resumen de respuesta
Resumen de hash de una respuesta de precios dinámicos. Si no utiliza el precio dinámico, este valor se devolverá como una cadena en blanco.
cuerda (32)
s4f5198jgd21a4pk1p2s7sd23lm58937
start_date
Fecha de inicio de la suscripción.
datos
2008-08-05 15:18:17
estado
Estado consumidor.
varchar (20)
AZ
ID de suscripción
Número de identificación de suscripción (solo URL de publicación de aprobación).
bigint (20) sin firmar
1000000000
ID de tipo
Número de identificación del tipo de suscripción que identifica el punto de precio utilizado en la transacción.
int (10)
0000060748
nombre de usuario
Nombre de usuario del consumidor.
varchar (16)
username1
código postal
Código postal del consumidor.
varchar (10)
85251
Otros servicios de CCBill, cuando se utilizan, devolverán variables adicionales mediante la publicación en segundo plano. Para obtener más información sobre las variables devueltas, consulte la Guía del usuario de ese servicio.
Códigos de rechazo de devolución de datos
La siguiente tabla enumera los valores potenciales para el ratioForDeclineCode parámetro y sus relacionados motivo de rechazo respuestas de texto.
ratioForDeclineCode
motivo de rechazo
1
El sitio web no está disponible para registrarse
2
No se pueden determinar los requisitos de registro en el sitio web
3
No se acepta tu tipo de tarjeta, prueba con otro tipo de tarjeta de crédito
4
Error del sistema bancario
5
La tarjeta de crédito que ingresaste no es válida
6
Verifique para asegurarse de haber ingresado su fecha de vencimiento Se utiliza para mostrar las fechas anuales, mensuales o diarias correspondientes individuales para los datos del informe. El formato de la función de fecha es año-mes-día; por ejemplo, 2002-01-01.
7
Verifique para asegurarse de haber ingresado su número de cuenta bancaria correctamente
8
Verifique para asegurarse de haber ingresado correctamente el número de ruta de su banco
9
Error del sistema bancario, inténtelo de nuevo
10
El sitio web tiene un precio no válido
11
Transaccion rechazada
12
Actualmente tiene una suscripción y no puede registrarse
13
Ya ha tenido una prueba gratuita
14
Debe ingresar su número CVV2 en el reverso de su tarjeta
15
Su cuenta se está procesando actualmente, consulte el sitio web al que se está uniendo para ver si tiene acceso. Si no, por favor contacte support@ccbill.com
16
El ID de suscripción proporcionado no es válido
17
El ID de suscripción no existe en el sistema
18
Se rechazó el intento de transacción anterior en la solicitud
19
No está autorizado para registrarse con las credenciales proporcionadas
20
Sin declive
21
Ya tuvo una prueba, seleccione una opción de membresía recurrente normal
22
Se produjo un error al comunicarse con el banco. Vuelva a intentarlo más tarde.
23
Se proporcionó una tarjeta de crédito no válida
24
Transacción denegada por el banco
25
Error bancario
26
Configuración de procesamiento de tarjetas incorrecta para el comerciante
27
Error del sistema, por favor, inténtalo de nuevo
28
No podemos procesar su transacción en este momento. Porfavor intente más tarde
29
Tarjeta caducada
30
No podemos facturar el número de teléfono proporcionado para esta transacción. Regrese al sitio web y elija un método de pago alternativo
31
Fondos insuficientes
32
Debe proporcionar CVV2 para completar la transacción
33
No se pudo determinar el tipo de transacción
34
Se produjo un error al comunicarse con el banco. Vuelva a intentarlo más tarde.
35
Tarjeta rechazada en Pre-Auth SC
36
No se puede contactar con el banco
37
Actualmente no procesamos para su bandeja de bancos
38
Transacción rechazada por el banco emisor
39
Has enviado demasiadas veces hoy.
40
Este comerciante no acepta la tarjeta que está utilizando
41
Comerciante inactivo
42
Dirección incorrecta proporcionada
43
No podemos procesar su transacción de facturación telefónica porque su proveedor solo permite un cargo, por número de teléfono, por día, y nuestros registros muestran que tiene un cargo diario existente para este número de teléfono. Regrese al sitio web y elija un método de pago alternativo
44
Lo sentimos, en este momento no se permiten tarjetas prepagas. Prueba con otro tipo de tarjeta
45
La transacción requiere aprobación adicional: consulte su correo electrónico de confirmación para obtener más instrucciones
La dirección de correo electrónico supera el límite de transacciones de ACH
51
Procesador no compatible con CDS
52
La transacción TGS ya ha sido capturada
53
Supera el límite de reembolso
54
La transacción ya ha sido anulada
55
La transacción ya ha sido reembolsada.
56
Tarjeta de Credito invalible
57
El precio inicial supera el máximo
58
Precio inicial por debajo del mínimo
59
El precio recurrente supera el máximo
60
Precio recurrente por debajo del mínimo
61
Error del sistema al crear la tarjeta de crédito de la tienda
62
La cuenta de pago supera la regulación del número de transacción
63
La cuenta de pago excede el límite de cantidad de transacción
64
Falló la autenticación 3DS
Intervalos de IP de publicación en segundo plano
Recibirá Publicaciones en segundo plano de los siguientes rangos de IP de CCBill:
64.38.240.0/24
64.38.241.0/24
64.38.212.0/24
64.38.215.0/24
Puede usar esta información para configurar reglas de firewall o confirmar la validez de una IP desde su aplicación.
Complemento de seguridad de WordPress e iThemes
Si usa estas funciones en una instalación de WordPress y en el complemento de seguridad de iThemes, es posible que tenga problemas para recibir publicaciones de CCBill.
Siga estos pasos para resolver el problema:
Inicie sesión en WordPress Página Web.
Haga clic en Configuración de seguridad.
Haga clic en Usuarios prohibidos.
Desmarcar el Habilitar Función de lista negra de HackRepair.com.
Reenvío de publicaciones fallidas
El sistema de Publicaciones en segundo plano reenvía automáticamente las publicaciones fallidas hasta 30 veces en el transcurso de unas pocas horas. Si no recibe publicaciones, no tenemos forma de reenviarlas más allá de eso.
Si está experimentando muchas publicaciones fallidas, verifique que no esté experimentando un problema de conexión como problemas con su empresa de alojamiento, entre otras cosas. Luego, comuníquese con Soporte para comerciantes y haremos todo lo posible para ayudarlo a encontrar una solución.
