Send Requests

Use these guidelines when sending requests using the EFTLink REST API.

URL Structure

Here's the URL structure for the requests:

wss://<subdomain>.<domain>.com:<port>/<resource-path>
Where:
  • <subdomain.domain>.com:<port>: Host and port where EFTLink is running.

  • <resource-path>: Relative path that defines the resource.

Supported Methods

You can perform payment operations on a resource by using standard web socket HTTP method requests, as summarized in the following table.

Note:

You must ensure that EFTLink is running before you execute the payment request.
HTTP Method Description
POST Send payment requests to EFTLink REST API.

Media Types

The following media types are supported by the EFTLink REST API:

  • application/json

Supported Headers

The EFTLink REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Accept-Encoding List of acceptable encodings to support compression. Accept-Encoding: gzip
Content-Encoding List of acceptable encodings to support compression. Content-Encoding: deflate
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json

Compression

Use compression on the EFTLink REST resource request and response for improved performance. To use compression, include one of the following HTTP headers in the request: Accept-Encoding or Content-Encoding.