Skip to content

Commit

Permalink
Merge pull request #3 from payping/hotfix/remove-settlement-draft
Browse files Browse the repository at this point in the history
Removed draft from SettlementStatus
  • Loading branch information
EliaDarvishnezhad authored Feb 3, 2024
2 parents 2d0c208 + c416799 commit bbe3a4d
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@
"Settlement"
],
"summary": "Query on user's Settlements",
"description": "You can filter Settlements by these fields:\r\n<br /><br /><b>Code</b>: Unique Code of Settlement\r\n<br /><br /><b>Amount</b>: Amount of Settlement\r\n<br /><br /><b>BankTransferReference</b>: Bank's transfer reference assigned to Settlement in transmission phase.\r\n<br /><br /><b>ModifiedOn</b>: Settlement's UTC Date and time of last update\r\n<br /><br /><b>CreatedOn</b>: Settlement's UTC Date and time of creation\r\n<br /><br /><b>Iban</b>: Settlement's Destination IBAN\r\n<br /><br /><b>ClientRefId</b>: Settlement's Client ref Id Assigned by creator. Unique between Settlements of in each Request\r\n<br /><br /><b>Mobile</b>: Mobile number of Settlement's receiver\r\n<br /><br /><b>NationalId</b>: National Id of Settlement's receiver\r\n<br /><br /><b>FullName</b>: Full name of Settlement's receiver\r\n<br /><br /><b>Status</b>: Determines status of a Settlement. Values of Status are:\r\n<br /><br /><b>-1 = Draft</b>: Draft means the Settlement is stored as draft and is not submitted to banking provider yet\r\n<br /><br /><b>0 = Incomplete</b>: Incomplete means the Settlement is not submitted to banking provider yet\r\n<br /><br /><b>1 = FAILED</b>: Failed means the settlement has been submitted to banking provider but it has failed in transmission phase\r\n<br /><br /><b>2 = IN_PROGRESS</b>: In progress means the settlement has been submitted to banking provider and is pending for transmission\r\n<br /><br /><b>3 = TRANSFERRED</b>: Transferred means the settlement has been submitted to banking provider and was successfully transferred\r\n<br /><br /><b>DestinationBank</b>: Destination Bank of Settlement. Values of Destination bank are: \r\n<br /><br /><b>012 = Mellat</b><br /><br /><b>019 = Saderat</b><br /><br /><b>054 = Parsian</b><br /><br /><b>056 = Saman</b><br /><br /><b>062 = Ayande</b><br /><br /><b>057 = Pasargad</b><br /><br /><b>018 = Tejarat</b><br /><br /><b>061 = Shahr</b><br /><br /><b>016 = Keshavarzi</b><br /><br /><b>017 = Melli</b><br /><br /><b>055 = EghtesadNovin</b><br /><br /><b>070 = Resalat</b><br /><br /><b>078 = MiddleEast</b><br /><br /><b> ** Notes ** </b><br /><br /><b>Field names in Filter and OrderBy clauses are not case sensitive</b>: For example both filter clauses below are correct:\r\n<br /><br /><code>\r\nFilter=Code=PT-123654\r\nFilter=Code=PT-123654\r\n</code><br /><br /><b>Field equals to given value</b>: If you want to filter fields that exactly match the given value use <b>=</b> operator. For Example:\r\n<br /><br /><code>\r\nFilter=Code=PT-123654\r\n</code><br /><br /><b>Field contains given value</b>: If you want to filter fields that contain the given value use <b>=*</b> operator. For Example:\r\n<br /><br /><code>\r\nFilter=Code= *PT-123\r\n</code><br /><br /><b>Field is not equal to given value</b>: If you want to filter fields that do not match the given value use <b>!=</b> operator. For Example:\r\n<br /><br /><code>\r\nFilter=Code!=PT-123654\r\n</code><br /><br /><b>Logical operators</b>: You can use logical operators to combine multiple filter conditions. these operators are:\r\n<br /><br /><b>And operator</b>: Use ' , '. For Example:\r\n<br /><br /><code>\r\nFilter=Code=PT-12345,Status=1\r\n</code><br /><br /><b>Or operator</b>: Use ' | ' . For Example:\r\n<br /><br /><code>\r\nFilter=Code=PT-12345|Status=1\r\n</code>",
"description": "You can filter Settlements by these fields:\r\n<br /><br /><b>Code</b>: Unique Code of Settlement\r\n<br /><br /><b>Amount</b>: Amount of Settlement\r\n<br /><br /><b>BankTransferReference</b>: Bank's transfer reference assigned to Settlement in transmission phase.\r\n<br /><br /><b>ModifiedOn</b>: Settlement's UTC Date and time of last update\r\n<br /><br /><b>CreatedOn</b>: Settlement's UTC Date and time of creation\r\n<br /><br /><b>Iban</b>: Settlement's Destination IBAN\r\n<br /><br /><b>ClientRefId</b>: Settlement's Client ref Id Assigned by creator. Unique between Settlements of in each Request\r\n<br /><br /><b>Mobile</b>: Mobile number of Settlement's receiver\r\n<br /><br /><b>NationalId</b>: National Id of Settlement's receiver\r\n<br /><br /><b>FullName</b>: Full name of Settlement's receiver\r\n<br /><br /><b>Status</b>: Determines status of a Settlement. Values of Status are:\r\n<br /><br /><b>0 = Incomplete</b>: Incomplete means the Settlement is not submitted to banking provider yet\r\n<br /><br /><b>1 = FAILED</b>: Failed means the settlement has been submitted to banking provider but it has failed in transmission phase\r\n<br /><br /><b>2 = IN_PROGRESS</b>: In progress means the settlement has been submitted to banking provider and is pending for transmission\r\n<br /><br /><b>3 = TRANSFERRED</b>: Transferred means the settlement has been submitted to banking provider and was successfully transferred\r\n<br /><br /><b>DestinationBank</b>: Destination Bank of Settlement. Values of Destination bank are: \r\n<br /><br /><b>012 = Mellat</b><br /><br /><b>019 = Saderat</b><br /><br /><b>054 = Parsian</b><br /><br /><b>056 = Saman</b><br /><br /><b>062 = Ayande</b><br /><br /><b>057 = Pasargad</b><br /><br /><b>018 = Tejarat</b><br /><br /><b>061 = Shahr</b><br /><br /><b>016 = Keshavarzi</b><br /><br /><b>017 = Melli</b><br /><br /><b>055 = EghtesadNovin</b><br /><br /><b>070 = Resalat</b><br /><br /><b>078 = MiddleEast</b><br /><br /><b> ** Notes ** </b><br /><br /><b>Field names in Filter and OrderBy clauses are not case sensitive</b>: For example both filter clauses below are correct:\r\n<br /><br /><code>\r\nFilter=Code=PT-123654\r\nFilter=Code=PT-123654\r\n</code><br /><br /><b>Field equals to given value</b>: If you want to filter fields that exactly match the given value use <b>=</b> operator. For Example:\r\n<br /><br /><code>\r\nFilter=Code=PT-123654\r\n</code><br /><br /><b>Field contains given value</b>: If you want to filter fields that contain the given value use <b>=*</b> operator. For Example:\r\n<br /><br /><code>\r\nFilter=Code= *PT-123\r\n</code><br /><br /><b>Field is not equal to given value</b>: If you want to filter fields that do not match the given value use <b>!=</b> operator. For Example:\r\n<br /><br /><code>\r\nFilter=Code!=PT-123654\r\n</code><br /><br /><b>Logical operators</b>: You can use logical operators to combine multiple filter conditions. these operators are:\r\n<br /><br /><b>And operator</b>: Use ' , '. For Example:\r\n<br /><br /><code>\r\nFilter=Code=PT-12345,Status=1\r\n</code><br /><br /><b>Or operator</b>: Use ' | ' . For Example:\r\n<br /><br /><code>\r\nFilter=Code=PT-12345|Status=1\r\n</code>",
"operationId": "SearchSettlementsListWithqueryGet",
"parameters": [
{
Expand Down Expand Up @@ -1005,8 +1005,7 @@
},
"SettlementStatus": {
"enum": [
"Draft=-1",
"InComplete=0 ",
"AwaitingSubmit=0 ",
"FAILED=1 ",
"IN_PROGRESS=2 ",
"TRANSFERRED=3 "
Expand Down

0 comments on commit bbe3a4d

Please sign in to comment.