Create deposit host to client

PCI DSS NOT REQUIRED

If you do not have a PCI DSS certificate, you can use this method. In this case, you must not collect the user's card details when creating the payment — the user will be presented with a Payment web page to enter their card information at the next step.

If you have a PCI DSS certificate, please refer to the following method: secure.PayStar.uk/api/v1/integration/deposit-order

To make deposit payment please use follow sections:

Create payment (current method): POST payform.PayStar.uk/api/v1/integration/deposit-order/

Get status: GET init.PayStar.uk/api/v1/integration/deposit-order/{externalId}/status

Get status by Callback

Create H2H Deposit with the banking card - Sequence diagram

CURL Example | POST Deposit order

curl --request POST \
 --url https://init.PayStar.uk/api/v1/integration/deposit-order\
 --header 'Authorization: Bearer YOUR TOKEN' \
 --header 'Content-Type: application/json' \
 --header 'accept: text/plain' \
 --data '{
  "amount": 100,
  "currency": "USD",
  "externalTransactionId": "MerchantPaymentId-12345",
  "successRedirectUrl": "http://merch.com/success",
  "failedRedirectUrl": "http://merch.com/failed",
  "processingRedirectUrl": "http://merch.com/processing",
  "additionalFields": [
   {
     "key": "payeerIdentifier",
     "value": "Merch-12345"
   },
   {
     "key": "email",
     "value": "Jhon.Wick@Continental-Hotel.com"
   }
 ]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "amount": 100,
    "currency": "USD",
    "externalTransactionId": "MerchID-{{$number.int(min=1)}}",
    "callbackUrl": "https://merch.com/callbackUrl",
    "processingRedirectUrl": "https://merch.com/processing",
    "failedRedirectUrl": "https://merch.com/failed",
    "successRedirectUrl": "https://merch.com/success",
    "additionalFields": [
        {
            "key": "payeerIdentifier",
            "value": "Merch-12345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "externalId": "e1537516-d160-48fa-b542-708d76d4c3ca",
    "orderStatus": "Init",
    "formUrl": "https://payform.PayStar.uk?token=b226f7c4-7c95-4748-8da5-05f369f75cea"
}

🟠400Validation error

🟠400Payment already exist

🟠400Limit was reached

🟠401Unauthorized

🟠403Forbidden - Endpoint

🟠403Forbidden - IP address

🟠423Temporary error

🔴500Internal Server Error

Deposit H2C - Card

To make deposit payment please use follow sections:#

Create H2H Deposit with the banking card - Sequence diagram#