Esquemas de la API RESTful de CCBill

Resumen de la API

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.

Tipos de medios admitidos
  • aplicación / json
Valores disponibles
  • aplicación/vnd.mcn.transaction-service.api.v.1+json
  • aplicación/vnd.mcn.transaction-service.api.v.2+json

Recursos de la API

/ fichas de pago

  • / fichas-de-pago / solo-comerciante
  • / fichas-de-pago / solo-comerciante-verificar
  • / fichas-de-pago / {paymentTokenId}
  • /pago-fichas/{pagoTokenId}/tres-requeridos
  • /pago-tokens/programa-especificado
  • /tokens-de-pago/cliente-objetivo
  • /tokens-de-pago/tres-requeridos

/actas

  • / transaction / payment-tokens / {payment_token_id}
  • / transaction / payment-tokens / {payment_token_id}
  • /transacciones/fichas-de-pago/tres/{pago_token_id}

Esquemas de API

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ÁMETROTIPODESCRIPCIÓN
campocadena
(requerido)
El campo en error.
mensajecadena
(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 ERRORDESCRIPCIÓN
400La respuesta no se pudo completar debido a un encabezado / parámetro no válido en la solicitud.
401La respuesta no pudo completarse debido a un problema de autorización.
403No se pudo completar la respuesta porque el acceso al recurso está prohibido.
404La respuesta no se pudo completar debido a un recurso no válido.
405La respuesta no se pudo completar debido a un método de solicitud no válido.
406La respuesta no se pudo completar debido a un tipo de medio inaceptable en la solicitud.
415La respuesta no se pudo completar debido a un tipo de medio no compatible en la solicitud.
500La respuesta no se completó de alguna manera.
Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
idcadena
(requerido)
GUID generado aleatoriamente.
Patrón de validación: ^[a-zA-Z0-9-]*$
urlcadena
(requerido)
La URL relativa que ha causado este error.
erroresmatriz
(opcional)
Opcional, solo se devuelve en 400 errores de solicitud incorrecta para errores de validación.
errores. campocadena
(requerido)
El campo en error.
errores. mensajecadena
(requerido)
Mensaje fácil de usar.
mensaje generalcadena
(requerido)
Algo legible por humanos.
código de errorCadena de información de pago con tarjeta de crédito
(requerido)
Código de error definido por el producto.
Patrón de validación: ^[0-9]*$
fecha y horaFecha y hora
(requerido)
Marca de tiempo de la llamada.

Ejemplo de error

{
	"id": "62432dd8-97d9-400a-8da8-4a5c1951f935",
	"url": "/songs/0",
	"errors": [],
	"generalMessage": "An error occurred, please try again later.",
	"errorCode": "100019",
	"timestamp": "2022-12-27T10:36:38.067Z"
}

Información de pago con tarjeta de crédito

Elementos del información de pago formación.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
número de tarjetacadena
(requerido)
Número de tarjeta.
expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato
nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.

Ejemplo de información de pago de tarjeta de crédito

{
  "cardNum": "4473707989493598",
  "expMonth": "04",
  "expYear": "2026",
  "nameOnCard": "Tyler Thomas"
}

Tarjeta de crédito con información de pago Cvv

Elementos del información de pago matriz con autenticación CVV2.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
número de tarjetacadena
(requerido)
Número de tarjeta.
expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.
cvv2cadena
(requerido)
Código CVV2 en la tarjeta.

Ejemplo de CreditCardWithCvvPaymentInfo

{
  "cardNum": "4473707989493598",
  "expMonth": "04",
  "expYear": "2026",
  "nameOnCard": "Tyler Thomas"
  "cvv2": "144"
}

Información del cliente

Elementos del Información del cliente formación.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
emailcadena
(requerido)
Dirección de correo electrónico del cliente.
navegadorHttpAceptarIdiomacadena
(opcional)
Lista de lenguajes humanos aceptables para la respuesta.
navegadorHttpUserAgentcadena
(opcional)
La cadena de agente de usuario del agente de usuario.
ciudadcadena
(requerido)
Ciudad del cliente.
navegadorHttpAceptarcadena
(opcional)
Tipos de medios que son aceptables para la respuesta.
estadocadena (requerido)Estado del cliente.
código postalcadena
(requerido)
Código postal del cliente.
clienteFnamecadena
(requerido)
Nombre del cliente.
address1cadena
(requerido)
Dirección del cliente.
address2cadena
(opcional)
Dirección del cliente (información adicional).
navegadorHttpAcceptEncodingcadena (opcional)Lista de codificaciones aceptables.
nombre del clientecadena
(requerido)
Apellido del cliente.
dirección IPcadena
(requerido)
Dirección IP del cliente.
número de teléfonocadena
(opcional)
Número de teléfono del cliente.
paíscadena
(requerido)
País del cliente.

Ejemplo de información de cliente

{
  "email": "tthomas@xyz.com",
  "browserHttpAcceptLanguage": "en-US,en;q=0.5",
  "browserHttpUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:60.0) Gecko/20100101 Firefox/60.0",
  "city": "Tempe",
  "browserHttpAccept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
  "state": "AZ",
  "zipcode": "85281",
  "customerFname": "Tyler",
  "address1": "Woodland Drive",
  "address2": "Apt 21",
  "browserHttpAcceptEncoding": "gzip, deflate, br",
  "customerLname": "Thomas",
  "ipAddress": "10.70.60.14",
  "phoneNumber": "5555555555",
  "country": "US"
}

Pasar a través de información

Elementos del pasarA Través deInfo La matriz representa información emparejada personalizada que se pasa al servicio de transacciones.

Recursos
Parámetros
PARÁMETROTIPODESCRIPCIÓN
nombre cadena
(requerido)
Valor de traspaso personalizado.
propuesta decadena
(requerido)
Valor de traspaso personalizado.

Ejemplo de PassThroughInfo

{
  "name": "value1",
  "value": "value2"
}

Información de pago

Información de pago en la tarjeta de pago del cliente. elementos de la información de pago de la tarjeta de crédito formación.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
información de pago de la tarjeta de créditoobjeto
(formación)
Información de pago con tarjeta de crédito.
información de pago con tarjeta de crédito. número de tarjetacadena
(requerido)
Número de tarjeta.
información de pago con tarjeta de crédito. expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
información de pago con tarjeta de crédito. expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
información de pago con tarjeta de crédito. nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.

Ejemplo de información de pago

{
  "creditCardPaymentInfo": {
    "cardNum": "4473707989493598",
    "expMonth": "04",
    "expYear": "2026",
    "nameOnCard": "Tyler Thomas"
  }
}

InformaciónDePagoConCVV

Elementos del información de pago de la tarjeta de crédito matriz con autenticación CVV2.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
información de pago de la tarjeta de créditoobjeto
(formación)
Información de pago con tarjeta de crédito.
información de pago con tarjeta de crédito. número de tarjetacadena
(requerido)
Número de tarjeta.
información de pago con tarjeta de crédito. expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
información de pago con tarjeta de crédito. expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
información de pago con tarjeta de crédito. nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.
información de pago con tarjeta de crédito. cvv2cadena
(requerido)
Código CVV2 en la tarjeta.

Ejemplo de información de pago con CVV

{
  "creditCardPaymentInfo": {
    "cardNum": "4473707989493598",
    "expMonth": "04",
    "expYear": "2026",
    "nameOnCard": "Tyler Thomas",
    "cvv2": "144"
  }
}

token de pago

Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago.

  • aplicación/vnd.mcn.transaction-service.api.v.1+json
Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
Fecha y hora de creaciónSolo fecha y hora
(requerido)
Fecha y Hora de creación del Token de Pago.
tiempo para vivirentero
(requerido)
Tiempo para que exista el token.
originalPagoTokenIdcadena
(opcional)
Referencia a una identificación de token anterior.
NúmeroVálidoDeUsoentero
(requerido)
El número total de veces que se puede usar el token de pago para compras.
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
ID de participación del programaentero
(requerido)
El programa conectado al token de pago.
Id. de token de pagocadena
(requerido)
Representación compleja del Id. del token de pago.
PaymentInfoIdcadena
(opcional)
Información asociada al pago.
ID de suscripciónentero
(requerido)
Identificación de la suscripción asociada a la transacción.

Ejemplo de token de pago

{
	"paymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"programParticipationId": 1,
	"originalPaymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"createdDatetime": "2022-01-01T01:00:00",
	"timeToLive": 30,
	"validNumberOfUse": 20,
	"subscriptionId": 900000000000000001,
	"paymentInfoId": "53104f5a54d3d43254def41c29aedba8"
}

PagoTokenV2

Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago.

  • aplicación/vnd.mcn.transaction-service.api.v.2+json
Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
Fecha y hora de creaciónSolo fecha y hora
(requerido)
Fecha y Hora de creación del Token de Pago.
tiempo para vivirentero
(requerido)
Tiempo para que exista el token.
originalPagoTokenIdcadena
(opcional)
Referencia a una identificación de token anterior.
NúmeroVálidoDeUsoentero
(requerido)
El número total de veces que se puede usar el token de pago para compras.
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
ID de participación del programaentero
(requerido)
El programa conectado al token de pago.
Id. de token de pagocadena
(requerido)
Representación compleja del Id. del token de pago.
PaymentInfoIdcadena
(opcional)
Información asociada al pago.
ID de suscripcióncadena
(requerido)
Identificación de la suscripción asociada a la transacción.

Ejemplo de PaymentTokenV2

{
	"paymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"programParticipationId": 1,
	"originalPaymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"createdDatetime": "2022-01-01T01:00:00",
	"timeToLive": 30,
	"validNumberOfUse": 20,
	"subscriptionId": "900000000000000001",
	"paymentInfoId": "53104f5a54d3d43254def41c29aedba8"
}

PagoTokenVerificar

Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago. Incluyendo resultados de autenticación CVV2 y AVS.

  • aplicación/vnd.mcn.transaction-service.api.v.1+json
Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
Fecha y hora de creaciónSolo fecha y hora
(requerido)
Fecha y Hora de creación del Token de Pago.
tiempo para vivirentero
(requerido)
Tiempo para que exista el token.
originalPagoTokenIdcadena
(opcional)
Referencia a una identificación de token anterior.
NúmeroVálidoDeUsoentero
(requerido)
El número total de veces que se puede usar el token de pago para compras.
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
ID de participación del programaentero
(requerido)
El programa conectado al token de pago.
avsRespuestacadena
(requerido)
El resultado de la verificación AVS.
Id. de token de pagocadena
(requerido)
Representación compleja del Id. del token de pago.
PaymentInfoIdcadena
(opcional)
Información asociada al pago.
cvv2Respuestacadena
(requerido)
El resultado de la verificación CVV2.
ID de suscripciónentero
(requerido)
Identificación de la suscripción asociada a la transacción.

Ejemplo de verificación de token de pago

{
	"paymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"programParticipationId": 1,
	"originalPaymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"createdDatetime": "2022-01-01T01:00:00",
	"timeToLive": 30,
	"validNumberOfUse": 20,
	"subscriptionId": "900000000000000001",
	"paymentInfoId": "53104f5a54d3d43254def41c29aedba8",
	"cvv2Response": "M",
	"avsResponse": "Y"
}

PagoTokenVerifyV2

Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago. Incluyendo resultados de autenticación CVV2 y AVS.

  • aplicación/vnd.mcn.transaction-service.api.v.2+json
Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
Fecha y hora de creaciónSolo fecha y hora
(requerido)
Fecha y Hora de creación del Token de Pago.
tiempo para vivirentero
(requerido)
Tiempo para que exista el token.
originalPagoTokenIdcadena
(opcional)
Referencia a una identificación de token anterior.
NúmeroVálidoDeUsoentero
(requerido)
El número total de veces que se puede usar el token de pago para compras.
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
ID de participación del programaentero
(requerido)
El programa conectado al token de pago.
avsRespuestacadena
(requerido)
El resultado de la verificación AVS.
Id. de token de pagocadena
(requerido)
Representación compleja del Id. del token de pago.
PaymentInfoIdcadena
(opcional)
Información asociada al pago.
cvv2Respuestacadena
(requerido)
El resultado de la verificación CVV2.
ID de suscripcióncadena
(requerido)
Identificación de la suscripción asociada a la transacción.

Ejemplo de PaymentTokenVerifyV2

{
	"paymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"programParticipationId": 1,
	"originalPaymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"createdDatetime": "2022-01-01T01:00:00",
	"timeToLive": 30,
	"validNumberOfUse": 20,
	"subscriptionId": "900000000000000001",
	"paymentInfoId": "53104f5a54d3d43254def41c29aedba8",
	"cvv2Response": "M",
	"avsResponse": "Y"
}

PagoTokenTransacción

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
clienteAccnumentero
(requerido)
Número de cuenta CCBill del comerciante.
clienteSubaccentero
(requerido)
Número de subcuenta CCBill del comerciante.
ID de suscripcióncadena
(requerido)
Un número de ID de suscripción existente.

Ejemplo de transacción de token de pago

{
        "clientAccnum": 900112,
        "clientSubacc": 0002,
        "subscriptionId": "918166501000000981"
}

PaymentTokenMerchantOnlyParams

Parámetros para crear un token de pago sin autenticación CVV2 y AVS.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
Información del clienteobjeto
(formación)
Información al cliente.
Información del cliente. emailcadena
(requerido)
Dirección de correo electrónico del cliente.
Información del cliente. navegadorHttpAceptarIdiomacadena
(opcional)
Lista de lenguajes humanos aceptables para la respuesta.
Información del cliente. navegadorHttpUserAgentcadena
(opcional)
La cadena de agente de usuario del agente de usuario.
Información del cliente. ciudadcadena
(requerido)
Ciudad del cliente.
Información del cliente. navegadorHttpAceptarcadena
(opcional)
Tipos de medios que son aceptables para la respuesta.
Información del cliente. estadocadena
(requerido)
Estado del cliente.
Información del cliente. código postalcadena
(requerido)
Código postal del cliente.
Información del cliente. clienteFnamecadena
(requerido)
Nombre del cliente.
Información del cliente. address1cadena
(requerido)
Dirección del cliente.
Información del cliente. address2cadena
(opcional)
Dirección del cliente (información adicional).
Información del cliente. navegadorHttpAcceptEncodingcadena
(opcional)
Lista de codificaciones aceptables.
Información del cliente. nombre del clientecadena
(requerido)
Apellido del cliente.
Información del cliente. dirección IPcadena (requerido)Dirección IP del cliente.
Información del cliente. número de teléfonocadena
(opcional)
Número de teléfono del cliente.
Información del cliente. paíscadena
(requerido)
País del cliente.
información de pagoobjeto
(formación)
Información del pago.
información de pago. número de tarjetacadena
(requerido)
Número de tarjeta.
información de pago. expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
información de pago. expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
información de pago. nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.
ID de suscripciónentero
(requerido)
Número de identificación de la suscripción de la transacción.
tiempo para vivirentero
(opcional)
Tiempo para que exista el token.
NúmeroVálidoDeUsoentero
(opcional)
El número total de veces que se puede usar el token de pago para compras.

Ejemplo de PaymentTokenMerchantOnlyParams

{
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"customerInfo": {
		"customerFname": "Tyler",
		"customerLname": "Thomas",
		"address1": "Woodland Drive",
		"address2": "Apt 21",
		"city": "Tempe",
		"state": "AZ",
		"zipcode": "85281",
		"country": "US",
		"phoneNumber": "5555555555",
		"email": "tthomas@xyz.com",
		"ipAddress": "10.70.60.14",
		"browserHttpUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:60.0) Gecko/20100101 Firefox/60.0",
		"browserHttpAccept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
		"browserHttpAcceptLanguage": "en-US,en;q=0.5",
		"browserHttpAcceptEncoding": "gzip, deflate, br"
	},
	"paymentInfo": {
		"creditCardPaymentInfo": {
			"cardNum": "4473707989493598",
			"nameOnCard": "Tyler Thomas",
			"expMonth": "04",
			"expYear": "2026"
		}
	},
	"subscriptionId":900000000000000001,
	"timeToLive": 30,
	"validNumberOfUse": 3
}

PaymentTokenMerchantOnlyVerifyParams

Parámetros para crear un token de pago que incluya autenticación CVV2 y AVS.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
Información del clienteobjeto
(formación)
Información al cliente.
Información del cliente. emailcadena
(requerido)
Dirección de correo electrónico del cliente.
Información del cliente. navegadorHttpAceptarIdiomacadena
(opcional)
Lista de lenguajes humanos aceptables para la respuesta.
Información del cliente. navegadorHttpUserAgentcadena
(opcional)
La cadena de agente de usuario del agente de usuario.
Información del cliente. ciudadcadena
(requerido)
Ciudad del cliente.
Información del cliente. navegadorHttpAceptarcadena
(opcional)
Tipos de medios que son aceptables para la respuesta.
Información del cliente. estadocadena
(requerido)
Estado del cliente.
Información del cliente. código postalcadena
(requerido)
Código postal del cliente.
Información del cliente. clienteFnamecadena
(requerido)
Nombre del cliente.
Información del cliente. address1cadena
(requerido)
Dirección del cliente.
Información del cliente. address2cadena
(opcional)
Dirección del cliente (información adicional).
Información del cliente. navegadorHttpAcceptEncodingcadena
(opcional)
Lista de codificaciones aceptables.
Información del cliente. nombre del clientecadena
(requerido)
Apellido del cliente.
Información del cliente. dirección IPcadena
(requerido)
Dirección IP del cliente.
Información del cliente. número de teléfonocadena
(opcional)
Número de teléfono del cliente.
Información del cliente. paíscadena
(requerido)
País del cliente.
información de pagoobjeto
(formación)
Información del pago.
información de pago. número de tarjetacadena
(requerido)
Número de tarjeta.
información de pago. expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
información de pago. expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
información de pago. nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.
información de pago. cvv2cadena
(requerido)
Código CVV2 en la tarjeta.
ID de suscripciónentero
(requerido)
Número de identificación de la suscripción de la transacción.
tiempo para vivirentero
(opcional)
Tiempo para que exista el token.
NúmeroVálidoDeUsoentero
(opcional)
El número total de veces que se puede usar el token de pago para compras.

Ejemplo de PaymentTokenMerchantOnlyVerifyParams

{
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"customerInfo": {
		"customerFname": "Tyler",
		"customerLname": "Thomas",
		"address1": "Woodland Drive",
		"address2": "Apt 21",
		"city": "Tempe",
		"state": "AZ",
		"zipcode": "85281",
		"country": "US",
		"phoneNumber": "5555555555",
		"email": "tthomas@xyz.com",
		"ipAddress": "10.70.60.14",
		"browserHttpUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:60.0) Gecko/20100101 Firefox/60.0",
		"browserHttpAccept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
		"browserHttpAcceptLanguage": "en-US,en;q=0.5",
		"browserHttpAcceptEncoding": "gzip, deflate, br"
	},
	"paymentInfo": {
		"creditCardPaymentInfo": {
			"cardNum": "4473707989493598",
			"nameOnCard": "Tyler Thomas",
			"expMonth": "04",
			"expYear": "2026",
			"cvv2": "123"
		}
	},
	"subscriptionId":900000000000000001,
	"timeToLive": 30,
	"validNumberOfUse": 3

PaymentTokenProgramSpecifiedParams

Parámetros para generar tokens de pago para oportunidades de venta cruzada con otros participantes específicos del programa (comerciantes).

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
Información del clienteobjeto
(formación)
Información al cliente.
Información del cliente. emailcadena
(requerido)
Dirección de correo electrónico del cliente.
Información del cliente. navegadorHttpAceptarIdiomacadena
(opcional)
Lista de lenguajes humanos aceptables para la respuesta.
Información del cliente. navegadorHttpUserAgentcadena
(opcional)
La cadena de agente de usuario del agente de usuario.
Información del cliente. ciudadcadena
(requerido)
Ciudad del cliente.
Información del cliente. navegadorHttpAceptarcadena
(opcional)
Tipos de medios que son aceptables para la respuesta.
Información del cliente. estadocadena
(requerido)
Estado del cliente.
Información del cliente. código postalcadena
(requerido)
Código postal del cliente.
Información del cliente. clienteFnamecadena
(requerido)
Nombre del cliente.
Información del cliente. address1cadena
(requerido)
Dirección del cliente.
Información del cliente. address2cadena
(opcional)
Dirección del cliente (información adicional).
Información del cliente. navegadorHttpAcceptEncodingcadena
(opcional)
Lista de codificaciones aceptables.
Información del cliente. nombre del clientecadena
(requerido)
Apellido del cliente.
Información del cliente. dirección IPcadena
(requerido)
Dirección IP del cliente.
Información del cliente. número de teléfonocadena
(opcional)
Número de teléfono del cliente.
Información del cliente. paíscadena
(requerido)
País del cliente.
información de pagoobjeto
(formación)
Información del pago.
información de pago. número de tarjetacadena
(requerido)
Número de tarjeta.
información de pago. expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
información de pago. expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
información de pago. nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.
ID de suscripciónentero
(requerido)
Número de identificación de la suscripción de la transacción.
ID de participación del programaentero
(requerido)
El identificador representa el programa asociado con la transacción.
tiempo para vivirentero
(opcional)
Tiempo para que exista el token.
NúmeroVálidoDeUsoentero
(opcional)
El número total de veces que se puede usar el token de pago para compras.

Ejemplo de PaymentTokenProgramSpecifiedParams

{
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"customerInfo": {
		"customerFname": "Tyler",
		"customerLname": "Thomas",
		"address1": "Woodland Drive",
		"address2": "Apt 21",
		"city": "Tempe",
		"state": "AZ",
		"zipcode": "85281",
		"country": "US",
		"phoneNumber": "5555555555",
		"email": "tthomas@xyz.com",
		"ipAddress": "10.70.60.14",
		"browserHttpUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:60.0) Gecko/20100101 Firefox/60.0",
		"browserHttpAccept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
		"browserHttpAcceptLanguage": "en-US,en;q=0.5",
		"browserHttpAcceptEncoding": "gzip, deflate, br"
	},
	"paymentInfo": {
		"creditCardPaymentInfo": {
			"cardNum": "4473707989493598",
			"nameOnCard": "Tyler Thomas",
			"expMonth": "04",
			"expYear": "2026"
		}
	},
	"subscriptionId": 900000000000000001,
	"programParticipationId": 1,
	"timeToLive": 30,
	"validNumberOfUse": 3

PaymentTokenTargetClientParams

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.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
Información del clienteobjeto
(formación)
Información al cliente.
Información del cliente. emailcadena
(requerido)
Dirección de correo electrónico del cliente.
Información del cliente. navegadorHttpAceptarIdiomacadena
(opcional)
Lista de lenguajes humanos aceptables para la respuesta.
Información del cliente. navegadorHttpUserAgentcadena
(opcional)
La cadena de agente de usuario del agente de usuario.
Información del cliente. ciudadcadena
(requerido)
Ciudad del cliente.
Información del cliente. navegadorHttpAceptarcadena
(opcional)
Tipos de medios que son aceptables para la respuesta.
Información del cliente. estadocadena
(requerido)
Estado del cliente.
Información del cliente. código postalcadena
(requerido)
Código postal del cliente.
Información del cliente. clienteFnamecadena
(requerido)
Nombre del cliente.
Información del cliente. address1cadena
(requerido)
Dirección del cliente.
Información del cliente. address2cadena
(opcional)
Dirección del cliente (información adicional).
Información del cliente. navegadorHttpAcceptEncodingcadena
(opcional)
Lista de codificaciones aceptables.
Información del cliente. nombre del clientecadena
(requerido)
Apellido del cliente.
Información del cliente. dirección IPcadena
(requerido)
Dirección IP del cliente.
Información del cliente. número de teléfonocadena
(opcional)
Número de teléfono del cliente.
Información del cliente. paíscadena
(requerido)
País del cliente.
información de pagoobjeto
(formación)
Información del pago.
información de pago. número de tarjetacadena
(requerido)
Número de tarjeta.
información de pago. expMescadena
(requerido)
Mes de caducidad de la tarjeta en mm formato.
información de pago. expañocadena
(requerido)
Año de caducidad de la tarjeta en aaaa formato.
información de pago. nombre en la tarjetacadena
(requerido)
Nombre como aparece en la tarjeta.
ID de suscripciónentero
(requerido)
Número de identificación de la suscripción de la transacción.
targetClientAccnumentero
(requerido)
Número de cuenta de comerciante de destino.
objetivoClienteSubaccentero
(requerido)
Número de subcuenta de comerciante de destino.
tiempo para vivirentero
(opcional)
Tiempo para que exista el token.
NúmeroVálidoDeUsoentero
(opcional)
El número total de veces que se puede usar el token de pago para compras.

Ejemplo de PaymentTokenTargetClientParams

{
	"clientAccnum": 900000,
	"clientSubacc": 0000,
	"customerInfo": {
		"customerFname": "Tyler",
		"customerLname": "Thomas",
		"address1": "Woodland Drive",
		"address2": "Apt 21",
		"city": "Tempe",
		"state": "AZ",
		"zipcode": "85281",
		"country": "US",
		"phoneNumber": "5555555555",
		"email": "tthomas@xyz.com",
		"ipAddress": "10.70.60.14",
		"browserHttpUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:60.0) Gecko/20100101 Firefox/60.0",
		"browserHttpAccept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
		"browserHttpAcceptLanguage": "en-US,en;q=0.5",
		"browserHttpAcceptEncoding": "gzip, deflate, br"
	},
	"paymentInfo": {
		"creditCardPaymentInfo": {
			"cardNum": "4473707989493598",
			"nameOnCard": "Tyler Thomas",
			"expMonth": "04",
			"expYear": "2026"
		}
	},
	"subscriptionId": 900000000000000001,
	"targetClientAccnum": 900000,
	"targetClientSubacc": 0001,
	"timeToLive": 30,
	"validNumberOfUse": 3
}

Información de transacción

Los parámetros de respuesta confirman que se cobró correctamente a un cliente mediante un token de pago.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
código de errorentero
(requerido)
Valor de condición de error de la transacción.
aprobadabooleano
(requerido)
Estado de aprobación de la transacción.
pagoUniqueIdcadena
(requerido)
Clave única conectada a la cuenta de pago.
ID de sesióncadena
(requerido)
Valor de ID de sesión único para la transacción.
ID de suscripciónentero
(requerido)
ID de suscripción al que pertenece la transacción.
nuevoPaymentTokenIdcadena
(requerido)
Nuevo token de pago para transacciones posteriores.

Ejemplo de información de transacción

{
	"errorCode": 200,
	"approved": true,
	"paymentUniqueId": "53104f5a54d3d43254def41c29aedba8",
	"sessionId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"subscriptionId": 900000000000000001,
	"newPaymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"
}

Solicitud de transacción

Parámetros de solicitud para iniciar una solicitud de transacción para un cliente.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
crear nuevo token de pagobooleano
(verdadero Falso)
Devuelva un nuevo token de pago para transacciones posteriores o no.
precio inicialnúmero
(requerido)
Precio de la transacción inicial.
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
LifeTimeSubscriptionbooleano
(opcional)
La suscripción es válida durante la vigencia del sitio web.
periodo inicialentero
(requerido)
El período de tiempo de la transacción inicial.
período recurrenteentero
(opcional)
El período de tiempo de las transacciones recurrentes.
código de monedacadena
(opcional)
Representación numérica de la moneda utilizada en la transacción.
refacturacionesentero
(opcional)
El número de veces que pueden ocurrir transacciones recurrentes.
Precio recurrentenúmero
(opcional)
Precio de transacciones recurrentes.
pasarA Través deInfo matriz
(opcional)
Información emparejada pasada al Servicio de transacciones.

Ejemplo de solicitud de transacción

{
    "clientAccnum":900123,
    "clientSubacc":0010,
    "initialPrice": 9.99,
	"initialPeriod": 10,
	"recurringPrice": 15.00,
	"recurringPeriod": 30,
	"rebills": 99,
	"currencyCode": 840,
	"lifeTimeSubscription": false,
    "createNewPaymentToken": false,
	"passThroughInfo": [
		{
			"name": "val1",
			"value": "val2"
		}
	]
}

Solicitud de transacción de Threeds

Parámetros para iniciar un cargo con autenticación 3DS.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
crear nuevo token de pagobooleano
(opcional)
Devuelva un nuevo token de pago para transacciones posteriores o no.
clienteAccnumentero
(requerido)
Número de cuenta mercantil.
clienteSubaccentero
(requerido)
Número de subcuenta de comerciante.
precio inicialflotar
(requerido)
Precio de transacción inicial.
periodo inicialentero
(requerido)
La duración (en días) del período de facturación inicial.
código de monedacadena
(opcional)
Código de moneda de tres dígitos (norma ISO 4217) para la moneda utilizada en la transacción.
Precio recurrenteflotar
(opcional)
El monto que se le cobrará al consumidor por cada factura recurrente.
período recurrenteentero
(opcional)
El tiempo entre refacturaciones.
refacturacionesentero
(opcional)
El número total de veces que se volverá a facturar la suscripción.
LifeTimeSubscriptionbooleano
(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 pagobooleano
(opcional)
Devuelva un nuevo token de pago para transacciones posteriores o no.
pasarA Través deInfoMatriz [cualquiera]
(opcional)
Información emparejada que se pasa al servicio de transacciones.
tresdsCardTokencadena
(requerido)
El cardToken cifrado que recibes a través del proceso de verificación 3DS. Como solo requerimos los primeros 16 caracteres, recorte la cadena a esa longitud antes de enviarla a la API CCBill. El envío de una cadena de más de 16 caracteres genera un error.
Valor de ejemplo: gjeoB5NdJ1r6p0dG
tresdsEcicadena
(requerido)
Un Indicador de Comercio Electrónico (ECI).
Valores: '0','1','2','5','6', o'7'.
estado de tresdscadena
(requerido)
El estado de la verificación 3DS ('Y','N','A', etc.)
versión de threedscadena
(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
tresdsXidcadena
(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
tresdscavvcadena
(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 threedsCavvcadena
(opcional/requerido)
Algoritmo CAVV para solicitud de threeds. Se requiere el parámetro threedsCavvAlgorithm para threedsVersion 1.0.2
tresdsDsTransIdcadena
(opcional/requerido)
ID de transacción del servidor de directorio. El parámetro threedsDsTransId es necesario para threedsVersion 2.1.0
tresdsAcsTransIdcadena
(opcional/requerido)
ID de transacción del servidor de control de acceso. Se requiere el parámetro threedsAcsTransId para threedsVersion 2.1.0
tresdsSdkTransIdcadena
(opcional)
El ID de transacción del proveedor de 3DS.
tipo de autenticación de threedscadena
(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 threedscadena
(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).
threedsClientTransactionIdcadena
(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éxitobooleano
(requerido)
Verificación del éxito o fracaso de la autenticación 3DS.
tresdsCantidadentero
(opcional)
La cantidad a cobrar (igual que precio inicial).
tresdsmonedaentero
(opcional)
El código de moneda de 3 dígitos para la moneda que se utilizará en esta transacción.
Valor de ejemplo: 840
tresdsErrorcadena
(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.
tresdsErrorDetallecadena
(opcional)
Detalles del error relacionados con el tresdsError.
tresdsErrorCodecadena
(opcional)
Código de error.
respuesta de tresdscadena
(opcional)
La respuesta completa en caso de error.

Ejemplo de ThreedsTransactionRequest

{
    "clientAccnum":900123,
    "clientSubacc":0010,
    "initialPrice": 9.99,
	"initialPeriod": 10,
	"recurringPrice": 15.00,
	"recurringPeriod": 30,
	"rebills": 99,
	"currencyCode": 840,
	"lifeTimeSubscription": false,
    "createNewPaymentToken": false,
	"passThroughInfo": [
		{
			"name": "val1",
			"value": "val2"
		}
	],
	"threedsEci": "05",
    "threedsError": "",
    "threedsStatus": "Y",
    "threedsSuccess": "true",
    "threedsVersion": "1.0.2",
    "threedsXid": "aWQteHc4ajJnNGIxZW8gICAgICA=",
    "threedsCavv": "cGFzc3dvcmQxMjM0NTZwYXNzd28=",
    "threedsCavvAlgorithm": "SHA-256",
    "threedsAmount": "10",
    "threedsClientTransactionId": "id-wl9r6duc5zj",
    "threedsCurrency": "USD",
    "threedsSdkTransId": "",
    "threedsAcsTransId": "",
    "threedsDsTransId": "",
    "threedsAuthenticationType": "",
    "threedsCardToken": "gjeoB5NdJ1r6p0dG",
    "threedsErrorDetail": "",
    "threedsErrorCode": "",
    "threedsResponse": ""
}

ThreeDSRequerido

Parámetros de respuesta después de la solicitud de autenticación 3DS.

Recursos
parámetros
PARÁMETROTIPODESCRIPCIÓN
Requisitosbooleano
(verdadero Falso)
Se requiere 3DS para pago con tarjeta.
cantidadnúmeroImporte del cargo autorizado.

Ejemplo de ThreeDSRequired

{
  "required": "true",
  "amount": "1.0"
}

Respuestas de verificación de CVV2

VALORDESCRIPCIÓN
MCoincidencia CVV2 / CVC2 / CID
NCVV2 / CVC2 / CID Sin coincidencia
PNo procesado
SEl CVV2 / CVC2 / CID debe estar en la tarjeta, pero el comerciante indica que no lo está.
UEl Emisor no está certificado o no ha proporcionado a Visa claves de cifrado.

Respuestas AVS

VALORDESCRIPCIÓN
ALas direcciones de las calles coinciden pero el código postal/ZIP no lo hace, o la solicitud no incluye el código postal/ZIP.
BCoincidencia 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).
CLa 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)
DLas direcciones y los códigos postales coinciden
FLa dirección y el código postal coinciden. (Tarjetas emitidas en el Reino Unido)
GEl 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.
OLa información de la dirección no está verificada.
MLa dirección y el código postal coinciden.
NNo 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.
PLos 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.
RRever; El sistema no está disponible o se agotó el tiempo de espera.
SAVS actualmente no es compatible
UNo hay datos de la plataforma de Emisor / Autorización
VCoincidencias de código postal de nueve caracteres; la dirección no coincide
XCoincidencia de código postal y dirección de nueve caracteres
YCoincidencia de dirección y código postal
ZPostal / ZIP coincide, la dirección postal no coincide o la dirección postal no se incluye en la solicitud.
1El nombre del titular de la tarjeta y el código postal coinciden
2El nombre, la dirección y el código postal del titular de la tarjeta coinciden
3El nombre y la dirección del titular de la tarjeta coinciden
4Coincidencias con el nombre del titular de la tarjeta
5El nombre del titular de la tarjeta es incorrecto, el código postal coincide
6Nombre del titular de la tarjeta incorrecto; coincidencia de dirección y código postal
7El nombre del titular de la tarjeta es incorrecto, la dirección coincide
8El nombre, la dirección y el código postal del titular de la tarjeta no coinciden

Ejemplo de verificación de token de pago

{
	"paymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"programParticipationId": 1,
	"originalPaymentTokenId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
	"clientAccnum": 900000,
	"clientSubacc": 0,
	"createdDatetime": "2018-01-01T01:00:00",
	"timeToLive": 30,
	"validNumberOfUse": 20,
	"subscriptionId": "900000000000000001",
	"paymentInfoId": "53104f5a54d3d43254def41c29aedba8",
	"cvv2Response": "M",
	"avsResponse": "Y"
}