Welcome to Zuora Product Documentation

Explore our rich library of product information

Payment hub response field

For HTTP code 200/202, the payment hub returns the Response_Body field. In Response_Body , though only the responseCode field is required, it is recommended that the payment hub can provide as many fields in the following table as possible.

Field name

Type

Description

Required in response from the payment hub

Response_Body

responseCode

string

If HTTP code 200/202 is returned, the payment status is determined by the value of responseCode , including Approved , Declined , System and Failed . Zuora will mark payment records as Processed or Error based on responseCode .

  • Approved - Processed

  • Declined - Error

  • System - Error

  • Failed - Error

Yes

gatewayResponseCode

string

A response code received from a payment gateway.

Character limit: 20

No

gatewayResponseMessage

string

A response message received from a payment gateway.

Character limit: 255

No

gatewayTransactionId

string

A reference id associated with a transaction.

Character limit: 60 for the Validate call and 100 for Payment and Refund

No

gatewaySecondTransactionId

string

A reference id associated with a transaction.

Character limit: 60 for the Validate call and 100 for Payment and Refund

No

upcTokenData

object

Custom payment method type fields. It will be updated if it is included in the response. It is only supported in case of Validate and Payment.

No