Skip to main content
POST
/
refunds
Request refund
curl --request POST \
  --url https://api.sandbox.pawapay.io/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refundId": "<INSERT_UUID_FOR_REFUND>",
  "depositId": "<INSERT_UUID_OF_DEPOSIT_TO_REFUND>",
  "amount": "15",
  "metadata": [
    {
      "fieldName": "orderId",
      "fieldValue": "ORD-123456789"
    },
    {
      "fieldName": "customerId",
      "fieldValue": "[email protected]",
      "isPII": true
    }
  ]
}
'
{
  "refundId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "status": "ACCEPTED",
  "created": "2020-10-19T11:17:01Z"
}
Refunds operation allows you to initiate a refund for asynchronous processing.

Learn more!

See what the refund flow looks like with pawaPay.
  • This API call is idempotent, which means it is safe to submit a request with the same refundId multiple times.
  • Duplicate requests with the same refundId will be ignored with the DUPLICATE_IGNORED status in the response.
  • Since the request can be rejected, you must check the status code in the response for each submitted request. The rejectionReason in the response will contain information about the reason of the rejection.
Each request can get one of the statuses on initiation:
StatusDescription
ACCEPTEDYesThe refund request has been accepted by pawaPay for processing.
REJECTEDNoThe refund request has been rejected. See rejectionReason for details.
DUPLICATE_IGNOREDNoThe refund request has been ignored as a duplicate of an already accepted refund request. Duplication logic relies upon refundId.

​
How to find out the final status of this refund?

As the pawaPay Merchant API is an asynchronous API, you can find out the final status of the ACCEPTED refund by either:

Waiting for a callback

If you have configured callbacks, just wait for it.

Checking the status

Or poll the Check Refund Status endpoint.
Headers related to signatures must only be included if you have enabled “Only accept signed requests”. Read more about it from the pawaPay Dashboard documentation.

Authorizations

​
Authorization
string
header
required

See Authentication.

Headers

​
Content-Digest
string<string>

SHA-256 or SHA-512 hash of the request body.

​
Signature
string<string>

Signature of the request according to RFC-9421.

​
Signature-Input
string<string>

Signature-Input according to RFC-9421.

​
Accept-Signature
string<string>

Expected signature algorithm of the response according to RFC-9421.

​
Accept-Digest
string<string>

Expected digest algorithm of the response according to RFC-9421.

Body

application/json
​
refundId
string<uuid>
required

A UUIDv4 based ID specified by you, that uniquely identifies the refund.

Required string length: 36
Example:

"<INSERT_UUID_FOR_REFUND>"

​
depositId
string<uuid>
required

The depositId of the deposit to be refunded.

Required string length: 36
Example:

"<INSERT_UUID_OF_DEPOSIT_TO_REFUND>"

​
amount
string

The amount to be collected (deposit) or disbursed (payout or refund).

Amount must follow below requirements or the request will be rejected:

  • Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all MMO supported decimal places.
  • The minimum and maximum amount depends on the limits of the specific MMO. You can find them from the Active Configuration endpoint.
  • Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.
  • Trailing zeroes are permitted.

Valid examples: 5, 5.0, 5.00, 5.5, 5.55, 5555555, 0.5

Not valid examples: 5., 5.555, 5555555555555555555, .5, -5.5, 00.5, 00.00, 00001.32

Required string length: 1 - 23
Example:

"15"

​
metadata
object[]

A list of metadata that you can attach to the payment for providing additional context about the payment. For example, adding orderId to indicate for which order this payment was for or customerId to know which customer this payment pertains to.

Metadata will not be visible to the customer that is party to this payment. It will be visible in the pawaPay Dashboard on the payment details page and in your financial statements as a JSON object to support automated reconciliation. It is also possible to search for recent payments in the pawaPay Dashboard using global search based on the values of metadata.

Up to 10 metadata fields can be attached to a payment.

Example:
[
  {
    "fieldName": "orderId",
    "fieldValue": "ORD-123456789"
  },
  {
    "fieldName": "customerId",
    "fieldValue": "[email protected]",
    "isPII": true
  }
]

Response

Request has been accepted for processing by pawaPay

​
refundId
string<uuid>
required

The refundId of the refund transaction.

Required string length: 36
Example:

"f4401bd2-1568-4140-bf2d-eb77d2b2b639"

​
status
enum<string>
required

Possible refund initiation statuses:

  • ACCEPTED - The refund request has been accepted by pawaPay for processing.
  • REJECTED - The refund request has been rejected by pawaPay. See rejectionReason for details.
  • DUPLICATE_IGNORED - The refund request has been ignored as a duplicate of an already accepted refund request. Duplication logic relies upon refundId.
Available options:
ACCEPTED,
REJECTED,
DUPLICATE_IGNORED
​
created
string<date-time>

The timestamp of when the refund was created in the pawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

Example:

"2020-02-21T17:32:29Z"

​
rejectionReason
object