Skip to content
Developerhome
Product homepage
Sage Network API

SfPaymentResponse

  Less than to read

API version of PaymentResponse

Methods

The following API methods use this data model.

string, nullable

The unique identifier of the payment.

createDateTime

date-time, nullable

Date the orginal request was created in ISO 8601 date format.

status

string, nullable

The payment status Values: “UNAUTHORISED” “PENDING” “PAID” “PAID_OFFLINE” “FAILED” “CANCELLED” “REJECTED” “REFUNDED” “PARTIALLY” “PARTIALLY_REFUNDED”

cancellable

boolean, nullable

A boolean field indicating whether the payment is in a state that can be cancelled. All PENDING payments can be cancelled, but other statuses are provider-dependent.

updateDateTime

date-time, nullable

Date the request was last updated in ISO 8601 date format.

initiatedDateTime

date-time, nullable

The date when the real-world payment request was initiated (for example, date upon which an invoice was created), ISO-8601 format. If before 1st January, 1970, initiatedDateTime will be set to null.

dueDate

date-time, nullable

Date the payment is due in ISO 8601 date format. If before 1st January, 1970, dueDate will be set to null.

offlineMethod

string, nullable

The method that was used to pay an invoice outside of Payments Acceptance. Values: “CASH” “CHEQUE” “DIRECT_CREDIT” “DIRECT_DEBIT” “CARD” “VOUCHER” “CREDIT_NOTE” “UNKNOWN” “OTHER”

otherOfflineMethod

string, nullable

A free text field for describing offline payment methods not covered by the offlineMethod property. Should only be used with the OTHER offline method.

endToEndIdentifier

string, nullable

Unique identifier assigned by the payment initiator to unambiguously identify the payment. The identifier is passed on, unchanged, throughout the entire end-to-end chain.

instructedAmount

InstructedAmount, nullable

An object that represents an amount of money in a specific currency.

fee

int32, nullable

The fee levied by the payment provider for the payment, in minor units of the invoice currency. This will only be available for paid or partially paid invoices. Not all providers will be able to provide fee information, so this field may be null even for paid invoices. Where provided, this field will be non-negative.

reportingAmount

ReportingAmount, nullable

Net amount and fees as converted into servicer account currency.

paidToDate

int32, nullable

Amount of the payment that has been paid until now.

outstandingAmount

string, nullable

Amount of the payment still outstanding (excluding fees/charges). Maximum value is instructed amount.

refundedAmount

string, nullable

Amount of the payment that has been refunded. Maximum value is instructed amount.

debtorPaymentMethods

string[], nullable

Array of payment methods which the debtor can choose from in order to pay. Primarily used to populate the PayNow options page (for example, card, PayPal, ACH).

creditorAccount

CreditorAccount, nullable

Details about the creditor requesting the payment.

debtorAccount

DebtorAccount, nullable

The details about the debtor receiving the payment request.

remittanceInformation

RemittanceInformation, nullable

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as a commercial invoice.

risk

RiskInformation, nullable

Information related to the risk of the payment.

metadata

Metadata, nullable

Base64 encoded strings that when decoded, can be added to html emails to provider markup in supported email clients.

partialPayment

boolean, nullable

Flag of whether this is a partial payment

type

string, nullable

The type of the payment. Values: “INVOICE” “STATEMENT” “PAY_ON_ACCOUNT”

paymentSessionId

string, nullable

The payment session ID returned in the POST /payments/{paymentId}/prepare response. When the prepare response includes a paymentSessionId it is mandatory to include it as part of this payload. Otherwise, the request will fail with a 400 error.

redirectUri

string, nullable

The redirect uri for the payment.

prepareData

object, nullable

An arbitrary dictionary of key-value data to be sent to the payment provider. May be null or empty.