GET v3/custom-payment-types
Return the details of all custom payment types
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of CustomPaymentTypeName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Id | string |
None. |
|
IsRefund | boolean |
None. |
|
AttributeDefinitions | Collection of AttributeDefinition |
None. |
Response Formats
application/json
Sample:
[ { "name": "sample string 1", "id": "sample string 2", "isRefund": true, "attributeDefinitions": [ { "name": "sample string 1", "isRequired": true, "type": "sample string 3" }, { "name": "sample string 1", "isRequired": true, "type": "sample string 3" } ] }, { "name": "sample string 1", "id": "sample string 2", "isRefund": true, "attributeDefinitions": [ { "name": "sample string 1", "isRequired": true, "type": "sample string 3" }, { "name": "sample string 1", "isRequired": true, "type": "sample string 3" } ] } ]
text/xml
Sample:
<CustomPaymentTypes> <CustomPaymentType> <Name>sample string 1</Name> <Id>sample string 2</Id> <IsRefund>true</IsRefund> <AttributeDefinitions> <AttributeDefinition> <Name>sample string 1</Name> <IsRequired>true</IsRequired> <Type>sample string 3</Type> </AttributeDefinition> <AttributeDefinition> <Name>sample string 1</Name> <IsRequired>true</IsRequired> <Type>sample string 3</Type> </AttributeDefinition> </AttributeDefinitions> </CustomPaymentType> <CustomPaymentType> <Name>sample string 1</Name> <Id>sample string 2</Id> <IsRefund>true</IsRefund> <AttributeDefinitions> <AttributeDefinition> <Name>sample string 1</Name> <IsRequired>true</IsRequired> <Type>sample string 3</Type> </AttributeDefinition> <AttributeDefinition> <Name>sample string 1</Name> <IsRequired>true</IsRequired> <Type>sample string 3</Type> </AttributeDefinition> </AttributeDefinitions> </CustomPaymentType> </CustomPaymentTypes>