GET api/vipps/epayment/create?paymentReference={paymentReference}&amount={amount}&terminalId={terminalId}¤cyCode={currencyCode}&paymentUserFlow={paymentUserFlow}&customerPhoneNumber={customerPhoneNumber}&paymentDescription={paymentDescription}&accessToken={accessToken}&bioCode={bioCode}
Create a payment by based on a terminalId.
Upon calling this API, It will read the merchant information, terminal information from Integra and create payment.
Request Information
URI Parameters
| Name | Description | 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. |
Body Parameters
None.
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 | Description | 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"
]
}