Credit

This API can be used to issue credit to a card.

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

Request

Request Body

Name	Type	Description
data.transactionAmount*	string	Amount to be returned. Should be less or equal to available transaction amount
id*	string	Transaction ID
data.cardToken	string	Card token generated by PayEngine secure field API
data.store_payment_method	boolean	true | false – Indicates whether the card should be stored for future use. Set to true to store the card. Defaults to true
data.initiated_by	string	merchant | customer – Indicates who initiated the transaction. Defaults to customer
data.description	string	Transaction description. Character limit is 255
data.gateway_id	string	Gateway ID (optional, if multigateway mode enabled)

200

Field Definitions

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
description	string	Transaction description	Optional
store_payment_method	boolean	Defaults to true	Optional
initiated_by	string	Defaults to customer	Optional
ReturnResponse	Object	Refer to Credit Card Sale (SaleResponse)	Required

Sample Request / Response

Request

Example Request

{
    "id": "9a0df7ef-b77f-4525-97e1-f41a98ad7f75",
    "data": {
        "transactionAmount": "110.00",
        "cardToken": "card_sandbox_xxxx",
        "store_payment_method": true,
        "initiated_by": "customer", 
        "description": "Payment for the services",
        "metadata": {
            "customerId": "123",
            "email" : "[email protected]"
        }
    }
}

Response