API Reference

Refund request for Paysquad

post
https://api.sandbox.paysquad.co/api/merchant/paysquad/refund

Queues a full refund for a completed Paysquad. The refund is not immediate; you will be notified by email when it has been processed.
Only Paysquads in Complete status can be refunded, and only once. Partial refunds are not currently supported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request a refund for a completed Paysquad.
This queues the refund; it is not executed immediately.
Only Paysquads in Complete status can be refunded, and only once. Partial refunds are not currently supported.
You will be notified by email when the refund has been processed. A programmatic refund-completed webhook is planned but not yet available.

uuid
required

The unique ID of the Paysquad that is being refunded.

string | null

A merchants description of why the refund has been requested.

string | null

Merchants reference number.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
202

The refund request has been accepted and queued.

401

Your API key is either missing or invalid.

Updated about 2 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago