Send a payment request

Send an order details message with a Review and pay button. Amounts are paise. See the payments guide.

Required scope: messages:send

POST /v1/payments

Send a payment request

cURL

curl --request POST \
  --url https://lazyapp.in/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "[phone]",
  "body": "<string>",
  "items": [
    {
      "name": "<string>",
      "amount": 2,
      "quantity": 5000,
      "sale_amount": 2,
      "retailer_id": "<string>",
      "image_url": "<string>",
      "country_of_origin": "<string>",
      "importer_name": "<string>",
      "importer_address": {}
    }
  ],
  "payment": {
    "configuration": "<string>",
    "gateway_account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "upi_intent_link": "<string>",
    "payment_link": "<string>",
    "success_url": "<string>",
    "cancel_url": "<string>",
    "enabled_payment_options": [],
    "gateway_fields": {}
  },
  "phone_number_id": "<string>",
  "reference_id": "<string>",
  "footer": "<string>",
  "header_image_url": "<string>",
  "catalog_id": "<string>",
  "expires_in_minutes": 21602,
  "expiry_description": "<string>",
  "importer": {
    "name": "<string>",
    "country_of_origin": "<string>",
    "address": {
      "address_line1": "<string>",
      "address_line2": "<string>",
      "city": "<string>",
      "zone_code": "<string>",
      "postal_code": "<string>",
      "country_code": "<string>"
    }
  },
  "beneficiary": {
    "name": "<string>",
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>"
  },
  "tax": {
    "amount": 123,
    "description": "<string>"
  },
  "shipping": {
    "amount": 123,
    "description": "<string>"
  },
  "discount": {
    "amount": 123,
    "description": "<string>",
    "program_name": "<string>"
  },
  "template": {
    "name": "<string>",
    "language": "<string>",
    "button_index": 123,
    "components": [
      {}
    ]
  },
  "metadata": {}
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "to": "<string>",
  "status": "pending",
  "status_label": "<string>",
  "payment_status": "pending",
  "payment_status_label": "<string>",
  "payment_method": "payment_gateway",
  "gateway": "<string>",
  "payment_configuration": "<string>",
  "payment_link": "<string>",
  "currency": "INR",
  "total_amount": 123,
  "amount_paid": 123,
  "amount_refunded": 123,
  "paid_with": "<string>",
  "goods_type": "<string>",
  "order": {},
  "transactions": [
    {}
  ],
  "refunds": [
    {}
  ],
  "last_error": "<string>",
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_number_id": "<string>",
  "metadata": {},
  "expires_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key · string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json

to · string · required

Example:

"[phone]"

body · string · required

Maximum string length: 1024

items · object[] · required

Required array length: 1 - 999 elements

Show child attributes

payment · object · required

Show child attributes

phone_number_id · string

reference_id · string

Maximum string length: 35

Pattern: ^[A-Za-z0-9_.\-]+$

footer · string

Maximum string length: 60

header_image_url · string<uri>

goods_type · enum<string>

Available options: digital-goods, physical-goods

catalog_id · string

expires_in_minutes · integer

Required range: 5 <= x <= 43200

expiry_description · string

Maximum string length: 120

importer · object

Required by WhatsApp for physical goods that are not from a catalog.

Show child attributes

beneficiary · object

Show child attributes

tax · object

Show child attributes

shipping · object

Show child attributes

discount · object

Show child attributes

template · object

Send as a template, to reach contacts outside the 24-hour window.

Show child attributes

metadata · object

Response

201

application/json

The payment.

id · string<uuid>

reference_id · string

to · string

status · enum<string>

Available options: pending, processing, partially_shipped, shipped, completed, canceled

status_label · string

payment_status · enum<string>

Available options: pending, captured, failed, partially_refunded, refunded

payment_status_label · string

payment_method · enum<string>

Available options: payment_gateway, upi_intent_link, payment_link

gateway · string | null

payment_configuration · string | null

payment_link · string | null

currency · string

Example:

"INR"

total_amount · integer

Paise.

amount_paid · integer

Paise.

amount_refunded · integer

Paise.

paid_with · string | null

How the contact paid, e.g. upi.

goods_type · string

order · object

The items and totals as sent to WhatsApp.

transactions · object[]

refunds · object[]

last_error · string | null

message_id · string<uuid> | null

phone_number_id · string | null

metadata · object | null

expires_at · string<date-time> | null

paid_at · string<date-time> | null

created_at · string<date-time>

updated_at · string<date-time>