Payments

The Payment table in the Payment package is a comprehensive database that stores records of all financial transactions made within the system. It is designed to track the details of payments made by customers or clients, including date, amount, payment method, and invoice number. This table also contains information about payment status, such as pending, completed, or cancelled. The Payment table provides a clear overview of all payments made, making it easier for businesses to manage their financial records and reconcile accounts. Additionally, it allows for the efficient tracking and reporting of payment activities, providing valuable insights into a company's cash flow. Complete with well-organized columns and rows, the Payment table is a critical component for any business looking to maintain accurate and organized financial data.

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

The PaymentId field in the Payment table is an integer type that stores a unique identifier for each payment. This integer value is used to reference and manage individual payments.

double
required

The Amount field of data type decimal in the Payment table stores the numerical amount associated with a particular payment.

string | null

CurrencyId is an nvarchar field to store the 3-letter code of the accepted currency for a payment within the Payment table. Its maximum length of 128 characters should include enough characters for different international currencies.

string | null

The ChargeBearerId field in the Payment table stores a unique string of characters up to 64 characters in length associated with the charge bearer of a payment.

date-time
required

The ValueDate field in the Payment table is a datetime2 data type that stores the date the payment was processed or the date of the value for the payment.

string | null

The Reference field in the Payment table is a nvarchar data type with a maximum length of 128 characters, and is used to store a unique reference code for each payment record.

string | null

The StatusId field in the Payment table is a nvarchar field with a maximum length of 64 characters. It is used to track the status of payments, such as “Paid”, “Unpaid” and “Cancelled,” which are stored as alphanumeric values in the field.

int32

The DebtorInstructionId field in the Payment table is an integer data type that is used to store the unique id associated with a debtor payment instruction.

int32

CreditorInstructionId is an integer data type that is associated with each payment in the Payment table. It acts as a unique identifier for each payment linked to a specific creditor.

string | null

RemittanceInformation is an nvarchar field in the Payment table which stores additional, user-defined details about a payment in the form of text. It allows users to keep track of supplementary information that may not necessarily fit into the other categories in the table, e.g. payment originator or intended recipient, which can provide helpful context when running queries or troubleshooting.

string | null

The PaymentMessage field in the Payment table contains message text about each payment made by customers. This could include information about the payment itself, links to resources, or other related messages for the payment.

int32 | null

The PaymentSetId field is an integer datatype used to uniquely identify a payment record in the Payment table. It is used as a primary key to ensure there is no duplication of payments and to store and refer back to the payment information.

string | null

Miscellaneous notes and information for the entry or record.

string | null

The BankReference field in the Payment table contains a string up to 64 characters long containing a reference to a payment received from a bank, such as a transaction ID from an interface or a check number.

double
required

Field Name: ReportingAmount Data Type: Decimal Description: Represents the total amount of money reported for a payment transaction, allowing for precise calculations involving currency values. This field may include cents, providing a detailed and accurate financial representation for reporting and reconciliation purposes.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

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