Creatre deposit | API PayStar.uk

NOTE

This method can be used to create Acquiring and P2P payments, depending on the endpoint settings. As a result, there are several possible response types at the moment of payment creation:

for Acquiring, the response will contain a link for 3DS authentication;

for P2P, it will contain the payment details and a web form populated with these details. Please refer to the response examples for more information.

PCI DSS REQUIRED

If you have a valid PCI DSS certificate, you can use this method. In this case, you must collect the user's card details when creating the payment and include them in this request.

Please note that before you can start using this method, you need to provide your Account manager with your AOC (Attestation of Compliance).

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

To make deposit payment please use follow sections:

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

Get status: GET secure.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://secure.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": "cardNumber" 
      "value": "1234123412341234"
    },
   {
     "key": "cardHolder",
     "value": "JOHN WEAK"
   },
   {
     "key": "cardCvv",
     "value": "583"
   },
   {
     "key": "cardExpireMonth",
     "value": "05"
   },
   {
     "key": "cardExpireYear",
     "value": "26"
   },
   {
     "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

amount

number

Payment amount

required

Example:

100

currency

string

Payment currency in ISO 4217 standard

required

Full list of currencies in Dictionaries / Currencies

Examples:

EURUSDRUB

successRedirectUrl

string

URL to redirect the user after successful payment

required

Example:

http://merch.com/success

processingRedirectUrl

string

URL to redirect the user if payment in processing

required

Example:

http://merch.com/processing

failedRedirectUrl

string

URL to redirect the user after failed payment

required

Example:

http://merch.com/failed

callbackUrl

string

URL for Callbacks

optional

Example:

http://merch.com/callBackUrl

externalTransactionId

string

Payment ID in your system

required

Example:

Merch-bf95219b-393d-4323-91bf-639be

additionalFields

array [object {2}]

Additional fields - required for some cases

optional

keyb

enum<string>

Key name

optional

Allowed values:

typeproductCodephoneNumbertelecomOperatoremailpayeerIdentifieripcardNumbercardHoldercardCvvcardExpireMonthcardExpireYearbankNamebrowserAcceptHeaderbrowserJavaEnabledbrowserJavascriptEnabledbrowserLanguagebrowserColorDepthbrowserScreenWidthbrowserScreenHeightbrowserTZbrowserUserAgentbrowserChallengeWindowSize

value

string

Value name

optional

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": "type",
      "value": "card"
    },
    {
      "key": "cardNumber",
      "value": "1234123412341234"
    },
    {
      "key": "cardHolder",
      "value": "JOHN WEAK"
    },
    {
      "key": "cardCvv",
      "value": "583"
    },
    {
      "key": "cardExpireMonth",
      "value": "05"
    },
    {
      "key": "cardExpireYear",
      "value": "26"
    },
    {
      "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 - P2P

application/json

Body

externalId

string

Payment ID in PayStar.uk

required

Example:

PSP-bf95219b-393d-4323-91bf-639ac

orderStatus

enum<string>

Сurrent payment status

required

Allowed values:

InitCreatedProcessingSuccessFailed

paymentDetails

object | null

optional

card

string | null

Card number

optional

Example:

123456789012

number

string | null

Phone number

optional

Example:

440102345

fio

string | null

Full name

optional

Example:

John Wick

amount

string | null

Payment amount

optional

Example:

100

bank

string | null

Bank name

optional

Example:

ALL

formUrl

string | null

Payment form URL

optional

Example:

payment.com/form

Example

{
  "externalId": "9047bf77-2089-45ab-9367-0ace3069f867",
  "orderStatus": "Processing",
  "paymentDetails": {
    "card": "123456789012",
    "fio": "Alex M",
    "bank": "SuperBank",
    "formUrl": "https://payform.PayStar.uk?t=e5ff9399-2f3a-412c-858b-c9e8f84k43b2e1"
  }
}

🟢200Success - Card

🟠400Validation error

🟠400Payment already exist

🟠400Limit was reached

🟠401Unauthorized

🟠403Forbidden - Endpoint

🟠403Forbidden - IP address

🟠423Temporary error

🔴500Internal Server Error

Deposit H2H - Card & P2P

To make deposit payment please use follow sections:#

Create H2H Deposit with the banking card - Sequence diagram#

CURL Example | POST Deposit order#

Request

Request samples

Responses

To make deposit payment please use follow sections:

Create H2H Deposit with the banking card - Sequence diagram

CURL Example | POST Deposit order