POST Vipps/CreateCharge

Request Information

URI Parameters

None.

Body Parameters

VippsChargeRequest
NameDescriptionTypeAdditional information
IdempotencyKey

string

None.

AgreementID

string

None.

amount

string

None.

transactionType

string

None.

type

string

None.

description

string

None.

due

string

None.

retryDays

integer

None.

orderId

string

None.

externalId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "IdempotencyKey": "sample string 1",
  "AgreementID": "sample string 2",
  "amount": "sample string 3",
  "transactionType": "sample string 4",
  "type": "sample string 5",
  "description": "sample string 6",
  "due": "sample string 7",
  "retryDays": 8,
  "orderId": "sample string 9",
  "externalId": "sample string 10"
}

text/html

Sample:
{"IdempotencyKey":"sample string 1","AgreementID":"sample string 2","amount":"sample string 3","transactionType":"sample string 4","type":"sample string 5","description":"sample string 6","due":"sample string 7","retryDays":8,"orderId":"sample string 9","externalId":"sample string 10"}

application/xml, text/xml

Sample:
<VippsChargeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CTHelpers">
  <AgreementID>sample string 2</AgreementID>
  <IdempotencyKey>sample string 1</IdempotencyKey>
  <amount>sample string 3</amount>
  <description>sample string 6</description>
  <due>sample string 7</due>
  <externalId>sample string 10</externalId>
  <orderId>sample string 9</orderId>
  <retryDays>8</retryDays>
  <transactionType>sample string 4</transactionType>
  <type>sample string 5</type>
</VippsChargeRequest>

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 'VippsChargeRequest'.

Response Information

Resource Description

VippsCharge
NameDescriptionTypeAdditional information
Status

string

None.

ChargeID

string

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "ChargeID": "sample string 2",
  "ErrorMessage": "sample string 3"
}

text/html

Sample:
{"Status":"sample string 1","ChargeID":"sample string 2","ErrorMessage":"sample string 3"}

application/xml, text/xml

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