--- schema_version: "1" id: 41440639d8a8234074df0569481f57717f70d812f34053dacd3a98f24db2adc6 title: CaptureNotification Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_commercepayments_CaptureNotification.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm source_site: developer.salesforce.com content_type: documentation content_hash: 34bbc7eff6729f090295b0ebf1d01ccadc7f76ce8ddc12062fbb45f9c85504b5 description: When a payment gateway sends a notification for a capture transaction, the payment gateway adapter creates the CaptureNotification object to store information about the notification.Sets the transaction amount. Must be a non-negative value.Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters.Sets the date that the transaction occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the payment request. Maximum length of 255 characters.Sets additional data that you can use for subsequent transactions. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML.Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a gateway returned. Maximum length of 1000 characters.Sets the ID of a notification sent by the payment gateway.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.Sets the notification status to the same value that was sent by the gateway. --- # CaptureNotification Class When a payment gateway sends a notification for a capture transaction, the payment gateway adapter creates the CaptureNotification object to store information about the notification. ## Namespace [CommercePayments](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_commercepayments.htm "Use the CommercePayments namespace to provide a safe and customizable platform for managing customer payments and refunds.") ## Usage CaptureNotification is used in asynchronous payment gateway adapters. Specify the CommercePayments namespace when creating an instance of this class. The constructor of this class takes no arguments. For example: CommercePayments.CaptureNotification crn = new CommercePayments.CaptureNotification(); ## Example commercepayments.BaseNotification notification = null; if ('CAPTURE'.equals(eventCode)) { notification = new commercepayments.CaptureNotification(); } else if ('REFUND'.equals(eventCode)) { notification = new commercepayments.ReferencedRefundNotification(); } - **[CaptureNotification Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_methods)** ## CaptureNotification Methods The following are methods for CaptureNotification. - **[setAmount(amount)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setAmount)** Sets the transaction amount. Must be a non-negative value. - **[setGatewayAvsCode(gatewayAvsCode)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayAvsCode)** Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters. - **[setGatewayDate(gatewayDate)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayDate)** Sets the date that the transaction occurred. Some gateways don’t send this value. - **[setGatewayMessage(gatewayMessage)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayMessage)** Sets error messages that the gateway returned for the payment request. Maximum length of 255 characters. - **[setGatewayReferenceDetails(gatewayReferenceDetails)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayReferenceDetails)** Sets additional data that you can use for subsequent transactions. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. - **[setGatewayReferenceNumber(gatewayReferenceNumber)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayReferenceNumber)** Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters. - **[setGatewayResultCode(gatewayResultCode)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayResultCode)** Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters. - **[setGatewayResultCodeDescription(gatewayResultCodeDescription)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setGatewayResultCodeDescription)** Sets a description of the gateway-specific result code that a gateway returned. Maximum length of 1000 characters. - **[setId(id)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setId)** Sets the ID of a notification sent by the payment gateway. - **[setSalesforceResultCodeInfo(salesforceResultCodeInfo)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setSalesforceResultCodeInfo)** Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes. - **[setStatus(status)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_CaptureNotification.htm#apex_commercepayments_CaptureNotification_setStatus)** Sets the notification status to the same value that was sent by the gateway. ### setAmount(amount) Sets the transaction amount. Must be a non-negative value. #### Signature global void setAmount(Double amount) #### Parameters - **amount**: Type: [Double](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_double.htm#apex_methods_system_double "Contains methods for the Double primitive data type.") The amount to be debited or captured. #### Return Value Type: void ### setGatewayAvsCode(gatewayAvsCode) Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters. #### Signature public void setGatewayAvsCode(String gatewayAvsCode) #### Parameters - **gatewayAvsCode**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Used to verify the address mapped to a payment method when the payments platform requests tokenization from the payment gateway. #### Return Value Type: void ### setGatewayDate(gatewayDate) Sets the date that the transaction occurred. Some gateways don’t send this value. #### Signature global void setGatewayDate(Datetime gatewayDate) #### Parameters - **gatewayDate**: Type: [Datetime](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_datetime.htm#apex_methods_system_datetime "Contains methods for the Datetime primitive data type.") Date and time of the gateway communication. #### Return Value Type: void ### setGatewayMessage(gatewayMessage) Sets error messages that the gateway returned for the payment request. Maximum length of 255 characters. #### Signature global void setGatewayMessage(String gatewayMessage) #### Parameters - **gatewayMessage**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Information on error messages sent from the gateway. #### Return Value Type: void ### setGatewayReferenceDetails(gatewayReferenceDetails) Sets additional data that you can use for subsequent transactions. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. #### Signature global void setGatewayReferenceDetails(String gatewayReferenceDetails) #### Parameters - **gatewayReferenceDetails**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setGatewayReferenceNumber(gatewayReferenceNumber) Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters. #### Signature global void setGatewayReferenceNumber(String gatewayReferenceNumber) #### Parameters - **gatewayReferenceNumber**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Unique transaction ID created by the payment gateway. #### Return Value Type: void ### setGatewayResultCode(gatewayResultCode) Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters. #### Signature global void setGatewayResultCode(String gatewayResultCode) #### Parameters - **gatewayResultCode**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Gateway-specific result code. Map this value to a Salesforce-specific result code. #### Return Value Type: void ### setGatewayResultCodeDescription(gatewayResultCodeDescription) Sets a description of the gateway-specific result code that a gateway returned. Maximum length of 1000 characters. #### Signature global void setGatewayResultCodeDescription(String gatewayResultCodeDescription) #### Parameters - **gatewayResultCodeDescription**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Description of the gateway’s result code. Use this field to learn more about why the gateway returned a certain result code. #### Return Value Type: void ### setId(id) Sets the ID of a notification sent by the payment gateway. #### Signature global void setId(String id) #### Parameters - **id**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setSalesforceResultCodeInfo(salesforceResultCodeInfo) Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes. #### Signature global void setSalesforceResultCodeInfo(commercepayments.SalesforceResultCodeInfo salesforceResultCodeInfo) #### Parameters - **salesforceResultCodeInfo**: Type: [commercepayments.SalesforceResultCodeInfo](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_SalesforceResultCodeInfo.htm#apex_class_commerce_payments_SalesforceResultCodeInfo "Stores Salesforce result code information from payment gateway adapters.") Description of the Salesforce result code value. #### Return Value Type: void ### setStatus(status) Sets the notification status to the same value that was sent by the gateway. #### Signature global void setStatus(commercepayments.NotificationStatus status) #### Parameters - **status**: Type: [NotificationStatus](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_commercepayments_NotificationStatus.htm "Shows whether the payments platform successfully received the notification from the gateway.") Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes. #### Return Value Type: void