The paymentgateway object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this paymentgateway |
AccessToken: string optional read-only |
Attempt3dSecure: bool optional |
BusinessId: Id required |
ConfigurationXml: string optional |
FinancialAccountId: Id optional |
Name: string required |
PaymentGatewayType: Nexudus.Coworking.Core.Enums.ePaymentGatewayType optional |
TaxRateId: Id optional |
TransactionFee: decimal? optional |
XmlResponse: string optional read-only |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this paymentgateway |
SystemId: string optional api-only
User defined data about this paymentgateway. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AccessToken": "PayPal",
"Attempt3dSecure": false,
"BusinessId": 12345678,
"ConfigurationXml": "ConfigurationXml",
"FinancialAccountId": 12345678,
"Name": "PayPal",
"PaymentGatewayType": 1,
"TaxRateId": 12345678,
"TransactionFee": ,
"XmlResponse": "XmlResponse",
"UniqueId": "1740484f-567c-43dd-8ea3-994ee1e46bb5",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a PaymentGateway
This endpoint allows you to GET a list of paymentgateways based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/billing/paymentgateways?...
π Requires role "PaymentGateway-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search paymentgateway records based on their different properties. |
Id number
?Id=12345678 |
PaymentGateway_AccessToken string
?PaymentGateway_AccessToken=... |
PaymentGateway_Attempt3dSecure bool
?PaymentGateway_Attempt3dSecure=... |
PaymentGateway_Business Business
?PaymentGateway_Business=... |
PaymentGateway_ConfigurationXml string
?PaymentGateway_ConfigurationXml=... |
PaymentGateway_FinancialAccount FinancialAccount
?PaymentGateway_FinancialAccount=... |
PaymentGateway_Name string
?PaymentGateway_Name=... |
PaymentGateway_PaymentGatewayType Nexudus.Coworking.Core.Enums.ePaymentGatewayType
?PaymentGateway_PaymentGatewayType=... |
PaymentGateway_TaxRate TaxRate
?PaymentGateway_TaxRate=... |
PaymentGateway_TransactionFee decimal?
?PaymentGateway_TransactionFee=... |
PaymentGateway_XmlResponse string
?PaymentGateway_XmlResponse=... |
Range search querystring parameters
Lets you search paymentgateway records based on a range of date or numeric values. |
To_PaymentGateway_CreatedOn date
?To_PaymentGateway_CreatedOn=2010-01-01T20:32 |
From_PaymentGateway_CreatedOn date
?From_PaymentGateway_CreatedOn=2010-01-01T20:32 |
To_PaymentGateway_UpdatedOn date
?To_PaymentGateway_UpdatedOn=2010-01-01T20:32 |
From_PaymentGateway_UpdatedOn date
?From_PaymentGateway_UpdatedOn=2010-01-01T20:32 |
To_PaymentGateway_TransactionFee number
?To_PaymentGateway_TransactionFee=0 |
From_PaymentGateway_TransactionFee number
?From_PaymentGateway_TransactionFee=10 |
Example request
GET https://spaces.nexudus.com/api/billing/paymentgateways?PaymentGateway_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "PayPal",
"PaymentGatewayType": 1,
"Attempt3dSecure": false,
"AccessToken": "PayPal",
"ConfigurationXml": "ConfigurationXml",
"XmlResponse": "XmlResponse",
"TransactionFee": ,
"FinancialAccount": ,
"TaxRate": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "b58817c0-5af6-4e5a-8d7d-ee13fe127c08",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find PaymentGateways by IDs
Gets one or more paymentgateway records based on their Id.GET https://spaces.nexudus.com/api/billing/paymentgateways?PaymentGateway_Id=[:id1,:id2,...]
π Requires role "PaymentGateway-List"
Querystring parameters |
PaymentGateway_Id: array requried
?PaymentGateway_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/billing/paymentgateways?PaymentGateway_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "PayPal",
"PaymentGatewayType": 1,
"Attempt3dSecure": false,
"AccessToken": "PayPal",
"ConfigurationXml": "ConfigurationXml",
"XmlResponse": "XmlResponse",
"TransactionFee": ,
"FinancialAccount": ,
"TaxRate": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "26bfd90e-7b5a-4106-8c1f-536128806433",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single PaymentGateway by Id
Gets one paymentgateway record by its Id.GET https://spaces.nexudus.com/api/billing/paymentgateways/:Id
π Requires role "PaymentGateway-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/billing/paymentgateways/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AccessToken": "PayPal",
"Attempt3dSecure": false,
"BusinessId": 12345678,
"ConfigurationXml": "ConfigurationXml",
"FinancialAccountId": 12345678,
"Name": "PayPal",
"PaymentGatewayType": 1,
"TaxRateId": 12345678,
"TransactionFee": ,
"XmlResponse": "XmlResponse",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "7f2dcf49-b13c-430b-bf9c-c564737e40d8",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new PaymentGateway
Creates a new paymentgateway.POST https://spaces.nexudus.com/api/billing/paymentgateways
π Requires role "PaymentGateway-Create"
Body parameters |
BusinessId: number required |
Name: string required |
PaymentGatewayType: Nexudus.Coworking.Core.Enums.ePaymentGatewayType optional |
Attempt3dSecure: bool optional |
ConfigurationXml: string optional |
TransactionFee: decimal? optional |
FinancialAccountId: number optional |
TaxRateId: number optional |
Example request
POST https://spaces.nexudus.com/api/billing/paymentgateways Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "PayPal",
"PaymentGatewayType": 1, //(check Enumerated values section below)
"Attempt3dSecure": false,
"ConfigurationXml": "ConfigurationXml",
"TransactionFee": ,
"FinancialAccountId": 12345678,
"TaxRateId": 12345678,
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update PaymentGateway
Updates an existing paymentgateway.PUT https://spaces.nexudus.com/api/billing/paymentgateways
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "PaymentGateway-Edit"
Body parameters |
Id: number required
The unique Id of the paymentgateway to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
Attempt3dSecure: bool cleared if missing |
ConfigurationXml: string cleared if missing |
TransactionFee: decimal? cleared if missing |
FinancialAccountId: number cleared if missing |
TaxRateId: number cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/billing/paymentgateways Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "PayPal",
"PaymentGatewayType": 1, //(check Enumerated values section below)
"Attempt3dSecure": false,
"ConfigurationXml": "ConfigurationXml",
"TransactionFee": ,
"FinancialAccountId": 12345678,
"TaxRateId": 12345678,
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete PaymentGateway
Deletes an existing paymentgateway by its Id.DELETE https://spaces.nexudus.com/api/billing/paymentgateways/:Id
π Requires role "PaymentGateway-Delete"
URL parameters |
Id: number required
The unique Id of the paymentgateway to update. |
Example request
DELETE https://spaces.nexudus.com/api/billing/paymentgateways/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more paymentgateway records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for paymentgateway records.GET https://spaces.nexudus.com/api/billing/paymentgateways/commands
Example request
GET https://spaces.nexudus.com/api/billing/paymentgateways/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more paymentgateway record IDs.POST https://spaces.nexudus.com/api/billing/paymentgateways/runacommandπ Requires role "PaymentGateway-Edit"
Example request
POST https://spaces.nexudus.com/api/billing/paymentgateways/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Enumerated values
PaymentGatewayType
GET /api/utils/enums?name=ePaymentGatewayType
Comments
Please sign in to leave a comment.