Payment Status

patch

https://app.financekey.com/OData/PaymentStatus({key})

Defines the different possible states of a payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

paymentStatusId

string

required

length between 1 and 64

The PaymentStatusId is a unique identifier field of data type nvarchar with a maximum length of 64 in the 'PaymentStatus' table. It is used to store the payment status of an order, such as 'confirmed', 'declined', etc. This field is the primary key of the table and every row in the table must have a unique PaymentStatusId for easy identification.

name

string

required

length between 1 and 128

The Name of data type nvarchar with a maximum length of 128 field in the PaymentStatus table is used to store up to 128 characters of data, such as a payment status name, in an Unicode-encoded text format.

description

string

required

length ≥ 1

Description of data type nvarchar in PaymentStatus table is used to store data such as payment status (e.g. 'Paid' or 'Unpaid') as a string value with a maximum character limit of 256.

comment

string | null

Miscellaneous notes and information for the entry or record.

bankState

string | null

The BankState field in the PaymentStatus table is a column of type nvarchar with a maximum length of 32 characters. This field stores the state or province where the bank associated with the payment is located. It is used to track the geographic location of the bank for reference and analytical purposes. The data in this field is typically entered using a two-letter abbreviation for the state or province.

Headers

content-type

string

enum

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

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!