PayStar API Documentation
    • Introduction
    • Glossary
    • Authorization key
    • Sandbox
    • Additional fields
    • Currencies
    • Bank names
    • Callbacks
    • Telecom operators
    • Payment history
    • Error descriptions
    • Tech FAQ
    • Events
    • Balance H2H
      GET
    • Deposit H2H - ECOM (with PCI) / P2P / Online
      POST
    • Deposit H2H - ECOM by Card token (without PCI)
      POST
    • Deposit H2C - ECOM (without PCI)
      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

      Deposit status H2H - Merch ID

      GET
      https://secure.paystar.uk/api/v1/integration/deposit-order/{externalTransactionId}/status-by-external-transaction-id
      Maintainer:Not configured
      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 externalTransactionId 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

      Responses

      🟢200Success
      application/json
      Bodyapplication/json

      🟠401Unauthorized
      🟠403Forbidden
      🟠404Order not found
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location 'https://secure.paystar.uk/api/v1/integration/deposit-order/7e586998-31b0-41f3-8746-4a93a1aca802/status-by-external-transaction-id' \
      --header 'Authorization: Bearer <token>'
      Response Response Example
      200 - Example 1
      {
          "externalId": "PSP-bf95219b-393d-4323-91bf-639ac",
          "orderStatus": "Success",
          "amount": 2600.00,
          "externalParams": {
              "cardToken": "BankToken-bf95219b-393d-4323-91bf-639ac",
              "cardStorageToken": "PayStarToken-bf95219b-393d-4323-91bf-639ac",
              "cardNumber": "123456****1234",
              "cardHolder": "JOHN WEAK"
          },
          "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"
              }
          ]
      }
      Previous
      Deposit status H2H - PayStar ID
      Next
      Payout H2H
      Built with