Status payout | API PayStar.uk

INFO

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

Payout | H2H

When checking the status, provide the externalId that you received in the response to the payout 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

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 payout order

Polling - every 2 min before getting the final status.

CURL Example | GET Status payout order

curl --request GET \
 --url https://secure.PayStar.uk/api/v1/integration/withdrawal-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

required

Example:

f8832bdf-ce98-48e1-b3d3-023fdb7358d0

orderStatus

string

required

Example:

Processing

Example

{
  "externalId": "f8832bdf-ce98-48e1-b3d3-023fdb7358d0",
  "orderStatus": "Processing"
}

🟠401Unauthorized

🟠403Forbidden

🟠404Order Not Found

🔴500Internal Server Error: Errors 499+ occur in unforeseen circumstances. They are transient and not indicative of the order status. If you receive a 499+ error when creating a payment, we recommend checking the payment status using the following method: **/a

Payout status H2H

Check status payout order

CURL Example | GET Status payout order

Request

Request samples

Responses

Payout status H2H

Check status payout order#

CURL Example | GET Status payout order#

Request

Request samples

Responses

Check status payout order

CURL Example | GET Status payout order