Card Payment API

POST

/card/payments

The customer pays the transaction through a card. Users can save card information by passing ‘Y’ in the payload as isSavecard. The token will be generated in the response. Otherwise, it will be null.

Headers

Parameter	Description
gpsToken	Token obtained in response to merchant authentication API for the card.
Content-Type	Content type. Available values: application/json Default value: application/json

Request

{
    "merchantId": "{{cardSubMerchantId}}",
    "channel": "GPS",
    "clientRequestId": "{{cardClientRequestId}}",
    "email": "sriramk@utilli.com",
    "phoneNumber": "+1234567890",
    "requestType": "card",
    "cardNumber": "378282246310005",
    "expiryYear": "26",
    "expiryMonth": "02",
    "cvv": "977",
    "amount": "1.99",
    "currency": "USD",
    "isSavecard": "Y",
    "customerNumber": "000210130323",
    "postalCode": "123456"
}

Parameters

Name	Description
Merchant ID	String Identifier of the card provided by Monay GPS.
Channel	String Example: GPS Payment channel used.
Client Request ID	String The unique identifier of the transaction generated by the API consumer.
Email	String Example: abc.1234@monay.com Customer's email address. (Optional)
Phone Number	String Example: 9897767787 Customer's phone number. The maximum length is 10 excluding country code. (Optional)
Request Type	String The payment request type for making the payment. Possible values: "card" is passed when making the call using card details "token" is passed when making the call using the saved card
Card Number	String Example: 8728748927876609765 Customer's card number. Optional parameter if request type is token.
Expiry Year	Number Example: 2022 will be written as 22 Last two digits of the customer's card expiry year. Optional parameter if request type is token.
Expiry Month	Number Example: February will be written as 02 Expiry month of the customer’s card. Optional parameter if request type is token.
CVV	Number Example: 118 Three-digit Card Verification Value on the back of the card.
Amount	Number Example: 10.99 Amount of the transaction.
Currency	Number Example: USD The currency of the payment.
isSavecard	Boolean Example: Y If the customer wants to save card details for future use. Possible values are : "Y" to save card details "N" to proceed without saving card details
Customer Number	String Example:000210130323 Length:12 Unique identifier of customer assigned by the sub-merchant.
PostalCode	Number Example:123456 Postal code of the customer.

Response

{
    "timeStamp": "1668515934668",
    "clientRequestId": "7bd41c68-c261-43cd-b8f2-9ef176057a04",
    "statusDesc": "Success",
    "statusCode": "200",
    "transactionId": "87735774241",
    "orderId": "R-c5cce035-94e5-434f-ab46-07be8c0b3665",
    "token": “76e53238-595c-4d21-9cf4-6cf99356a6329dc0f653-5668-42e8-b71f-cb2446259845”
}

Response Codes

Code	Description
200	Success Response
400	GPS token missing request - GPS token missing in the request Invalid token Negative amount - The amount should be greater than zero Expiry Year & Month - Card Expired Zero amount - The amount should be greater than zero Amount missing - The amount should not be blank CVV Missing - CVV should not be blank Currency missing - Currency should not be blank Expiry Month Missing - Expiry year or month should not be blank Expiry Year missing - Expiry year or month should not be blank Card number missing - Card number should not be blank Request Type missing - Invalid payment type Client request missing - Client Request Id should not be null Channel missing - Channel should not be null MerchantID missing request - Merchant ID should not be blank
502	Wrong Card number

Card Payment Reversal API

POST

/card/payments/reversal/

Card Payment Reversal API will be called when a customer requests a return or void of a card transaction from the Monay GPS portal. If the reversal is within 15 minutes of the transaction, it will be void otherwise it will be a return payment.A customer can request a return within one year of the payment.

Note: Card payment reversal is embedded in the Monay GPS portal. When a user requests a reversal Card Payment Reversal API will be called.

Headers

Parameter	Description
gpsToken	Token obtained in response to merchant authentication API for the card.
Content-Type	Content type. Available values: application/json Default value: application/json

Request

 {
    "merchantId": "{{cardSubMerchantId}}",
    "channel": "GPS",
    "clientRequestId": "7bd41c68-c261-43cd-b8f2-9ef176057a04",
    "requestType": "void"
}

Parameters

NAME	DESCRIPTION
Merchant ID	String Identifier of the card provided by Monay GPS.
Channel	String Example: GPS Payment channel used.
Client Request ID	String The unique identifier of the transaction generated by the API consumer.
Request Type	String The payment request status.Possible values "void" is passed when making the void request "refund" is passed when making the refund request
PostalCode	Number Example:123456 Postal code of the customer.

Response

{
    "timeStamp": "1668516442295",
    "clientRequestId": "7bd41c68-c261-43cd-b8f2-9ef176057a04",
    "statusDesc": "Success",
    "statusCode": "200",
    "transactionId": "75550063608",
    "orderId": "R-1e44865e-48f7-40de-a880-86a242fcdf49",
    "token": null
}<br>

Response Codes

Code	Description
200	Success Response
401	Request Type missing - Invalid request type GPS token missing in the request Invalid token Client Request Id should not be null Merchant Id should not be blank Invalid Merchant Id