POST api/BillingService/AddPaymentMethod

Documentation for 'AddPaymentMethod'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "type": 1,
  "holder_name": "sample string 2",
  "encrypted_card_number": "sample string 3",
  "encrypted_expiry_month": "sample string 4",
  "encrypted_expiry_year": "sample string 5",
  "encrypted_security_code": "sample string 6",
  "billing_address": {
    "country": "sample string 1",
    "state_or_province": "sample string 2",
    "city": "sample string 3",
    "street": "sample string 4",
    "house_number_or_name": "sample string 5",
    "postal_code": "sample string 6"
  },
  "description": "sample string 7",
  "payment_gateway_name": "sample string 8"
}

application/xml, text/xml

Sample:

<AddPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.Billing">
  <billing_address>
    <city>sample string 3</city>
    <country>sample string 1</country>
    <house_number_or_name>sample string 5</house_number_or_name>
    <postal_code>sample string 6</postal_code>
    <state_or_province>sample string 2</state_or_province>
    <street>sample string 4</street>
  </billing_address>
  <description>sample string 7</description>
  <encrypted_card_number>sample string 3</encrypted_card_number>
  <encrypted_expiry_month>sample string 4</encrypted_expiry_month>
  <encrypted_expiry_year>sample string 5</encrypted_expiry_year>
  <encrypted_security_code>sample string 6</encrypted_security_code>
  <holder_name>sample string 2</holder_name>
  <payment_gateway_name>sample string 8</payment_gateway_name>
  <type>1</type>
</AddPaymentMethodRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "payment_method_text_id": "sample string 1",
  "authorisation_state": 64,
  "is_success": true,
  "error_message": "sample string 4",
  "exception_name": "sample string 5",
  "error_code": 6
}

application/xml, text/xml

Sample:

<AddPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.Billing">
  <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">6</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 4</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 5</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
  <authorisation_state>64</authorisation_state>
  <payment_method_text_id>sample string 1</payment_method_text_id>
</AddPaymentMethodResponse>