Skip to main content
POST
Refund Payin

Authorizations

app-id
string
header
required

A unique identifier assigned to each application.

secret-key
string
header
required

A secure token associated with the app-id.

Body

application/json
uuid
string
required

Unique identifier for the payment transaction.

description
string
required

Partial refund reason, must be at least 5 characters long

amount
number

Refund amount, must be numeric. If not specified, the refund amount will be the same as the total amount.

external_id
string

Your own reference ID for this refund. Use it to match the refund to a record in your system.

Response

Payin link refund started

uuid
string

Unique identifier for the payment transaction.

expires_at
string<date-time>

Expiration time (ISO 8601 UTC) of the payment link.

URL of the payment link.

payin_method_code
string

Code of the selected payment method.

amount
number

Original payment amount.

description
string

Description of the payment transaction.

external_id
string

Custom ID.

redirect_url
object
webhook_notification
object

Webhook configuration for transaction status updates

sender_info
object

Information about the customer.

metadata
object

Optional custom metadata to attach to the transaction.

transaction_info
object

Information about the transaction.