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

• application/vnd.mcn.transaction-service.api.v.1+json
• application/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.

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.

Recursos

• / 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
• / transaction / payment-tokens / {payment_token_id}
• /transacciones/pago-tokens/{pago_token_id}
• /transacciones/fichas-de-pago/tres/{pago_token_id}

parámetros

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

• / fichas-de-pago / solo-comerciante
• /tokens-de-pago/cliente-objetivo
• /pago-tokens/programa-especificado

parámetros

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

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

CreditCardWithCvvPaymentInfo

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

Recursos

• / fichas-de-pago / solo-comerciante-verificar

parámetros

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

• /tokens de pago/solo comerciante
• / fichas-de-pago / solo-comerciante-verificar
• /tokens-de-pago/cliente-objetivo
• /pago-tokens/programa-especificado

parámetros

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 passThroughInfo La matriz representa información emparejada personalizada que se pasa al servicio de transacciones.

Recursos

• transacciones/pago-tokens/{pago_token_id} (ENVIAR)
• transacciones/pago-tokens/tres/{pago_token_id}

Parámetros

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

• / fichas-de-pago / solo-comerciante
• /tokens-de-pago/cliente-objetivo
• /pago-tokens/programa-especificado

Ejemplo de información de pago

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

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.

• application/vnd.mcn.transaction-service.api.v.1+json

Recursos

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

parámetros

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.

• application/vnd.mcn.transaction-service.api.v.2+json

Recursos

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

parámetros

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.

• application/vnd.mcn.transaction-service.api.v.1+json

Recursos

• / fichas-de-pago / solo-comerciante-verificar

parámetros

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.

• application/vnd.mcn.transaction-service.api.v.2+json

Recursos

• / fichas-de-pago / solo-comerciante-verificar

parámetros

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

• / transaction / payment-tokens / {payment_token_id}

parámetros

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

• / fichas-de-pago / solo-comerciante

parámetros

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

• / fichas-de-pago / solo-comerciante-verificar

parámetros

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

• /pago-tokens/programa-especificado

parámetros

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

• /tokens-de-pago/cliente-objetivo

parámetros

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

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

parámetros

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

• / transaction / payment-tokens / {payment_token_id}

parámetros

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

• /transacciones/fichas-de-pago/tres/{pago_token_id}

parámetros

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"
}

ThreeDSRequerido

Requerir autenticación 3DS para pago con tarjeta.

Recursos

• /pago-fichas/{pagoTokenId}/tres-requeridos
• /tokens-de-pago/tres-requeridos

parámetros

Ejemplo de ThreeDSRequired

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

Respuestas de verificación de CVV2

Respuestas AVS

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"
}