POST api/PaymentOptions
Request Information
URI Parameters
None.
Body Parameters
PaymentOptionRequestName | Description | Type | Additional information |
---|---|---|---|
PaymentOption | PaymentOption |
Required |
|
CustomerId | string |
Required |
|
CustomerPaymentOption | Customer |
None. |
Request Formats
application/json, text/json
Sample:
{ "PaymentOption": { "Id": "sample string 1", "BankName": "sample string 2", "Iban": "sample string 3", "Bic": "sample string 4", "AccountOwner": "sample string 5", "IsDefaultPaymentMethod": true, "PaymentMethod": "sample string 7", "PaymentMethodValue": 8.0, "ValidFrom": "2025-07-01T22:51:01.6135216+02:00", "ValidTo": "2025-07-01T22:51:01.6135216+02:00" }, "CustomerId": "sample string 1", "CustomerPaymentOption": { "Id": "sample string 1", "ClientId": "sample string 2", "Salutation": "sample string 3", "Name1": "sample string 4", "Name2": "sample string 5", "Name3": "sample string 6", "DateOfBirth": "2025-07-01T22:51:01.6135216+02:00", "Street": "sample string 8", "HouseNumber": "sample str", "HouseNumberAddition": "sample string", "PostCode": "sample str", "City": "sample string 12", "CustomerNumber": "sample string 13", "Email": "sample string 14", "Phone": "sample string 15", "Phone2": "sample string 16", "Fax": "sample string 17", "Gender": "sample string 18", "Class": "sample str", "GradeLevel": 1.0, "Country": "sam", "Title": "sample string 21", "RegNr": "sample string 22", "Password": "sample string 23", "Iban": "sample string 24", "Zusatz2": "sample string 25", "MarketingPost": true, "MarketingEmail": true, "MarketingPhone": true, "FlagMarketing": true, "NoMail": true, "Bilingual": true, "CustomerCategory": [ 0, 0 ], "IdentCustomerGroup": "sample string 32" } }
application/xml, text/xml
Sample:
<PaymentOptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sts.Vas.Stp.Api.Models.Requests"> <CustomerId>sample string 1</CustomerId> <CustomerPaymentOption xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sts.Vas.ProcessesDebitor.Models"> <d2p1:Bilingual>true</d2p1:Bilingual> <d2p1:City>sample string 12</d2p1:City> <d2p1:Class>sample str</d2p1:Class> <d2p1:ClientId>sample string 2</d2p1:ClientId> <d2p1:Country>sam</d2p1:Country> <d2p1:CustomerCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sts.Vas.Constants.Enums.OnlinePortal"> <d3p1:CustomerCategory>Ebe</d3p1:CustomerCategory> <d3p1:CustomerCategory>Ebe</d3p1:CustomerCategory> </d2p1:CustomerCategory> <d2p1:CustomerNumber>sample string 13</d2p1:CustomerNumber> <d2p1:DateOfBirth>2025-07-01T22:51:01.6135216+02:00</d2p1:DateOfBirth> <d2p1:Email>sample string 14</d2p1:Email> <d2p1:Fax>sample string 17</d2p1:Fax> <d2p1:FlagMarketing>true</d2p1:FlagMarketing> <d2p1:Gender>sample string 18</d2p1:Gender> <d2p1:GradeLevel>1</d2p1:GradeLevel> <d2p1:HouseNumber>sample str</d2p1:HouseNumber> <d2p1:HouseNumberAddition>sample string</d2p1:HouseNumberAddition> <d2p1:Iban>sample string 24</d2p1:Iban> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IdentCustomerGroup>sample string 32</d2p1:IdentCustomerGroup> <d2p1:MarketingEmail>true</d2p1:MarketingEmail> <d2p1:MarketingPhone>true</d2p1:MarketingPhone> <d2p1:MarketingPost>true</d2p1:MarketingPost> <d2p1:Name1>sample string 4</d2p1:Name1> <d2p1:Name2>sample string 5</d2p1:Name2> <d2p1:Name3>sample string 6</d2p1:Name3> <d2p1:NoMail>true</d2p1:NoMail> <d2p1:Password>sample string 23</d2p1:Password> <d2p1:Phone>sample string 15</d2p1:Phone> <d2p1:Phone2>sample string 16</d2p1:Phone2> <d2p1:PostCode>sample str</d2p1:PostCode> <d2p1:RegNr>sample string 22</d2p1:RegNr> <d2p1:Salutation>sample string 3</d2p1:Salutation> <d2p1:Street>sample string 8</d2p1:Street> <d2p1:Title>sample string 21</d2p1:Title> <d2p1:Zusatz2>sample string 25</d2p1:Zusatz2> </CustomerPaymentOption> <PaymentOption xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sts.Vas.ProcessesDebitor.Models"> <d2p1:AccountOwner>sample string 5</d2p1:AccountOwner> <d2p1:BankName>sample string 2</d2p1:BankName> <d2p1:Bic>sample string 4</d2p1:Bic> <d2p1:Iban>sample string 3</d2p1:Iban> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IsDefaultPaymentMethod>true</d2p1:IsDefaultPaymentMethod> <d2p1:PaymentMethod>sample string 7</d2p1:PaymentMethod> <d2p1:PaymentMethodValue>8</d2p1:PaymentMethodValue> <d2p1:ValidFrom>2025-07-01T22:51:01.6135216+02:00</d2p1:ValidFrom> <d2p1:ValidTo>2025-07-01T22:51:01.6135216+02:00</d2p1:ValidTo> </PaymentOption> </PaymentOptionRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ResponseDataOfPaymentOptionName | Description | Type | Additional information |
---|---|---|---|
Token | string |
None. |
|
Data | PaymentOption |
None. |
Response Formats
application/json, text/json
Sample:
{ "Token": "sample string 1", "Data": { "Id": "sample string 1", "BankName": "sample string 2", "Iban": "sample string 3", "Bic": "sample string 4", "AccountOwner": "sample string 5", "IsDefaultPaymentMethod": true, "PaymentMethod": "sample string 7", "PaymentMethodValue": 8.0, "ValidFrom": "2025-07-01T22:51:01.6135216+02:00", "ValidTo": "2025-07-01T22:51:01.6135216+02:00" } }
application/xml, text/xml
Sample:
<ResponseDataOfPaymentOptionNdVm6wV7 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sts.Vas.Stp.Api.Models"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sts.Vas.ProcessesDebitor.Models"> <d2p1:AccountOwner>sample string 5</d2p1:AccountOwner> <d2p1:BankName>sample string 2</d2p1:BankName> <d2p1:Bic>sample string 4</d2p1:Bic> <d2p1:Iban>sample string 3</d2p1:Iban> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IsDefaultPaymentMethod>true</d2p1:IsDefaultPaymentMethod> <d2p1:PaymentMethod>sample string 7</d2p1:PaymentMethod> <d2p1:PaymentMethodValue>8</d2p1:PaymentMethodValue> <d2p1:ValidFrom>2025-07-01T22:51:01.6135216+02:00</d2p1:ValidFrom> <d2p1:ValidTo>2025-07-01T22:51:01.6135216+02:00</d2p1:ValidTo> </Data> <Token>sample string 1</Token> </ResponseDataOfPaymentOptionNdVm6wV7>