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.
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"
}
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. |
500 | La respuesta no se completó de alguna manera. |
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
id | cadena (requerido) | GUID generado aleatoriamente. Patrón de validación: ^[a-zA-Z0-9-]*$ |
url | cadena (requerido) | La URL relativa que ha causado este error. |
errores | matriz (opcional) | Opcional, solo se devuelve en 400 errores de solicitud incorrecta para errores de validación. |
errores. campo | cadena (requerido) | El campo en error. |
errores. mensaje | cadena (requerido) | Mensaje fácil de usar. |
mensaje general | cadena (requerido) | Algo legible por humanos. |
código de error | CreditCardPaymentInfostring (requerido) | Código de error definido por el producto. Patrón de validación: ^[0-9]*$ |
fecha y hora | Fecha 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"
}
Elementos del información de pago formación.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
número de tarjeta | cadena (requerido) | Número de tarjeta. |
expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato |
nombre en la tarjeta | cadena (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"
}
Elementos del información de pago matriz con autenticación CVV2.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
número de tarjeta | cadena (requerido) | Número de tarjeta. |
expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
cvv2 | cadena (requerido) | Código CVV2 en la tarjeta. |
Ejemplo de CreditCardWithCvvPaymentInfo
{
"cardNum": "4473707989493598",
"expMonth": "04",
"expYear": "2026",
"nameOnCard": "Tyler Thomas"
"cvv2": "144"
}
Elementos del Información del cliente formación.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
correo electrónico, | cadena (requerido) | Dirección de correo electrónico del cliente. |
navegadorHttpAceptarIdioma | cadena (opcional) | Lista de lenguajes humanos aceptables para la respuesta. |
navegadorHttpUserAgent | cadena (opcional) | La cadena de agente de usuario del agente de usuario. |
ciudad | cadena (requerido) | Ciudad del cliente. |
navegadorHttpAceptar | cadena (opcional) | Tipos de medios que son aceptables para la respuesta. |
estado | cadena (requerido) | Estado del cliente. |
código postal | cadena (requerido) | Código postal del cliente. |
clienteFname | cadena (requerido) | Nombre del cliente. |
address1 | cadena (requerido) | Dirección del cliente. |
address2 | cadena (opcional) | Dirección del cliente (información adicional). |
browserHttpAcceptEncoding | cadena (opcional) | Lista de codificaciones aceptables. |
nombre del cliente | cadena (requerido) | Apellido del cliente. |
dirección IP | cadena (requerido) | Dirección IP del cliente. |
número de teléfono | cadena (opcional) | Número de teléfono del cliente. |
país | cadena (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"
}
Elementos del passThroughInfo La matriz representa información emparejada personalizada que se pasa al servicio de transacciones.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
nombre | cadena (requerido) | Valor de traspaso personalizado. |
propuesta de | cadena (requerido) | Valor de traspaso personalizado. |
Ejemplo de PassThroughInfo
{
"name": "value1",
"value": "value2"
}
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.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
información de pago de la tarjeta de crédito | objeto (formación) | Información de pago con tarjeta de crédito. |
información de pago con tarjeta de crédito. número de tarjeta | cadena (requerido) | Número de tarjeta. |
información de pago con tarjeta de crédito. expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
información de pago con tarjeta de crédito. expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
información de pago con tarjeta de crédito. nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
Ejemplo de información de pago
{
"creditCardPaymentInfo": {
"cardNum": "4473707989493598",
"expMonth": "04",
"expYear": "2026",
"nameOnCard": "Tyler Thomas"
}
}
Elementos del información de pago de la tarjeta de crédito matriz con autenticación CVV2.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
información de pago de la tarjeta de crédito | objeto (formación) | Información de pago con tarjeta de crédito. |
información de pago con tarjeta de crédito. número de tarjeta | cadena (requerido) | Número de tarjeta. |
información de pago con tarjeta de crédito. expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
información de pago con tarjeta de crédito. expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
información de pago con tarjeta de crédito. nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
información de pago con tarjeta de crédito. cvv2 | cadena (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"
}
}
Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
Fecha y hora de creación | Solo fecha y hora (requerido) | Fecha y Hora de creación del Token de Pago. |
tiempo para vivir | entero (requerido) | Tiempo para que exista el token. |
originalPagoTokenId | cadena (opcional) | Referencia a una identificación de token anterior. |
NúmeroVálidoDeUso | entero (requerido) | El número total de veces que se puede usar el token de pago para compras. |
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
ID de participación del programa | entero (requerido) | El programa conectado al token de pago. |
Id. de token de pago | cadena (requerido) | Representación compleja del Id. del token de pago. |
PaymentInfoId | cadena (opcional) | Información asociada al pago. |
ID de suscripción | entero (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"
}
Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
Fecha y hora de creación | Solo fecha y hora (requerido) | Fecha y Hora de creación del Token de Pago. |
tiempo para vivir | entero (requerido) | Tiempo para que exista el token. |
originalPagoTokenId | cadena (opcional) | Referencia a una identificación de token anterior. |
NúmeroVálidoDeUso | entero (requerido) | El número total de veces que se puede usar el token de pago para compras. |
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
ID de participación del programa | entero (requerido) | El programa conectado al token de pago. |
Id. de token de pago | cadena (requerido) | Representación compleja del Id. del token de pago. |
PaymentInfoId | cadena (opcional) | Información asociada al pago. |
ID de suscripción | cadena (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"
}
Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago. Incluyendo resultados de autenticación CVV2 y AVS.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
Fecha y hora de creación | Solo fecha y hora (requerido) | Fecha y Hora de creación del Token de Pago. |
tiempo para vivir | entero (requerido) | Tiempo para que exista el token. |
originalPagoTokenId | cadena (opcional) | Referencia a una identificación de token anterior. |
NúmeroVálidoDeUso | entero (requerido) | El número total de veces que se puede usar el token de pago para compras. |
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
ID de participación del programa | entero (requerido) | El programa conectado al token de pago. |
avsRespuesta | cadena (requerido) | El resultado de la verificación AVS. |
Id. de token de pago | cadena (requerido) | Representación compleja del Id. del token de pago. |
PaymentInfoId | cadena (opcional) | Información asociada al pago. |
cvv2Respuesta | cadena (requerido) | El resultado de la verificación CVV2. |
ID de suscripción | entero (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"
}
Estos parámetros de respuesta se reciben cuando se crea correctamente un token de pago. Incluyendo resultados de autenticación CVV2 y AVS.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
Fecha y hora de creación | Solo fecha y hora (requerido) | Fecha y Hora de creación del Token de Pago. |
tiempo para vivir | entero (requerido) | Tiempo para que exista el token. |
originalPagoTokenId | cadena (opcional) | Referencia a una identificación de token anterior. |
NúmeroVálidoDeUso | entero (requerido) | El número total de veces que se puede usar el token de pago para compras. |
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
ID de participación del programa | entero (requerido) | El programa conectado al token de pago. |
avsRespuesta | cadena (requerido) | El resultado de la verificación AVS. |
Id. de token de pago | cadena (requerido) | Representación compleja del Id. del token de pago. |
PaymentInfoId | cadena (opcional) | Información asociada al pago. |
cvv2Respuesta | cadena (requerido) | El resultado de la verificación CVV2. |
ID de suscripción | cadena (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"
}
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
clienteAccnum | entero (requerido) | Número de cuenta CCBill del comerciante. |
clienteSubacc | entero (requerido) | Número de subcuenta CCBill del comerciante. |
ID de suscripción | cadena (requerido) | Un número de ID de suscripción existente. |
Ejemplo de transacción de token de pago
{
"clientAccnum": 900112,
"clientSubacc": 0002,
"subscriptionId": "918166501000000981"
}
Parámetros para crear un token de pago sin autenticación CVV2 y AVS.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
Información del cliente | objeto (formación) | Información al cliente. |
Información del cliente. correo electrónico, | cadena (requerido) | Dirección de correo electrónico del cliente. |
Información del cliente. navegadorHttpAceptarIdioma | cadena (opcional) | Lista de lenguajes humanos aceptables para la respuesta. |
Información del cliente. navegadorHttpUserAgent | cadena (opcional) | La cadena de agente de usuario del agente de usuario. |
Información del cliente. ciudad | cadena (requerido) | Ciudad del cliente. |
Información del cliente. navegadorHttpAceptar | cadena (opcional) | Tipos de medios que son aceptables para la respuesta. |
Información del cliente. estado | cadena (requerido) | Estado del cliente. |
Información del cliente. código postal | cadena (requerido) | Código postal del cliente. |
Información del cliente. clienteFname | cadena (requerido) | Nombre del cliente. |
Información del cliente. address1 | cadena (requerido) | Dirección del cliente. |
Información del cliente. address2 | cadena (opcional) | Dirección del cliente (información adicional). |
Información del cliente. browserHttpAcceptEncoding | cadena (opcional) | Lista de codificaciones aceptables. |
Información del cliente. nombre del cliente | cadena (requerido) | Apellido del cliente. |
Información del cliente. dirección IP | cadena (requerido) | Dirección IP del cliente. |
Información del cliente. número de teléfono | cadena (opcional) | Número de teléfono del cliente. |
Información del cliente. país | cadena (requerido) | País del cliente. |
información de pago | objeto (formación) | Información del pago. |
información de pago. número de tarjeta | cadena (requerido) | Número de tarjeta. |
información de pago. expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
información de pago. expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
información de pago. nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
ID de suscripción | entero (requerido) | Número de identificación de la suscripción de la transacción. |
tiempo para vivir | entero (opcional) | Tiempo para que exista el token. |
NúmeroVálidoDeUso | entero (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
}
Parámetros para crear un token de pago que incluya autenticación CVV2 y AVS.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
Información del cliente | objeto (formación) | Información al cliente. |
Información del cliente. correo electrónico, | cadena (requerido) | Dirección de correo electrónico del cliente. |
Información del cliente. navegadorHttpAceptarIdioma | cadena (opcional) | Lista de lenguajes humanos aceptables para la respuesta. |
Información del cliente. navegadorHttpUserAgent | cadena (opcional) | La cadena de agente de usuario del agente de usuario. |
Información del cliente. ciudad | cadena (requerido) | Ciudad del cliente. |
Información del cliente. navegadorHttpAceptar | cadena (opcional) | Tipos de medios que son aceptables para la respuesta. |
Información del cliente. estado | cadena (requerido) | Estado del cliente. |
Información del cliente. código postal | cadena (requerido) | Código postal del cliente. |
Información del cliente. clienteFname | cadena (requerido) | Nombre del cliente. |
Información del cliente. address1 | cadena (requerido) | Dirección del cliente. |
Información del cliente. address2 | cadena (opcional) | Dirección del cliente (información adicional). |
Información del cliente. browserHttpAcceptEncoding | cadena (opcional) | Lista de codificaciones aceptables. |
Información del cliente. nombre del cliente | cadena (requerido) | Apellido del cliente. |
Información del cliente. dirección IP | cadena (requerido) | Dirección IP del cliente. |
Información del cliente. número de teléfono | cadena (opcional) | Número de teléfono del cliente. |
Información del cliente. país | cadena (requerido) | País del cliente. |
información de pago | objeto (formación) | Información del pago. |
información de pago. número de tarjeta | cadena (requerido) | Número de tarjeta. |
información de pago. expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
información de pago. expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
información de pago. nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
información de pago. cvv2 | cadena (requerido) | Código CVV2 en la tarjeta. |
ID de suscripción | entero (requerido) | Número de identificación de la suscripción de la transacción. |
tiempo para vivir | entero (opcional) | Tiempo para que exista el token. |
NúmeroVálidoDeUso | entero (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
}
Parámetros para generar tokens de pago para oportunidades de venta cruzada con otros participantes específicos del programa (comerciantes).
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
Información del cliente | objeto (formación) | Información al cliente. |
Información del cliente. correo electrónico, | cadena (requerido) | Dirección de correo electrónico del cliente. |
Información del cliente. navegadorHttpAceptarIdioma | cadena (opcional) | Lista de lenguajes humanos aceptables para la respuesta. |
Información del cliente. navegadorHttpUserAgent | cadena (opcional) | La cadena de agente de usuario del agente de usuario. |
Información del cliente. ciudad | cadena (requerido) | Ciudad del cliente. |
Información del cliente. navegadorHttpAceptar | cadena (opcional) | Tipos de medios que son aceptables para la respuesta. |
Información del cliente. estado | cadena (requerido) | Estado del cliente. |
Información del cliente. código postal | cadena (requerido) | Código postal del cliente. |
Información del cliente. clienteFname | cadena (requerido) | Nombre del cliente. |
Información del cliente. address1 | cadena (requerido) | Dirección del cliente. |
Información del cliente. address2 | cadena (opcional) | Dirección del cliente (información adicional). |
Información del cliente. browserHttpAcceptEncoding | cadena (opcional) | Lista de codificaciones aceptables. |
Información del cliente. nombre del cliente | cadena (requerido) | Apellido del cliente. |
Información del cliente. dirección IP | cadena (requerido) | Dirección IP del cliente. |
Información del cliente. número de teléfono | cadena (opcional) | Número de teléfono del cliente. |
Información del cliente. país | cadena (requerido) | País del cliente. |
información de pago | objeto (formación) | Información del pago. |
información de pago. número de tarjeta | cadena (requerido) | Número de tarjeta. |
información de pago. expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
información de pago. expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
información de pago. nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
ID de suscripción | entero (requerido) | Número de identificación de la suscripción de la transacción. |
ID de participación del programa | entero (requerido) | El identificador representa el programa asociado con la transacción. |
tiempo para vivir | entero (opcional) | Tiempo para que exista el token. |
NúmeroVálidoDeUso | entero (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
}
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.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
Información del cliente | objeto (formación) | Información al cliente. |
Información del cliente. correo electrónico, | cadena (requerido) | Dirección de correo electrónico del cliente. |
Información del cliente. navegadorHttpAceptarIdioma | cadena (opcional) | Lista de lenguajes humanos aceptables para la respuesta. |
Información del cliente. navegadorHttpUserAgent | cadena (opcional) | La cadena de agente de usuario del agente de usuario. |
Información del cliente. ciudad | cadena (requerido) | Ciudad del cliente. |
Información del cliente. navegadorHttpAceptar | cadena (opcional) | Tipos de medios que son aceptables para la respuesta. |
Información del cliente. estado | cadena (requerido) | Estado del cliente. |
Información del cliente. código postal | cadena (requerido) | Código postal del cliente. |
Información del cliente. clienteFname | cadena (requerido) | Nombre del cliente. |
Información del cliente. address1 | cadena (requerido) | Dirección del cliente. |
Información del cliente. address2 | cadena (opcional) | Dirección del cliente (información adicional). |
Información del cliente. browserHttpAcceptEncoding | cadena (opcional) | Lista de codificaciones aceptables. |
Información del cliente. nombre del cliente | cadena (requerido) | Apellido del cliente. |
Información del cliente. dirección IP | cadena (requerido) | Dirección IP del cliente. |
Información del cliente. número de teléfono | cadena (opcional) | Número de teléfono del cliente. |
Información del cliente. país | cadena (requerido) | País del cliente. |
información de pago | objeto (formación) | Información del pago. |
información de pago. número de tarjeta | cadena (requerido) | Número de tarjeta. |
información de pago. expMes | cadena (requerido) | Mes de caducidad de la tarjeta en mm formato. |
información de pago. expaño | cadena (requerido) | Año de caducidad de la tarjeta en aaaa formato. |
información de pago. nombre en la tarjeta | cadena (requerido) | Nombre como aparece en la tarjeta. |
ID de suscripción | entero (requerido) | Número de identificación de la suscripción de la transacción. |
targetClientAccnum | entero (requerido) | Número de cuenta de comerciante de destino. |
targetClientSubacc | entero (requerido) | Número de subcuenta de comerciante de destino. |
tiempo para vivir | entero (opcional) | Tiempo para que exista el token. |
NúmeroVálidoDeUso | entero (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
}
Los parámetros de respuesta confirman que se cobró correctamente a un cliente mediante un token de pago.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
código de error | entero (requerido) | Valor de condición de error de la transacción. |
aprobado | booleano (requerido) | Estado de aprobación de la transacción. |
pagoUniqueId | cadena (requerido) | Clave única conectada a la cuenta de pago. |
ID de sesión | cadena (requerido) | Valor de ID de sesión único para la transacción. |
ID de suscripción | entero (requerido) | ID de suscripción al que pertenece la transacción. |
newPaymentTokenId | cadena (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"
}
Parámetros de solicitud para iniciar una solicitud de transacción para un cliente.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
crear nuevo token de pago | booleano (verdadero Falso) | Devuelva un nuevo token de pago para transacciones posteriores o no. |
precio inicial | número (requerido) | Precio de la transacción inicial. |
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
LifeTimeSubscription | booleano (opcional) | La suscripción es válida durante la vigencia del sitio web. |
periodo inicial | entero (requerido) | El período de tiempo de la transacción inicial. |
período recurrente | entero (opcional) | El período de tiempo de las transacciones recurrentes. |
código de moneda | entero (opcional) | Representación numérica de la moneda utilizada en la transacción. |
refacturaciones | entero (opcional) | El número de veces que pueden ocurrir transacciones recurrentes. |
Precio recurrente | número (opcional) | Precio de transacciones recurrentes. |
passThroughInfo | 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"
}
]
}
Parámetros para iniciar un cargo con autenticación 3DS.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
crear nuevo token de pago | booleano (verdadero Falso) | Devuelva un nuevo token de pago para transacciones posteriores o no. |
precio inicial | número (requerido) | Precio de la transacción inicial. |
clienteAccnum | entero (requerido) | Número de cuenta mercantil. |
clienteSubacc | entero (requerido) | Número de subcuenta de comerciante. |
LifeTimeSubscription | booleano (opcional) | La suscripción es válida durante la vigencia del sitio web. |
periodo inicial | entero (requerido) | El período de tiempo de la transacción inicial. |
período recurrente | entero (opcional) | El período de tiempo de las transacciones recurrentes. |
código de moneda | entero (opcional) | Representación numérica de la moneda utilizada en la transacción. |
refacturaciones | entero (opcional) | El número de veces que pueden ocurrir transacciones recurrentes. |
Precio recurrente | número (opcional) | Precio de transacciones recurrentes. |
passThroughInfo | matriz (opcional) | Información emparejada pasada al Servicio de transacciones. |
tresedsXid | cadena (opcional) | XID para la solicitud de threeds. |
versión de threeds | cadena (opcional) | El número de versión para la solicitud de threeds. |
tresdséxito | booleano (opcional) | Éxito para la solicitud de threeds. |
tresdsCantidad | entero (opcional) | Importe de la solicitud de threeds. |
tresdsEci | cadena (requerido) | Solicitud de ECI para threeds. |
tresdscavv | cadena (requerido) | CAVV para solicitud de tresds. |
algoritmo threedsCavv | cadena (opcional) | Algoritmo CAVV para solicitud de threeds. |
tresdsid | cadena (opcional) | Id para la solicitud de threeds. |
estado de tresds | cadena (opcional) | Estado de la solicitud de threeds. |
ID de transacción de threeds | cadena (opcional) | ID de transacción para la solicitud de threeds. |
tresdsError | cadena (opcional) | Error para la solicitud de threeds. |
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"
}
],
"threedsCavv": "cGFzc3dvcmQxMjM0NTZwYXNzd28=",
"threedsCavvAlgorithm": "3",
"threedsEci": "05",
"threedsError": "",
"threedsTransactionId": "id-7kzs4vel57n",
"threedsId": "id-7kzs4vel57n",
"threedsStatus": "Y",
"threedsSuccess": true,
"threedsVersion": "1.0.2",
"threedsXid": "123",
"threedsAmount": "999"
}
Requerir autenticación 3DS para pago con tarjeta.
PARÁMETRO | TIPO | DESCRIPCIÓN |
---|---|---|
Requisitos | booleano (verdadero Falso) | Se requiere 3DS para pago con tarjeta. |
cantidad | número | Importe del cargo autorizado. |
Ejemplo de ThreeDSRequired
{
"required": "true",
"amount": "1.0"
}
VALOR | DESCRIPCIÓN |
---|---|
M | Coincidencia CVV2 / CVC2 / CID |
N | CVV2 / CVC2 / CID Sin coincidencia |
P | No procesado |
S | 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. |
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 |
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"
}