API Reference
GuidesAPI ReferenceGo to DashboardSite >

Refund a Payin

patch
https://api.stage.localpayment.com/api/payin//refund

This endpoint allows you to fully refund a previously authorized Payin transaction.

Refund Requirements:

  • The refund amount must match the original Payin amount.
  • The refund must be sent to the same beneficiary and account used for the original Payin.
Path Params
string
required

ID generated on your side for transaction traceability. It must be unique and only accepts alphanumeric characters and hyphens (UUID4 for example).

Body Params
string
required

A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness. Required only for Pix (Brazil) and cash refunds.

beneficiary
object
required

Object containing details about the beneficiary of the refund. Required only for Pix (Brazil) and cash refunds.

string

Comment or note providing additional information about the refund transaction.

Headers
string
required

Bearer access token for authentication. This token is obtained from the Get Access Token or Refresh Access Token endpoints.

Responses

Updated about 1 year ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 year ago