Payment Sets

A payment set is a collection of 1 or more payments that can be processed in a group or batch. Where there are multiple payments in the set, it is given that all the payments will be initiated by the same payment institution, and will have a common format.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

PaymentSetId is an integer data field in the PaymentSet table used to uniquely identify each payment set. This field should contain a unique value for each payment set stored in this table.

string | null

PaymentSetStateId is a field in the PaymentSet table that stores state information related to a payment set, represented as a string of up to 32 characters in length. The state information can be any string that is related to the specific payment set.

string | null

Miscellaneous notes and information for the entry or record.

int32

PaymentCount is an int field in the PaymentSet table which stores the number of payments made for a particular item or transaction.

string | null

The PaymentSetMessage field is an nvarchar data type in the PaymentSet table that holds text referring to the payment transactions that can be used to describe the payment status of those transactions.

int32

The IntegrationId field in the PaymentSet table is an integer value used as a unique identifier for an integration record which links external payment records to the payment records in PaymentSet.

string | null

The BankReference field in the PaymentSet table is an nvarchar data type of up to 64 characters used to store a customer's bank reference associated with a payment.

string | null

The PaymentSetStateMessage field in the PaymentSet table is a data type of nvarchar with a maximum length of 4000 characters. This field is used to store a message that describes the current state of a payment. It may provide information on the status of the payment, any updates or changes that have been made, or any errors or issues that have occurred during processing. This field allows for clear and concise communication and tracking of payment statuses within the PaymentSet table.

string | null

The 'Filename' field in the PaymentSet table is designed to store the name of a file associated with a payment record. It is of type nvarchar, allowing for Unicode character storage, and has a maximum length of 256 characters. This enables the field to accommodate diverse file naming conventions and extends support for international character sets, ensuring compatibility with various languages and symbols. The Filename field is essential for linking payment records to their corresponding files, facilitating efficient data management and retrieval.

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!