API Reference

Save Session

post
https://stagepayments-api.winkapis.com/v1/payment/session

A session api can creates the session to begin with the order or checkout.

Body Params
string

A customer token provided by the magento, Used to call the magento ecommerce API.

string

A integration token provided by the magento, Used to call the magento ecommerce API.

string

Order Id or any unique order reference Id from the merchant. That can be mapped with the wink transaction.

int32
required

ISO format amount

string
required

ISO alpha currency codes

int32
enum
required

1 = Redirect, 2 = IframeOverlay, 3 = IframeEmbedded

Allowed:
string

Redirect to the given url after the order has been completed.

string

Redirect to the given url after the order has been cancelled.

string
required

The given description will be send to the payment gateway. i.e Spreedly

string
required
externalFields
object

Pass the additional data to the session i.e. Email, Name, etc..

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
Updated about 1 year ago