Docs
DocumentationAPI ReferenceAsk AI Assistant
  • Home
    • Get Your Business Started
    • Services and Supported Features
  • Documentation
    • Developer Quickstart
      • Authentication
      • Card Sales and Consent
      • Querying and Filtering
      • Payment Reminders
    • Getting Started
      • Integration Checklist
      • Integration Options
        • REST API
        • Android SDK
        • iOS SDK
        • React Native Wrapper
        • PayForm
        • Verifone
        • Virtual Terminal
      • Basics
        • Authentication
        • API Best Practices
        • API Input Validation
        • Testing Considerations
      • Client Admin Portal
    • Testing
      • Testing Overview
      • Global Payments Testing
      • First Data Testing
      • ACH Testing
    • Resources
      • Tools and Downloads
      • Vocabulary
      • Querying
      • Error Codes
      • Software Requirements
  • API Reference
    • REST API
      • Authentication
      • ACH
      • Card Operations
        • Process a Card Sale
      • Consent Annual
        • Create Annual Consent
      • Consent Recurring
        • Create Recurring Consent
      • Consent Subscription
      • International
      • PayForm
      • Query
        • Account
        • ACH
        • Batch
        • Consent Annual
        • Consent Recurring
        • Consent General
        • Recurring Schedule
        • Receipt
        • Transaction
        • Voice
        • Query General
        • Reconcile
      • Receipt
      • Recurring Schedule
      • Settlement
      • Text to Pay
  • Help
    • Customer Support
      • FAQ
Powered by GitBook

Copyright © Number

On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. REST API

Text to Pay

PreviousSettlementNextCustomer Support

Last updated 4 months ago

Was this helpful?

Create a payment link via SMS or email

post

This call allows you to create a tinyURL of the widget payment link that will display a message and payment form to the customer. The message and form that is displayed to the customer is easily configured by using the API call options.

This API method allows users to accomplish three typical tasks:

1 Send a SMS text with a message and Payment Link 2 Send an email with message and Payment Link 3 Acquire the Payment Link and use it internally or externally

For more details on the use of Text to Pay as well as some sample code is available on our documentation site located at https://easypaysoftware.com/en/text-to-pay.

Header parameters
SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-TypestringRequiredExample: application/json
AcceptstringRequiredExample: application/json
Body
Responses
200
Successfully created payment link
application/json
post
POST /APIcardProcREST/v1.0.0/Other/SMSPay HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 754

{
  "Msg": {
    "Person": {
      "Firstname": "EasyPay",
      "Lastname": "Tester",
      "Company": "",
      "Title": "",
      "Url": "",
      "BillIngAdress": {
        "Address1": "123 Fake St.",
        "Address2": "",
        "City": "Portland",
        "State": "ME",
        "ZIP": "04106",
        "Country": "USA"
      },
      "Email": "testing@here.com",
      "Phone": "2076885025"
    },
    "MessageType": "TEXT",
    "RefID": "52520ABC",
    "RPGUID": "4c269391-a698-4e10-a1a8-0353ee80d1a6",
    "MessageBody": "",
    "AcctHolderID": 0,
    "Amount": 50,
    "ConsentID": 0,
    "DueOn": "1/12/2025",
    "EINDEX": "100",
    "MerchID": 1,
    "TXID": 0,
    "WType": "SW",
    "RedirectURL": "https://easypay7.com/PostingApp",
    "WidgetURL": "https://easypay5.com/stdwidget",
    "ExpiresOn": "2025-10-05",
    "SingleUse": 0,
    "OptParam": "VISIBLE|1EE7|READONLY|0000|STYLES|0000|OPTIONS|0601|COLORS|#ffffff,#428bca,#007bff,#212121,#ffffff,#212121,#ffffff",
    "Questions": []
  }
}
200

Successfully created payment link

{
  "SMSPaymentResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "PaymentUrl": null,
    "RespMsg": "Text Sent Successfully to 2078995025"
  }
}