Skip to content

Initiate a gateway payment

POST
/api/v1/business/website/payment/initiate/

Creates the order (status PENDING) plus a payment session, then returns the gateway redirect URL. Accepts every createOrder field plus payment_method (BKASH or NAGAD) and a callback_url the gateway returns the shopper to.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
or
apiKey|shopperToken
apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"payment_method": "string",
  
"callback_url": "string",
  
"receiver_name": "string",
  
"phone": "string",
  
"address": "string",
  
"delivery_fee": 0,
  
"currency": "string",
  
"items": [
  
  
{
  
  
  
"product_id": 0,
  
  
  
"unit_price": 0,
  
  
  
"quantity": 0,
  
  
  
"variant_id": 0
  
  
}
  
],
  
"coupon_code": "string",
  
"email": "string"
}

Responses

Payment session created — redirect the shopper.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"redirect_url": "string",
  
  
"order_id": 0,
  
  
"payment_session_id": "string"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale