TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 20 Type: Number This is the unique numeric identifier for the PaymentGateway |
ownerId READ-ONLY | "ownerId": 26 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "Hello World" Type: String |
gatewayToken | "gatewayToken": "Hello World" Type: String |
description | "description": "Hello World" Type: String |
gatewayTypeId | "gatewayTypeId": 15 Type: Number Unique identifier for the associated GatewayType object. |
gatewayTypeName | "gatewayTypeName": "Sample Name" Type: String The name of the object associated with the gatewayTypeId property. |
isActive | "isActive": true Type: Boolean |
isCvvRequired | "isCvvRequired": true Type: Boolean |
apiKeyName | "apiKeyName": "Hello World" Type: String |
paymentApiUrl | "paymentApiUrl": "Hello World" Type: String |
managementApiUrl | "managementApiUrl": "Hello World" Type: String |
is3DS2Enabled | "is3DS2Enabled": true Type: Boolean |
productionUrlPrefix | "productionUrlPrefix": "Hello World" Type: String |
paymentGatewayCaptureTypeId | "paymentGatewayCaptureTypeId": 1 Type: Number Unique identifier for the associated PaymentGatewayCaptureType object. |
paymentGatewayCaptureTypeName | "paymentGatewayCaptureTypeName": "Sample Name" Type: String The name of the object associated with the paymentGatewayCaptureTypeId property. |
| GET | PaymentGateway/ |
| Retrieve all of the PaymentGateway objects. | |
Retrieve all of the PaymentGateway objects. GET PaymentGateway/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 10,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"gatewayToken": "Sample Text Data",
"description": "Sample Text Data",
"gatewayTypeId": 19,
"gatewayTypeName": "Sample Text Data",
"isActive": true,
"isCvvRequired": true,
"apiKeyName": "Sample Text Data",
"paymentApiUrl": "Sample Text Data",
"managementApiUrl": "Sample Text Data",
"is3DS2Enabled": true,
"productionUrlPrefix": "Sample Text Data",
"paymentGatewayCaptureTypeId": 12,
"paymentGatewayCaptureTypeName": "Sample Text Data"
}
]
} | |
| GET | PaymentGateway/Paged |
| Retrieve all of the PaymentGateway objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the PaymentGateway objects in a paged fashion. GET PaymentGateway/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"gatewayToken": "Sample Text Data",
"description": "Sample Text Data",
"gatewayTypeId": 4,
"gatewayTypeName": "Sample Text Data",
"isActive": true,
"isCvvRequired": true,
"apiKeyName": "Sample Text Data",
"paymentApiUrl": "Sample Text Data",
"managementApiUrl": "Sample Text Data",
"is3DS2Enabled": true,
"productionUrlPrefix": "Sample Text Data",
"paymentGatewayCaptureTypeId": 13,
"paymentGatewayCaptureTypeName": "Sample Text Data"
}
]
}
} | |
| GET | PaymentGateway/{id} |
| Retrieve an instance of the PaymentGateway object by its ID. | |
| {id} | Unique identifier for the PaymentGateway object. |
Retrieve an instance of the PaymentGateway object by its ID. GET PaymentGateway/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 5,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"gatewayToken": "Sample Text Data",
"description": "Sample Text Data",
"gatewayTypeId": 5,
"gatewayTypeName": "Sample Text Data",
"isActive": true,
"isCvvRequired": true,
"apiKeyName": "Sample Text Data",
"paymentApiUrl": "Sample Text Data",
"managementApiUrl": "Sample Text Data",
"is3DS2Enabled": true,
"productionUrlPrefix": "Sample Text Data",
"paymentGatewayCaptureTypeId": 26,
"paymentGatewayCaptureTypeName": "Sample Text Data"
}
} | |
| GET | PaymentGateway/{id}/Detail |
| Retrieve deep detail of the PaymentGateway object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the PaymentGateway object. |
Retrieve deep detail of the PaymentGateway object by its ID. GET PaymentGateway/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"gatewayToken": "Sample Text Data",
"description": "Sample Text Data",
"gatewayTypeId": 20,
"gatewayTypeName": "Sample Text Data",
"isActive": true,
"isCvvRequired": true,
"apiKeyName": "Sample Text Data",
"paymentApiUrl": "Sample Text Data",
"managementApiUrl": "Sample Text Data",
"is3DS2Enabled": true,
"productionUrlPrefix": "Sample Text Data",
"paymentGatewayCaptureTypeId": 12,
"paymentGatewayCaptureTypeName": "Sample Text Data",
"details": {
"paymentTypes": [
{
"identity": 63,
"name": "Sample Text Data",
"generalLedgerId": 82,
"generalLedgerName": "Sample Text Data",
"paymentBaseTypeId": 6,
"paymentBaseTypeName": "Sample Text Data",
"paymentTypeDisbursementTypeId": 69,
"paymentTypeDisbursementTypeName": "Sample Text Data",
"description": "Sample Text Data",
"isActive": true,
"paymentGatewayId": 6,
"paymentGatewayName": "Sample Text Data",
"cardTypeId": 83,
"cardTypeName": "Sample Text Data",
"paymentProviderId": 85,
"paymentProviderName": "Sample Text Data"
}
],
"paymentGatewayCallbackSetting": [
{
"identity": 67,
"userAgent": "Sample Text Data",
"authUserId": 2,
"authUserName": "Sample Text Data",
"hmacKeyName": "Sample Text Data",
"paymentGatewayId": 61,
"paymentGatewayName": "Sample Text Data",
"hmacKey": "Sample Text Data"
}
],
"adyenMerchantAccounts": [
{
"identity": 17,
"name": "Sample Text Data",
"isActive": true,
"paymentGatewayId": 67,
"paymentGatewayName": "Sample Text Data"
}
],
"adyenMerchantAccountCountries": [
{
"identity": 55,
"countryId": 45,
"countryName": "Sample Text Data",
"adyenMerchantAccountId": 81,
"adyenMerchantAccountName": "Sample Text Data",
"dropInAdyenMerchantAccountId": 62,
"countryCode": "Sample Text Data",
"dropInAdyenMerchantAccountName": "Sample Text Data"
}
]
}
}
} | |