Payout details

Get payout status and details.

You can check the payout status at any time:

GET /v1/payouts/{partner_code}
Host: query.sulpayments.ch
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

The response will be:

{
  "partner_code": "0001",
  "name": "Customer name",
  "document": "88899988811",
  "email": "[email protected]",
  "phone": "44988772211",
  "birth": "2000-27-12",
  "value": 10.23,
  "payment_method": "picpay",
  "notification_url": "https://your-system.com/webhook",
  "fee_payer": "merchant",
  "status": "done",
  "paid_at": "2022-01-01 12:01:00",
  "created_at": "2022-01-01 12:00:55",
  "payment_id": "provider-payment-id",
  "reason": "error message if status is error"
}

Status meanings

Status	Meaning
initial	Payout is claimed.
processing	Payout sent to provider, waiting to be processed.
done	Money was successfully transfered to the customer.
error	Some error on the prcessing step.

Resource not found

If the payout is not found, the response will be:

{
  "message": "Resource not found"
}

Internal error

If an internal error occurs, the response will be:

{
  "message": "Internal error. Please try again."
}