Arrow

API Reference

  • Authentication

    Parameter Description Required
    Authentication.userid (String) The userId for the entity.
    Required to authenticate a server-to-server request.    		 Required
    Authentication.password (String) The password for the userId.
    Required to authenticate a server-to-server request.    		 Required
    Authentication.entityid (String) The entity for the request. By default this is the channel's ID. Required

  • Basic Payment

    Parameter Description Required
    Payment.merchantInvoiceId (String) Indicates merchant invoice id. Required
    Payment.amount (float or int) Indicates the amount of the payment request. Required
    Payment.currency (String) The currency code of the payment request's amount (ISO 4217). Required
    Payment.files   Conditional
    Payment.sendEmail Boolean value , indicates whether send email to customer or not after creating payment. Conditional
    Payment.sendSms Boolean value indicates whether send sms to customer or not after creating payment. Conditional
    Payment.emailCc (String) List of comma separated email ids Conditional
    Payment.emailBcc (String) List of comma separated email ids Conditional
    Payment.paymentId (Int) Id of payment (Set this when one wants to cancel payment) Required
    Payment.expiryTime (numeric) time should be in seconds Conditional
    Payment.notes (String) Payment note of length 140 characters or less. Conditional

  • Basic Event

    Parameter Description Required
    Event.eventId (String) Encoded eventId, it is use to identify an event. Required
    Event.type (String) Event type i.e PAYMENT.COMPLETED or PAYMENT.CANCELLED. Required
    Event.testmode (Boolean Value) This to track the server type, it is TRUE if test server else it is FALSE. Required

  • Customer Information

    Parameter Description Required
    Customer.givenName (String) The first name or given name of the customer. Required
    Customer.surname (String) The last name or surname of the customer. Required
    Customer.email (String) The customer's email address. Required for communicating with customer's regarding payment. Required
    Customer.mobiled (String) The customer's mobile number. Required for communicating with customer's regarding payment. Format should be xxx xxxxxxxx. Conditional

  • Response Parameters

    Parameter Description Required
    status success: If payment url gets generated
    failure: If any error occurred    		 Required
    response (json data) Contains success response. Conditional (When status is success )
    response.PaymentId (Int) Id of payment. Conditional
    response.url (String) Payment url. Conditional
    Payment.eventTimestamp (String) Payment event timestamp in format YYYY-MM-DD HH:MM:SS. Conditional
    Payment.registrationId (String) Card registration ID received from PayOn Conditional
    request (json data) Entire request data except authentication details. Required
    errors (json data) Contains errors messages. Conditional (When status is success)
    errors.Payment.merchantInvoiceId (String) Error message regarding merchantInvoiceId. Conditional
    errors.Payment.amount (String) Error message regarding amount. Conditional
    errors.Payment.currency (String) Error message regarding currency. Conditional
    errors.Payment.emailCc (String) Error message regarding email_cc. Conditional
    errors.Payment.emailBcc (String) Error message regarding email_bcc. Conditional
    errors.Customer.givenName (String) Error message regarding givenName. Conditional
    errors.Customer.email (String) Error message regarding email. Conditional
    errors.Customer.mobile (String) Error message regarding mobile. Conditional
    errors.userid (String) Error message regarding userid. Conditional
    errors.password (String) Error message regarding password. Conditional
    errors.entityid (String) Error message regarding entityid. Conditional
    errors.commonError (String) Error when authentication values missing/failed by using userid, password and entityid. Conditional