Offline

Offline transaction API allows partners to record offline transactions such as Cash or Check deposits.

Records and offline payment

POST https://<PayEngine-host>/api/payment/offline

Request Body

Name	Type	Description
merchant_id*	string	Merchant ID of the offline transaction
data.transaction_amount*	Number	Offline transaction amount
data.type	string	Offline transaction type, e.g. Cash, Check, Credit, Debit, Gift, Other Defaults to other if not provided
currency_code	string	ISO Currency code, If not provided it defaults to US Dollar (USD)
internal_transaction_id	string	An internal ID from integrating system.
data.description	string	Transaction description
data.transaction_date	string	Transaction timestamp
data.additional_data	object	Optional data. Currently, it is specific to send additional terms or notes for this offline transaction
data.metadata	object	Add any additional metadata by passing a json object

200: OK

Offline Sale Response Field Definition

Field Name	Type	Description	Required?
id	string	PayEngine payment ID for the sale request	Required
transaction_id	string	Unique transaction ID	Required
merchant_id	string	Merchant ID	Required
description	string	Transaction description from the request	Optional
internal_transaction_id	string	Internal Transaction ID from the request	Optional
offline_sale_response.status	string	Transaction execution status. Allowed values PASS | FAIL	Required
offline_sale_response.transaction_timestamp	string	Transaction date from the request	Required
offline_sale_response.transaction_type	string	It will be Offline Sale Approved	Required
offline_sale_response.transaction_amount	string	Transaction amount from the request	Required
offline_sale_response.currency_code	string	ISO Currency code provided in the request. Default is USD if not provided in the request
offline_sale_response.payment_method	string	Payment method of the transaction. It will be "Offline - {type}. E.g. Offline - Cash if the transaction type is cash	Required
additional_data	string	Additional data from the request	Optional
metadata	string	Metadata from the request	Optional

Request Body

Sample Request

{
    "merchant_id": "e6705370-fccc-4bfb-9fb4-0e8a0a0cf426",
    "data": {
        "transaction_amount": "10.00", 
        "internal_transaction_id": "12345678",
        "type": "Cash",
        "description": "Payment for the Services",
        "transaction_date": "2024-11-20T20:10",
        "metadata": {
            "customer_id": "123",
            "email": "[email protected]"
        }
    }
}

Response Body

{
    "data": {
        "id": "43af7ef7-2fe1-4a51-8870-8f0a2110c4ca",
        "transaction_id": "88b1f997-7977-477a-a186-553403786ad7",
        "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "description": "Description",
        "offline_sale_response": {
            "status": "PASS",
            "transaction_amount": "50.00",
            "currency_code": "USD",
            "transaction_timestamp": "2025-04-08T19:03:47.371Z",
            "transaction_type": "Offline Sale Approved",
            "payment_method": "Offline - cash"
        },
        "internal_transaction_id": "12345678",
        "metadata": {
            "customer_id": "123",
            "email": "[email protected]"
        }
    }
}

Webhook event: OFFLINE_SALE

Webhook Payload Example

{
    "event_uid": "ec7ba4f7e5fcf814be799df852bc8678",
    "event": "OFFLINE_SALE",
    "data": {
      "metadata": {
        "customer_id": "123",
        "email": "[email protected]"
      },
      "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844",
      "payment_id": "e71dae47-0eb9-4013-92d9-3154bfa29cf2",
      "description": "Description",
      "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
      "transaction_id": "bca707ac-d149-4b07-8de3-a584712ab14e",
      "internal_transaction_id": "12345678",
      "offline_sale_response": {
        "status": "PASS",
        "currency_code": "USD",
        "payment_method": "Offline - cash",
        "transaction_type": "Offline Sale Approved",
        "transaction_amount": "50.00",
        "transaction_timestamp": "2025-03-18T19:03:47.371Z"
      }
    }
  }