Field mappings for transactions through Ebanx

Last updated
Save as PDF

The following tables describe the mappings of key identifier fields for transactions between Zuora and EBANX.

To find out more information about the communication between Zuora and the gateway for payment method creation, verification, and payment processing, you can use the information in the following tables in combination with the information in the payment method transaction log and payment transaction log. For how to export transaction logs, see Discover information about payment method creation and payment processing.

Payment method validation with zero amount authorization

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
device_id	gwOptions_deviceId	Request	The unique identification of a customer’s device.
token	MITReceivedParam_Token	Response	128-character token sent by EBANX

Authorize

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
payment.name	CreditCardHolderName	Request	Cardholder name.
payment.document	IdentityNumber	Request	Customer’s document. In Brazil, a valid CPF (natural person taxpayer ID) or CNPJ (business taxpayer ID) is required.
device_id	gwOptions_deviceId	Request	Unique ID to identify the customer’s device. Used for anti-fraud checking purposes.
payment.card.token	MITSubmittedParam_Token	Request	If a previously created token is informed, no credit card information is needed. EBANX will identify the credit card associated with the token and perform the transaction.Only available for recurring billing.
payment.hash	GatewayReferenceId	Response
payment.merchant_payment_code	GatewaySecondReference	Response
payment.token	MITReceivedParam_Token	Response

Cancel authorize

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
hash	ReferenceId	Request	The authorization hash, which is the EBANX unique identifier.
merchant_payment_code	GatewaySecondReference	Response

Capture

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
hash	AuthTransactionId	Request	The authorization hash, which is the EBANX unique identifier.
hash	GatewayReferenceId	Response
merchant_payment_code	GatewaySecondReference	Response

Payment

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
payment.name	CreditCardHolderName	Request	Cardholder name.
payment.document	IdentityNumber	Request	Customer’s document. In Brazil, a valid CPF (natural person taxpayer ID) or CNPJ (business taxpayer ID) is required.
payment.merchant_payment_code	TenantId_PaymentNumber	Request	The payment hash Merchant Payment Code (unique merchant ID)
payment.merchant_payment_code	TenantId_PaymentNumber	Request	The payment hash Merchant Payment Code (unique merchant ID)
device_id	gwOptions_deviceId	Request	Unique ID to identify the customer’s device. Used for anti-fraud checking purposes.
payment.card.token	MITSubmittedParam_Token	Request	If a previously created token is informed, no credit card information is needed. EBANX will identify the credit card associated with the token and perform the transaction.Only available for recurring billing.
payment.hash	GatewayReferenceId	Response
payment.merchant_payment_code	GatewaySecondReference	Response
payment.token	MITReceivedParam_Token	Response

Cancel payment

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
hash	ReferenceId	Request	The payment hash, which is the EBANX unique identifier.
payment.hash	GatewayReferenceId	Response
payment.merchant_payment_code	GatewaySecondReference	Response

Referenced refund

EBANX API Field	Zuora Field	Request/Response	Description
integration_key	The Integration Key field in the UI	Request	Your unique and secret integration key.
hash	ReferenceId	Request	The payment hash, which is the EBANX unique identifier.
merchant_refund_code	TenantId_RefundNumber	Request	The ID of the refund in the merchant system.
refund.id	GatewayReferenceId	Response
refund.merchant_refund_code	GatewaySecondReference	Response
payment.hash	GatewayThirdReference	Response