Additional Features
Additional methods for interacting with the Cycle REST API.
Get Account Processing Configuration
Endpoint
GET /api/v1/payment/AuthAccountExample Request: https://web-api-pro-demo.cardport.net/api/v1/payment/AuthAccount
Rate Limiting
The frequency of requests for this method should not exceed more than one request every 10 minutes in standard mode.
Request Body
| Field Name | Type | Description |
|---|---|---|
CurrentAccountID | Integer | User ID |
Lang | String | Language |
IP | String | IP address (external IP of the device from which the request is made) |
Response Body
| Field Name | Type | Description |
|---|---|---|
SessionID | Integer | Session ID |
LanguageID | String | Language |
ID | Integer | User ID |
ClientID | Integer | Customer ID |
CurrencyID | String | Currency ID |
CountryID | String | Country ID |
CountryName | String | Country Name |
IsSystemUser | Boolean | Is a system user |
PaymentOptions | JSON object | Available payment methods |
Id | Integer | Payment Method ID |
AcquirerCode | String | Payment method name |
RequiresEmailOrPhone | Integer | |
RequiresEmailOrPhoneForOwnFiscalization | Integer | |
AcquirerName | String | Acquirer name |
ImgUrl | String | Payment Method Icon Link |
ProductDescCodesRE | Integer | Custom Products |
ProductDescCodes | Object | Custom Products |
ProductDescListPhone | Array | List of custom products for phone |
Example Response
{
"SessionID": null,
"LanguageID": "en",
"ID": 19083,
"ClientID": 18349,
"CurrencyID": "ZAR",
"CountryID": "ZA",
"CountryName": "South Africa",
"IsSystemUser": false,
"PaymentOptions": [
{
"Id": 10,
"AcquirerCode": "CASH",
"RequiresEmailOrPhone": 0,
"RequiresEmailOrPhoneForOwnFiscalization": 0,
"AcquirerName": "Cash",
"ImgUrl": "https://static-demo.cardport.net/item.aspx?stock=creditcard&stockname=po_cash",
"ProductDescCodesRE": null,
"ProductDescCodes": null
}
],
"ProductDescListPhone": []
}