Credit

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

POST https://<Platform-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 Platform secure field API
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	Platform system ID for the sale request	Required
TransactionID	string	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required
description	string	Transaction description	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",
        "description": "Payment for the services",
        "metadata": {
            "customerId": "123",
            "email" : "[email protected]"
        }
    }
}

Response

Example Response

{
    "data": {
        "ID": "8b321c53-961d-4b52-aced-3039bed0fbc1",
        "MerchantID": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "TransactionID": "668c5d3e-46d4-4a9d-9d17-bc1656ed0227",
        "Description": "Payment for the services",
        "ReturnResponse": {
            "status": "PASS",
            "responseCode": "A0000",
            "responseMessage": "Success",
            "authCode": "254424",
            "hostResponseCode": "00",
            "hostReferenceNumber": "751552357011",
            "taskID": "42072951",
            "transactionID": "57901671",
            "transactionTimestamp": "2025-04-02T19:04:26",
            "transactionAmount": "5.00",
            "processedAmount": "5.00",
            "totalAmount": "5.00",
            "addressVerificationCode": "X",
            "cardHolderVerificationCode": "N",
            "cardType": "visa",
            "maskedCardNumber": "1111",
            "customerReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 07:04 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 57901671      \\nDescription: Payment for the service\\n                 s                  \\n        SUBTOTAL: USD $5.00         \\n          TOTAL: USD $5.00          \\n                 \\n                 \\n       NO SIGNATURE REQUIRED        \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Customer Copy            \\n",
            "merchantReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 07:04 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 57901671      \\nDescription: Payment for the service\\n                 s                  \\n        SUBTOTAL: USD $5.00         \\n          TOTAL: USD $5.00          \\n                 \\n                 \\n      X_______________________      \\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN\\n ACCORDANCE WITH CARD ISSUER's AGREE\\nMENT (MERCHANT AGREEMENT IF CREDIT V\\n              OUCHER)               \\n     KEEP COPY FOR YOUR RECORDS     \\n               \\n \\n                \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Merchant Copy            \\n",
            "returnedAmount": "5.00"
        },
        "Metadata": {
            "customerId": "123",
            "email": "[email protected]"
        }
    }
}