Payout Status

This endpoint returns the information about a payout order.

POST - Sandbox

https://sandbox.paypaygateway.com/fn-execute/payment/payout/status

POST - Production

https://api.paypaygateway.com/fn-execute/payment/payout/status

Header Parameters

Parameter	Description	Type	R/O
Authorization	Authorization header containing your Secret Key	string	R
mid	mid header containing your merchant ID	string	O

Body Parameters

Parameter	Description	Type	R/O
payoutId	Payout ID	string	R

{
  "payoutId": "6981d1fb9a9ccb0513fd4ae7"
}

Responses

200

{
  "status": "successful",
  "code": "2009",
  "messagetype": "payout",
  "message": {
      "payoutId": "6981d1fb9a9ccb0513fd4ae7",
      "status": "SUCCESS",
      "date": "2023-07-18T11:21:41",
      "amount": 50000,
      "currency": "EUR",
      "message": "ok"
  }
}

Parameter	Description	Type
status	Response status	string
code	Response code	string
messagetype	Response message type	string
payoutId	Payout ID	string
status	Payout status	string
date	Date of payout	string
amount	Amount of payout, in the minor unit of your selected currency. All currencies are standardized to 100 units. For example, an amount of 100 in EUR is equal to 1€	number
currency	Code of the currency	string
message	Payout message	string

400

{
  "status": "failure",
  "code": "1050",
  "messagetype": "payout",
  "message": {
    "error": "Payout ID is required"
  }
}

Parameter	Description	Type
status	Response status	string
code	Response code	string
messagetype	Response message type	string
error	Message error	string

400

{
  "status": "failure",
  "code": "1051",
  "messagetype": "payout",
  "message": {
    "error": "Payout not found"
  }
}

Parameter	Description	Type
status	Response status	string
code	Response code	string
messagetype	Response message type	string
error	Message error	string