Refund a payment on an invoice

POST

/api/v1/invoices/{id}/refund

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/invoices/example/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "payment_id": "example", "amount": 1, "reason": "example" }'

Refunds payment_id in full or by amount; Stripe and Razorpay payments are refunded through the provider. Only succeeded or partially refunded payments qualify.

Authorizations

• bearerJwt
• personalAccessToken
  write:invoices
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

payment_id

required

string

/^[0-9a-fA-F]{24}$/

amount

number

> 0

reason

string

<= 1000 characters

Example^generated

{
  "payment_id": "example",
  "amount": 1,
  "reason": "example"
}

Responses

200

The refunded payment and the updated invoice

Media typeapplication/json

object

payment

required

object

_id

required

string

key

additional properties

any

invoice

required

object

_id

required

string

key

additional properties

any

Example^generated

{
  "payment": {
    "_id": "example"
  },
  "invoice": {
    "_id": "example"
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}