POST Vipps/UpdateAgreement

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
AgreementID		string	None.
status		string	None.
interval		VippsAgreementRequestUpdateInterval	None.
IdempotencyKey		string	None.
pricing		VippsAgreementRequestPricing	None.
initialCharge		VippsAgreementInitialCharge	None.
merchantRedirectUrl		string	None.
merchantAgreementUrl		string	None.
phoneNumber		string	None.
productName		string	None.
productDescription		string	None.
externalId	An optional external ID for the agreement. The externalId can be used by the merchant to map the agreementId to an ID in a subscription system or similar.	string	None.
countryCode	"NO" "DK" "FI"	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AgreementID": "sample string 1",
  "status": "sample string 2",
  "interval": {
    "type": "sample string 1",
    "period": {
      "unit": "sample string 1",
      "count": 2
    }
  },
  "IdempotencyKey": "sample string 3",
  "pricing": {
    "type": "sample string 1",
    "amount": 1,
    "currency": "sample string 2",
    "suggestedMaxAmount": 1
  },
  "initialCharge": {
    "amount": 1,
    "description": "sample string 1",
    "transactionType": "sample string 2",
    "orderId": "sample string 3",
    "externalId": "sample string 4"
  },
  "merchantRedirectUrl": "sample string 4",
  "merchantAgreementUrl": "sample string 5",
  "phoneNumber": "sample string 6",
  "productName": "sample string 7",
  "productDescription": "sample string 8",
  "externalId": "sample string 9",
  "countryCode": "sample string 10"
}

text/html

Sample:

{"AgreementID":"sample string 1","status":"sample string 2","interval":{"type":"sample string 1","period":{"unit":"sample string 1","count":2}},"IdempotencyKey":"sample string 3","pricing":{"type":"sample string 1","amount":1,"currency":"sample string 2","suggestedMaxAmount":1},"initialCharge":{"amount":1,"description":"sample string 1","transactionType":"sample string 2","orderId":"sample string 3","externalId":"sample string 4"},"merchantRedirectUrl":"sample string 4","merchantAgreementUrl":"sample string 5","phoneNumber":"sample string 6","productName":"sample string 7","productDescription":"sample string 8","externalId":"sample string 9","countryCode":"sample string 10"}

application/xml, text/xml

Sample:

<VippsAgreementUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CTHelpers">
  <IdempotencyKey>sample string 3</IdempotencyKey>
  <countryCode>sample string 10</countryCode>
  <externalId>sample string 9</externalId>
  <initialCharge>
    <amount>1</amount>
    <description>sample string 1</description>
    <externalId>sample string 4</externalId>
    <orderId>sample string 3</orderId>
    <transactionType>sample string 2</transactionType>
  </initialCharge>
  <merchantAgreementUrl>sample string 5</merchantAgreementUrl>
  <merchantRedirectUrl>sample string 4</merchantRedirectUrl>
  <phoneNumber>sample string 6</phoneNumber>
  <pricing>
    <amount>1</amount>
    <currency>sample string 2</currency>
    <suggestedMaxAmount>1</suggestedMaxAmount>
    <type>sample string 1</type>
  </pricing>
  <productDescription>sample string 8</productDescription>
  <productName>sample string 7</productName>
  <AgreementID>sample string 1</AgreementID>
  <interval>
    <period>
      <count>2</count>
      <unit>sample string 1</unit>
    </period>
    <type>sample string 1</type>
  </interval>
  <status>sample string 2</status>
</VippsAgreementUpdateRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'VippsAgreementUpdateRequest'.

Response Information

Resource Description

VippsAgreement

Name	Type	Additional information
Status	string	None.
AgreementID	string	None.
ChargeID	string	None.
RedirectURI	string	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "AgreementID": "sample string 2",
  "ChargeID": "sample string 3",
  "RedirectURI": "sample string 4",
  "ErrorMessage": "sample string 5"
}

text/html

Sample:

{"Status":"sample string 1","AgreementID":"sample string 2","ChargeID":"sample string 3","RedirectURI":"sample string 4","ErrorMessage":"sample string 5"}

application/xml, text/xml

Sample:

<VippsAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CTHelpers">
  <AgreementID>sample string 2</AgreementID>
  <ChargeID>sample string 3</ChargeID>
  <ErrorMessage>sample string 5</ErrorMessage>
  <RedirectURI>sample string 4</RedirectURI>
  <Status>sample string 1</Status>
</VippsAgreement>