POST api/vipps/epayment/create

Create a new payment based on the terminalId using POST method.
Upon calling this API, It will read the merchant information, terminal information from Integra and create payment.

Request Information

URI Parameters

None.

Body Parameters

Create payment query parameters

CreateEPaymentViewModel

Name	Type	Additional information
paymentReference	string	None.
amount	string	None.
terminalId	string	None.
currencyCode	string	None.
paymentUserFlow	string	None.
customerPhoneNumber	string	None.
paymentDescription	string	None.
accessToken	string	None.
bioCode	string	None.

Request Formats

application/xml, text/xml

Sample:

<CreateEPaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels.ViewModels">
  <accessToken xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels">sample string 8</accessToken>
  <bioCode xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels">sample string 9</bioCode>
  <amount>sample string 2</amount>
  <currencyCode>sample string 4</currencyCode>
  <customerPhoneNumber>sample string 6</customerPhoneNumber>
  <paymentDescription>sample string 7</paymentDescription>
  <paymentReference>sample string 1</paymentReference>
  <paymentUserFlow>sample string 5</paymentUserFlow>
  <terminalId>sample string 3</terminalId>
</CreateEPaymentViewModel>

application/json, text/json

Sample:

{
  "paymentReference": "sample string 1",
  "amount": "sample string 2",
  "terminalId": "sample string 3",
  "currencyCode": "sample string 4",
  "paymentUserFlow": "sample string 5",
  "customerPhoneNumber": "sample string 6",
  "paymentDescription": "sample string 7",
  "accessToken": "sample string 8",
  "bioCode": "sample string 9"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

paymentId and qrCodeUrl(Based on paymentUserFlow). if success is true, otherwise errors. You can use the paymentId to query payment status and capture the payment when its status is Authorized

EPaymentCreateViewModel

Name	Type	Additional information
paymentId	string	None.
qrCodeUrl	string	None.
success	boolean	None.
errors	Collection of string	None.

Response Formats

application/xml, text/xml

Sample:

<EPaymentCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_1SA_MobilePay_POS_ViewModels.ViewModels">
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <success>true</success>
  <paymentId>sample string 1</paymentId>
  <qrCodeUrl>sample string 2</qrCodeUrl>
</EPaymentCreateViewModel>

application/json, text/json

Sample:

{
  "paymentId": "sample string 1",
  "qrCodeUrl": "sample string 2",
  "success": true,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}