Concept

Protocol

HTTPS is enabled in order to increase ensure the security of data transfer in data transmission

Requests

Request payload is expected to be in JSON format

Method

GET

Retrieves resources

POST

Creates resources

PATCH

Changes and/or replaces resources or collections

DELETE

Deletes resources

Data format

API accepts and returns JSON in the request or response body

Response Status Codes

Status Code
Description

200

OK - The request has succeeded

201

Created - The request has been fulfilled and resulted in a new resource being created

400

Bad Request - The request could not be understood by the server due to malformed syntax

401

Unauthorized - The request requires proper authentication

403

Forbidden - The server understood the request, but is refusing to fulfill it.

429

Too Many Requests - Rate limiting has been applied.

500

Internal Server Error. Contact us if you se the error

API Credentials

Developer will see the API credentials in the merchant portal for integration

Header Parameter
Value

X-API-ID

SHA1 string

X-API-KEY

SHA1 string

curl --request GET \
    'https://api.ally-pay.com/ping' \
     --header "X-API-ID: AAF4C61...EA9434D"
     --header "X-API-KEY: 7C21143...9ABBF43"

Trade Status

Status
Description

Queuing

Trade is queued up to process

Pending

Trade is assigned to trader, pending to be filled

Completed

Trade is completed

Canceled

Trade is canceled

Timeout

Trade cannot be fulfiled in the expected period

Rejected

Trade is rejected due to various reason

Last updated