You are here:
Recording Gateway Responses
Payment transactions record the results of gateway communication in their Status, Gateway Status, and Gateway Response fields. Review each field to understand what happened during gateway communication. (Salesforce Billing Managed Package)
When Salesforce Billing creates a payment transaction during a payment run, it sets the transaction’s Status field to In Progress until the gateway responds or Salesforce Billing determines that the response was indeterminate. Then, it changes the status to Processed. Because Payment Center transactions are created after the gateway’s response, their payment transactions automatically have Processed statuses.
The Gateway Status field contains one of seven values based on the specific response sent from the gateway. Payment gateways have many different types of response codes, which often vary between gateway. However, the developers who set up your payment gateway integration configured your org to filter each of them into one of the seven gateway status values. This way, you can quickly see what happened to a transaction request without worrying about varying response types between different gateway providers.
The Gateway Response field shows one or more sentences providing a more detailed description of what happened in the payment gateway. This value appears exactly as the gateway sent it. If you must take corrective action following a failed transaction, use the gateway response for additional context.
Let’s take a closer look at each of the seven gateway status values, what they mean, and what action Salesforce Billing takes after recording a given response.
| Gateway Status | Definition | Salesforce Billing Action |
|---|---|---|
| Success | The gateway request succeeded. | Attempts payment creation and allocation. |
| Decline | The call to the gateway was completed successfully, but the payment gateway declined the payment. This response often happens when the customer has insufficient funds to complete the transaction. | Increases the invoice’s Declined Payment Count (Payment Run) field value by 1. Sets the invoice’s Corrective Action (Payment Run) field to Action Required. |
| Validation | Customer payment data is incorrect, such a misspelling in the credit card address or incorrect CVV. | Sets the invoice’s Corrective Action (Payment Run) field to Action Required. |
| Permanent Fail | The gateway call failed, and future requests using the same payment method won't work. This response often happens when the external gateway or customer bank detects some kind of risk, such as attempted fraud. If you receive this response, don’t make further payments using the related payment method. The customer must contact their bank to review the issue that prompted the Permanent Fail response. | Sets the invoice’s Corrective Action (Payment Run) field to Action Required. |
| Requires Review | The customer bank requires additional information before completing the payment. | Sets the invoice’s Corrective Action (Payment Run) field to Action Required. |
| Indeterminate | Salesforce Billing didn’t receive any response from the gateway. This response usually happens when Salesforce Billing times out waiting for the response. This response doesn’t increase the payment run’s failure count. | Sets the invoice’s Corrective Action (Payment Run) field to Action Required. |
| System Fail | Salesforce Billing ended the payment request call before receiving a response. For example, Salesforce Billing lost credentials or lost access to its server. This response increases the payment run’s failure count. Salesforce Billing ends payment calls if it doesn’t receive a response from the gateway in two minutes. | Sets the invoice’s Corrective Action (Payment Run) field to Action Required. |
After you evaluate your payment transaction’s gateway status, you can take your next step.
