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
transactionAmount*	Number	Offline transaction amount
type*	String	Offline transaction type Cash/Check etc.

200: OK

Offline Sale Response Field Definition

Field Name	Type	Description	Required?
ID	string	PayEngine system ID for the sale request	Required
TransactionID	string	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required

Request

Sample Request

{
    "merchant_id": "23f0ca72-902c-4169-a018-e13b43e6ec57",
    "data": {
        "transactionAmount": "50.50",
        "type": "CASH"
    }
}

Response

{
    "data": {
        "ID": "27342e95-8fd6-42c0-bd0d-2f8d654c4e2a",
        "TransactionID": "39596030-36a9-4121-b324-ba15b31b7c37",
        "MerchantID": "b0ad3bfe-c7a1-4def-9840-6c8f2570d2ce"
    }
}

Webhook event: OFFLINE_SALE

Webhook Payload Example

{
  event_uid: '36af1d0f07c60d2e272dee48d03ce885',
  event: 'OFFLINE_SALE',
  data: {
    account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
    payment_id: 'd9d003b5-4ac9-4521-968f-42bad2d4d251',
    merchant_id: 'c404d923-226f-4aae-92da-22c1ef370434',
    transaction_id: 'f497e258-fce3-4422-be30-8e223820be8f'
  }
}