diff --git a/swagger.json b/swagger.json index 783dfe9..c2a50de 100644 --- a/swagger.json +++ b/swagger.json @@ -330,7 +330,7 @@ "Settlement" ], "summary": "Query on user's Settlements", - "description": "You can filter Settlements by these fields:\r\n

Code: Unique Code of Settlement\r\n

Amount: Amount of Settlement\r\n

BankTransferReference: Bank's transfer reference assigned to Settlement in transmission phase.\r\n

ModifiedOn: Settlement's UTC Date and time of last update\r\n

CreatedOn: Settlement's UTC Date and time of creation\r\n

Iban: Settlement's Destination IBAN\r\n

ClientRefId: Settlement's Client ref Id Assigned by creator. Unique between Settlements of in each Request\r\n

Mobile: Mobile number of Settlement's receiver\r\n

NationalId: National Id of Settlement's receiver\r\n

FullName: Full name of Settlement's receiver\r\n

Status: Determines status of a Settlement. Values of Status are:\r\n

-1 = Draft: Draft means the Settlement is stored as draft and is not submitted to banking provider yet\r\n

0 = Incomplete: Incomplete means the Settlement is not submitted to banking provider yet\r\n

1 = FAILED: Failed means the settlement has been submitted to banking provider but it has failed in transmission phase\r\n

2 = IN_PROGRESS: In progress means the settlement has been submitted to banking provider and is pending for transmission\r\n

3 = TRANSFERRED: Transferred means the settlement has been submitted to banking provider and was successfully transferred\r\n

DestinationBank: Destination Bank of Settlement. Values of Destination bank are: \r\n

012 = Mellat

019 = Saderat

054 = Parsian

056 = Saman

062 = Ayande

057 = Pasargad

018 = Tejarat

061 = Shahr

016 = Keshavarzi

017 = Melli

055 = EghtesadNovin

070 = Resalat

078 = MiddleEast

** Notes **

Field names in Filter and OrderBy clauses are not case sensitive: For example both filter clauses below are correct:\r\n

\r\nFilter=Code=PT-123654\r\nFilter=Code=PT-123654\r\n

Field equals to given value: If you want to filter fields that exactly match the given value use = operator. For Example:\r\n

\r\nFilter=Code=PT-123654\r\n

Field contains given value: If you want to filter fields that contain the given value use =* operator. For Example:\r\n

\r\nFilter=Code= *PT-123\r\n

Field is not equal to given value: If you want to filter fields that do not match the given value use != operator. For Example:\r\n

\r\nFilter=Code!=PT-123654\r\n

Logical operators: You can use logical operators to combine multiple filter conditions. these operators are:\r\n

And operator: Use ' , '. For Example:\r\n

\r\nFilter=Code=PT-12345,Status=1\r\n

Or operator: Use ' | ' . For Example:\r\n

\r\nFilter=Code=PT-12345|Status=1\r\n", + "description": "You can filter Settlements by these fields:\r\n

Code: Unique Code of Settlement\r\n

Amount: Amount of Settlement\r\n

BankTransferReference: Bank's transfer reference assigned to Settlement in transmission phase.\r\n

ModifiedOn: Settlement's UTC Date and time of last update\r\n

CreatedOn: Settlement's UTC Date and time of creation\r\n

Iban: Settlement's Destination IBAN\r\n

ClientRefId: Settlement's Client ref Id Assigned by creator. Unique between Settlements of in each Request\r\n

Mobile: Mobile number of Settlement's receiver\r\n

NationalId: National Id of Settlement's receiver\r\n

FullName: Full name of Settlement's receiver\r\n

Status: Determines status of a Settlement. Values of Status are:\r\n

0 = Incomplete: Incomplete means the Settlement is not submitted to banking provider yet\r\n

1 = FAILED: Failed means the settlement has been submitted to banking provider but it has failed in transmission phase\r\n

2 = IN_PROGRESS: In progress means the settlement has been submitted to banking provider and is pending for transmission\r\n

3 = TRANSFERRED: Transferred means the settlement has been submitted to banking provider and was successfully transferred\r\n

DestinationBank: Destination Bank of Settlement. Values of Destination bank are: \r\n

012 = Mellat

019 = Saderat

054 = Parsian

056 = Saman

062 = Ayande

057 = Pasargad

018 = Tejarat

061 = Shahr

016 = Keshavarzi

017 = Melli

055 = EghtesadNovin

070 = Resalat

078 = MiddleEast

** Notes **

Field names in Filter and OrderBy clauses are not case sensitive: For example both filter clauses below are correct:\r\n

\r\nFilter=Code=PT-123654\r\nFilter=Code=PT-123654\r\n

Field equals to given value: If you want to filter fields that exactly match the given value use = operator. For Example:\r\n

\r\nFilter=Code=PT-123654\r\n

Field contains given value: If you want to filter fields that contain the given value use =* operator. For Example:\r\n

\r\nFilter=Code= *PT-123\r\n

Field is not equal to given value: If you want to filter fields that do not match the given value use != operator. For Example:\r\n

\r\nFilter=Code!=PT-123654\r\n

Logical operators: You can use logical operators to combine multiple filter conditions. these operators are:\r\n

And operator: Use ' , '. For Example:\r\n

\r\nFilter=Code=PT-12345,Status=1\r\n

Or operator: Use ' | ' . For Example:\r\n

\r\nFilter=Code=PT-12345|Status=1\r\n", "operationId": "SearchSettlementsListWithqueryGet", "parameters": [ { @@ -1005,8 +1005,7 @@ }, "SettlementStatus": { "enum": [ - "Draft=-1", - "InComplete=0 ", + "AwaitingSubmit=0 ", "FAILED=1 ", "IN_PROGRESS=2 ", "TRANSFERRED=3 "