v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Refund a payment

Make a refund request for a completed financial charge

post/v1/charges/{id}/refunds

Path parameters

idstring required

The charge _id received at the creation stage.

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Request body

amountstring

The amount to be refunded. Omitting this field will refund the full amount of the transaction.

referencestring

A manually defined reference for the refund. If no value is provided charge.reference is used.

reference2string

A manually defined reference for the refund. If no value is provided, charge.reference2 is used.

Response

200

statusinteger

{"stackTrail":"paths:/v1/charges/{id}/refunds:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 200,
  "resource": {
    "type": "charge",
    "data": {
      "_id": "5ecd108a51eff9228f882b8b",
      "created_at": "2020-05-26T12:50:18.586Z",
      "updated_at": "2020-05-26T12:51:21.921Z",
      "company_id": "5cbeda664fdfb25772b5547f",
      "user_id": "5cbeda664fdfb25772b5547e",
      "amount": 10,
      "currency": "AUD",
      "__v": 1,
      "external_id": "ch_0Gn2EYjQKtR4Rpd2Z409qPmQ",
      "transactions": [
        {
          "created_at": "2020-05-26T12:50:18.579Z",
          "amount": 10,
          "currency": "AUD",
          "_id": "5ecd108a51eff9228f882b8c",
          "_source_ip_address": "192.168.0.1",
          "status": "complete",
          "type": "sale"
        }
      ],
      "one_off": true,
      "customer": {
        "customer_id": "5e4bfbd86d244b438451fbd7",
        "first_name": "Wanda",
        "last_name": "Mertz",
        "payment_source": {
          "source_id": "5e4bfbc96d244b438451fbd6",
          "type": "card",
          "card_name": "Wanda Mertz",
          "card_number_last4": "4242",
          "card_number_bin": "42424242",
          "card_scheme": "visa",
          "expire_month": 12,
          "expire_year": 2020,
          "address_country": "AU",
          "gateway_id": "5cbede1f151b842653e987be"
        }
      },
      "capture": true,
      "status": "refund_requested"
    }
  }
}