PayStar API Documentation
  1. Merchant EN
  • Merchant EN
    • Introduction
    • Glossary
    • Authorization key
    • Sandbox
    • Additional fields
    • Currencies
    • Bank names
    • Telecom operators
    • Callbacks
    • Error descriptions
    • Tech FAQ
    • Order History
    • Integratins
      • Stripe
      • Inwizo
      • 2Checkout
      • Adyen
      • AffiniPay
      • Alikassa
      • AlliancePay
      • Amazon Pay
      • AnyMoney
      • AstroPay
      • Aureavia
      • AurisMyChanger
      • Authorize.Net
      • Avatarix
    • Balance H2H
      GET
    • Deposit H2H - Card & P2P
      POST
    • Deposit H2H - Token
      POST
    • Deposit H2C - Card
      POST
    • Deposit status H2H - PayStar ID
      GET
    • Deposit status H2H - Merch ID
      GET
    • Payout H2H
      POST
    • Payout status H2H - PayStar ID
      GET
    • Payout status H2H - Merch ID
      GET
  1. Merchant EN

Deposit status H2H - PayStar ID

GET
https://secure.PayStar.uk/api/v1/integration/deposit-order/{externalId}/status
Last modified:2025-05-12 09:05:28
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' \
 

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://secure.PayStar.uk/api/v1/integration/deposit-order//status'

Responses

🟢200Success
application/json
Body

Example
{
    "externalId": "ad66a2ff-97d1-47c5-8552-53752a51f031",
    "orderStatus": "Failed",
    "amount": 2600.00,
    "externalParams": {
        "cardToken": null,
        "cardStorageToken": null,
        "cardHolder": null,
        "cardNumber": null
    },
    "orderHistory": [
        {
            "time": "2025-07-28T09:29:51.339832",
            "action": "1.1.0.0"
        },
        {
            "time": "2025-07-28T09:29:51.339832",
            "action": "4.1.0.0"
        }
    ]
}
🟠401Unauthorized
🟠403Forbidden
🟠404Order not found
Modified at 2025-05-12 09:05:28
Previous
Deposit H2C - Card
Next
Deposit status H2H - Merch ID
Built with