PaymentExpress Client API

Authentication
- Fetch Auth Tokenpost
Online Checkout
Hosted In Person Checkout
- Create OTC Checkout Redirectpost
- Check OTC Cart Statusget
Embedded In Person Checkout
Voice Based Checkout
Post-Payment
Misc
- Service Checkget

PaymentExpress Client API

Authentication
- Fetch Auth Tokenpost
Online Checkout
Hosted In Person Checkout
- Create OTC Checkout Redirectpost
- Check OTC Cart Statusget
Embedded In Person Checkout
Voice Based Checkout
Post-Payment
Misc
- Service Checkget

Embedded In Person ECheck Payment for Cart

post https://{env}.gsg.tech/api/v1/pay/inperson/carts/{cartId}/payments/echeck

This endpoint allows for payment for a embedded in person cart using an electronic check tender.

Path Params

cartId

string

required

Body Params

accountNumber

string

required

Account Number for the e-Check tender.

routingNumber

string

required

Routing number for the e-Check account.

withdrawalType

string

required

Enum representing whether the transaction is a checking or savings transaction.

micr

object

Optional, extended MICR data from the e-Check

amounts

object

required

Total cost, fees, and primary amount of the payment to be made.

Responses

Response body

object

amounts

object

required

Object containing the primary, fee, and total amounts for the transaction.

fees

string

required

length ≥ 4

The fees amount is the cost of completing the transaction, paid by the customer, to PaymentExpress for convenience, etc.

total

string

required

length ≥ 4

The total amount of this transaction/item - summing the primary and fees values.

primary

string

required

length ≥ 4

The primary amount is the amount cost of the transaction/item that is payable to the client. This does not include transaction fees which are then paid depending on the type of tender.

timestamp

date-time

required

Date and time that the payment was posted.

paymentId

string

required

Unique identifer for the payment that was made to complete this transaction.

Response body

object

errorCode

string

required

A human-readable error code.

BadRequest AuthenticationRequired Forbidden NotFound Internal

errorMessage

string

required

Error text suitable for display to a developer integrating against this API service.

displayMessage

string

Error text suitable for display directly to a public end-user.

Response body

object

errorCode

string

required

A human-readable error code.

BadRequest AuthenticationRequired Forbidden NotFound Internal

errorMessage

string

required

Error text suitable for display to a developer integrating against this API service.

displayMessage

string

Error text suitable for display directly to a public end-user.

Response body

object

errorCode

string

required

A human-readable error code.

BadRequest AuthenticationRequired Forbidden NotFound Internal

errorMessage

string

required

Error text suitable for display to a developer integrating against this API service.

displayMessage

string

Error text suitable for display directly to a public end-user.

Response body

object

errorCode

string

required

A human-readable error code.

BadRequest AuthenticationRequired Forbidden NotFound Internal

errorMessage

string

required

Error text suitable for display to a developer integrating against this API service.

displayMessage

string

Error text suitable for display directly to a public end-user.

Updated about 2 months ago

Cancel Embedded In Person Cart Checkout

Voice Based Checkout

Did this page help you?

Language

Credentials

OAuth2

Authenticate

Bearer

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://www.gsg.tech/api/v1/pay/inperson/carts/cartId/payments/echeck \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "withdrawalType": "Checking",
8
  "micr": {
9
    "auxiliaryOnUs": true
10
  }
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 months ago

Cancel Embedded In Person Cart Checkout

Voice Based Checkout

Did this page help you?

PaymentExpress Client API
Authentication
Fetch Auth Tokenpost
Online Checkout
Discard Abandoned Cartdelete
Check Online Cart Statusget
Create Online Checkout Redirectpost
Hosted In Person Checkout
Check OTC Cart Statusget
Create OTC Checkout Redirectpost
Embedded In Person Checkout
Embedded In Person ECheck Payment for Cartpost
Cancel Embedded In Person Cart Checkoutdelete
PIN Pad Activationpost
Embedded In Person PINPad Activation Status Requestget
Embedded In Person Cart Status Lookupget
Embedded In Person Cart Creationpost
Voice Based Checkout
Voice-Based ECheck Payment for Cartpost
Voice-Based Card Payment for Cartpost
Voice-Based Cart Statusget
Voice-Based Cart Creationpost
Post-Payment
Reverse Payment Itempost
Reverse Paymentpost
Get Receipt Details for Paymentget
Look Up Paymentget
Misc
Service Checkget

PaymentExpress Client API
Authentication
Fetch Auth Tokenpost
Online Checkout
Discard Abandoned Cartdelete
Check Online Cart Statusget
Create Online Checkout Redirectpost
Hosted In Person Checkout
Check OTC Cart Statusget
Create OTC Checkout Redirectpost
Embedded In Person Checkout
Embedded In Person ECheck Payment for Cartpost
Cancel Embedded In Person Cart Checkoutdelete
PIN Pad Activationpost
Embedded In Person PINPad Activation Status Requestget
Embedded In Person Cart Status Lookupget
Embedded In Person Cart Creationpost
Voice Based Checkout
Voice-Based ECheck Payment for Cartpost
Voice-Based Card Payment for Cartpost
Voice-Based Cart Statusget
Voice-Based Cart Creationpost
Post-Payment
Reverse Payment Itempost
Reverse Paymentpost
Get Receipt Details for Paymentget
Look Up Paymentget
Misc
Service Checkget

200Details of a card payment request for the given cart.

400Error indicating that there was a formatting or data error of some kind in the request.

401Error indicating that no authorization information was provided for this request.

403Error response indicating that the provided credentials do not provide access to the requested resource.

404