SfSubmitPaymentResponse

API version of SubmitPaymentResponse

Methods

The following API methods use this data model.

• Submit Payment

  Required Fields

  paymentSubmissionId

string

The unique identifier of the payment submission transaction.

paymentMethodUsed

string

Payment method used.

failureReason

string

Reason why the payment submission failed or was rejected.

receiptDestination

string

The email where the receipt was sent. In many cases, this will be the same as the debtor email on the original payment however this should not be assumed for some payment providers (For example, Paypal).

Optional Fields

status

string, nullable

Enum: “SUCCEEDED” “PENDING” “DECLINED” “FAILED” “SUBMITTED” “PROCESSING” “DISPUTED” “CANCELLED” “UNKNOWN” Status of the payment submission.

receiptSent

string, nullable

Enum: “YES” “NO” “UNKNOWN” A tri-state flag indicating whether an email receipt was sent. If yes, the receiptDestination field will indicate where the receipt was sent. With some providers, we may not know whether receipts are configured to be sent. In these cases, the field will be set to UNKNOWN. Many providers will not send email notifications for failed or declined payments, however some may.