Skip to content
Developerhome
Sage Network API

SfPaymentRequest

  Less than to read

API version of PaymentRequest

Required Fields

endToEndIdentifier

string, 1-36 characters

A 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

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

creditorAccount

CreditorAccount

The details about the creditor requesting the payment.

remittanceInformation

RemittanceInformation

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

Optional Fields

partialPayment

boolean, nullable

A flag to enable or disable partial payments against this payment. False by default.

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.

settlementDiscountsInfo

SettlementDiscountsInfo, nullable

An object that represents all the discounts available for a given payment.

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).

debtorAccount

DebtorAccount, nullable

The details about the debtor receiving the payment request.

risk

RiskInformation, nullable

Information related to the risk of the payment.

prepareData

object, nullable

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