Check status deposit | API PayStar.uk

INFO

This method is used to check the status of a deposit and is applicable if you created the payment using one of the following methods:

Acquiring by Card | H2H

Acquiring by Card | H2С

Acquiring by Token | H2H

When checking the status, provide the externalId that you received in the response to the deposit creation request.

If you receive an error or a non-final status, repeat the status check every 5 minutes until you receive a final status.

Additionally, please refer to the Callbacks section, which allows you to receive the payment status via callbacks.

We recommend using both approaches — callbacks and the status check method — to ensure a more reliable integration.

Payment Statuses

Init – The payment is awaiting card details input (e.g., Payment web page).

Created – The payment has been successfully created but processing has not yet started.

Processing – The payment is currently being processed.

Success – The payment has been successfully completed.

Failed – The payment was declined.

Check status deposit order

Polling - every 2 min before getting the final status.

CURL Example | GET Status deposit order

curl --request GET \
 --url https://secure.PayStar.uk/api/v1/integration/deposit-order/{externalId}/status\ 
 --header 'Authorization: Bearer YOUR TOKEN' \ 
 --header 'Content-Type: application/json' \

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200Success

application/json

Body

externalId

string

Order ID in our system

required

Example:

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

orderStatus

enum<string>

Сurrent order status

required

Allowed values:

CreatedProcessingSuccessFailed

externalParams

object | null

optional

cardToken

string

optional

Example:

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

cardStorageToken

string

optional

Example:

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

cardNumber

string

optional

Example:

123456****1234

cardHolder

string

optional

Example:

JOHN WEAK

Example

{
  "externalId": "PSP-bf95219b-393d-4323-91bf-639ac",
  "orderStatus": "Created",
  "externalParams": {
    "cardToken": "BankToken-bf95219b-393d-4323-91bf-639ac",
    "cardStorageToken": "PayStarToken-bf95219b-393d-4323-91bf-639ac",
    "cardNumber": "123456****1234",
    "cardHolder": "JOHN WEAK"
  }
}

🟠401Unauthorized

🟠403Forbidden

🟠404Order not found

Deposit status H2H

Check status deposit order

CURL Example | GET Status deposit order

Request

Request samples

Responses

Deposit status H2H

Check status deposit order#

CURL Example | GET Status deposit order#

Request

Request samples

Responses

Check status deposit order

CURL Example | GET Status deposit order