Pine LabsDOCS

Create Debit

POST/ps/api/v1/public/subscriptions/execute

Executes a debit (payment collection) against a subscription. Use this when the PDN (Pre-Debit Notification) is controlled by you.

Requires Bearer token. Get token →

Request Body

NameTypeDescription
presentation_id
string

Presentation ID from Pine Labs.

merchant_presentation_reference
string

Merchant presentation reference.

is_merchant_retry
string

Set to true to control retry process yourself.

Response

NameTypeDescription
subscription_id
string

Unique identifier for the subscription.

presentation_id
string

Unique identifier for the presentation.

due_date
string

The ISO 8601 UTC Timestamp when the payment is due.

amount
object

This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS

value
integerrequired

Amount in the smallest currency unit (paisa for INR). Minimum ₹1 (100), maximum ₹10 lakh (100000000).

currency
stringrequired

Three-letter ISO 4217 currency code.

merchant_presentation_reference
string

Unique identifier of the merchant presentation reference.

status
string

Debit status.

  • CREATED: Presentation request successfully received.
  • PENDING: Pre-debit notification initiated.
  • PAUSED: Subscription is paused.
  • CANCELLED: Subscription is cancelled.
  • FAILED: Pre-debit notification or customer debit fails (up to 3 retries).
  • COMPLETED: Debit is successful.
Allowed values:
CREATEDPENDINGPAUSEDCANCELLEDFAILEDCOMPLETED

Status Codes

200Debit created successfully.
400The request was malformed or missing required fields.
Request
curl --request POST \
  --url https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions/execute \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "presentation_id": "v1-pre-4405071524-aa-qlAtAf",
  "merchant_presentation_reference": "1234567890",
  "is_merchant_retry": "false"
}'

Run this request

200 OK
{
  "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
  "presentation_id": "v1-pre-4405071524-aa-qlAtAf",
  "due_date": "2024-03-15T10:30:00Z",
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "merchant_presentation_reference": "1234567890",
  "status": "CREATED'"
}