Refund part or all of a settled payment (owner approval note; pending until the provider confirms)

post/api/v1/payments/{id}/refunds

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/payments/{id}/refunds
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required

Request body

amount_minorinteger

Defaults to the full refundable amount

approval_notestring required
idempotency_keystring

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.