API Reference Integrations Knowledge Base

Payments

You can accept payments from your customers by integrating your website with Globepay Payment API or using Globepay products such as Send Money.

If you want to directly integrate with our APIs, reach out to our Support team with your requirements.

This section contains the details of the Payment APIs that are used to capture payments, fetch details of payments made by customers, validate payments made by customers.

Payment Entity#

For ease of understanding, the response for each request is shown on the right panel. The responses can be formatted in JSON.

The various parameters are explained below:

key
stringYour unique registered business email address with Globepay
sender_email
stringSender's valid email address
recv_email
stringReference number is unique id with reference to each successful transaction.
currency
stringReference Identifier is another unique id with respect to each successful transaction starts with SR / RF.
business_id
bool The status of the payment. Possible values:
-true Represents a Successful Transaction
-false Represents a unsucessful transaction or invalid request.
merchant_payment_id
stringAmount value which is associated to any transaction .
price
stringRepresents transaction date Supports YYYY-mm-dd H:i:s Format
-YYYY1995
-mm01-12
-dd01-31
-H0-23
currency
stringCurrency, which is used for transaction. we Support INR Indian Currency
-USD Dollar
-EUR Euro
-AED United State of Arab Emirates
-GBP Pound
order_id
string Order ID, if provided. Read Orders API to learn more.

Fetch payment based on Order id#

Once the payment is authorized by the customer's bank, you must verify if the authorized amount deducted from the customer's account is the same as the amount paid by the customer on your website or app.

You can configure automatic capture of payments on the Razorpay Dashboard.

To change the status of the payment from authorized to captured, send the following request:

/payments/:id/capture

Path Parameter#

id mandatory
string Unique identifier of the payment to be captured.

Request Parameters#

amount mandatory
string The amount to be captured (should be equal to the authorized amount, in the smallest unit of the chosen currency).
currency mandatory
string ISO code of the currency in which the payment was made. Refer to the list of supported currencies.

After the capture, the funds are transferred to your account in T+2 days in case of domestic transaction. For international transactions, the time taken is T+7 business days. The amount sent in the capture request must come from a verified source and be the amount that you are expecting to receive.

Recommendation:
While creating a capture request, in the amount field enter only the amount associated with the Order that is stored in your database.

Note:
Attempting to capture a payment whose status is not authorized will produce an error.

Fetch Payment based on Reference Number #

The following endpoint is used for retrieving a specific payment object using its Reference Number ref_number .

https://www.globepayinc.com/ValidatePayment.php

Input Parameter#

business_emailmandatory
bool Your unique registered business email address with Globepay.
payer_emailmandatory
string Sender's valid email address.
ref_numbermandatory
string Reference number is unique id with reference to each successful transaction.
ref_identifier not required
string Reference Identifier is another unique id with respect to each successful transaction starts with SR / RF.

Path Parameter#

status
boolReturn true if transaction found falseIf transaction not found / not associated with given parameter / required paramerter not supplied
amount
stringReturn associated transaction amount.
payer_email
string Sender's valid email address.
ref_number
string Reference number is unique id with reference to each successful transaction.
ref_identifier
string Reference Identifier is another unique id with respect to each successful transaction starts with SR / RF.
currency
stringReturn type of currency INR/USD/GBP/EUR/AED.
message
stringSet in case of transaction not successful / Reference number does not match.

Fetch Multiple Payments#

The following endpoint is used for retrieving all the payments.

/payments

Query Parameters#

from
integer Timestamp, in seconds, from when payments are to be fetched.
to
integer Timestamp, in seconds, till when payments are to be fetched.
count
integer Number of payments to be fetched.
Default value is 10. Maximum value is 100. This can be used for pagination, in combination with the skip parameter.
skip
integer Number of records to be skipped while fetching the payments.
expand[]
array Used to retrieve additional information about the payment, specifically the method used to make the payment. Using this parameter will cause a sub-entity to be added to the response.

Supported values are:
-card - Expanded card details, usable for card and EMI payments.
-emi - Expanded EMI plan details, usable for EMI payments.

Note:
By default, only last 10 are returned. You can use the count and skip parameters to retrieve the specific number of records that you need.

Example#

The usage of the expand[] parameter in retrieving the card or the EMI plan details of the payments is shown in the example, displayed on the right.

Request #1 is for retrieving the expanded card details of the payments, in which the payment method is card or emi. Request #2 is for retrieving the expanded EMI plan details of the payments, in which the payment method is emi.

Fetch Payments based on Orders#

The following endpoint retrieves payments corresponding to an Order:

/orders/:id/payments

Path Parameter#

id mandatory
string Unique identifier of the order you want to fetch payment details for.

Fetch the Card Details for a Payment#

You can retrieve the details of the card that has been used to make a payment using the following endpoint.

/payments/:id/card

Path Parameter#

id mandatory
string Unique identifier of the payment you want to retrieve card details for.

Response Entities#

id
string Unique identifier of the card used for the payment.
entity
string The value for this attribute will always be card.
name
string Name of the card holder.
last4
string The last 4 digits of the card number.
network
string The card network. Possible values:
  • American Express
  • Diners Club
  • Maestro
  • MasterCard
  • RuPay
  • Unknown
  • Visa
type
string The card type. Possible values:
  • credit
  • debit
  • prepaid
  • unknown
issuer
string The card issuer. 4-character code denoting the issuing bank

This attribute will not be set for the card that has been issued by a foreign bank.
international
boolean This attribute will be set to true if the card has been issued by a foreign bank.
emi
boolean This attribute is set to true if the card can be used for EMI payment method.

Update the Payment#

You can modify an existing payment to update the Notes field only. Notes can be used to record additional information about the payment. You can add up to 15 key-value pairs with each value of the key not exceeding 256 characters.

Using the PATCH operation, you can replace the entire notes object for the entity.

Request Parameters#

To modify the Notes field in a particular payment, construct the API request as follows:

/payments/:id/
id mandatory
string Unique identifier of the payment for which the Notes field must be updated.
notes mandatory
json object Contains user-defined fields, stored for reference purposes. Refer to the Notes section of API documentation.
‹›
×