Integration Flow

Zwitch supports UPI collection via API. Integrating your application with ZWITCH UPI Collect lets your customers create a UPI collect request.

UPI Collect Flow

Use the below endpoints to create a UPI collect request.

https://api.zwitch.io/v1/accounts/{account_id}/payments/upi/collect

Below is a sample request and response for a UPI collect request.

{
  "remitter_vpa_handle": "Sunil-reddy@example",
  "amount": 1,
  "expiry_in_minutes": 3,
  "remark": "Lego Death Star",
  "merchant_reference_id": "1658735415",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  }
}

{
  "id": "tx_ZqO63TLdwmH5VG8esTYqbf6b8",
  "object": "payment",
  "type": "collect",
  "account_id": "va_4ZEQNZdHCqT6c6M5gJ7RxIIWx",
  "amount": 1,
  "currency": "inr",
  "transacted_at": null,
  "bank_reference_number": "220601424642",
  "status": "pending",
  "remitter_bank_account_number": null,
  "remitter_bank_ifsc_code": null,
  "remitter_full_name": null,
  "remitter_note": null,
  "remitter_vpa_handle": "sunil-reddy@example",
  "paid_mode": "upi",
  "paid_to": "zwitch1234@example",
  "transaction_reference_id": null,
  "remark": "Lego Death Star",
  "merchant_reference_id": "1658735415",
  "expiry_in_minutes": 3,
  "mandate_id": null,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "is_sandbox": false,
  "link": null,
  "is_settled": false,
  "created_at": 1658735415,
  "settled_at": null
}