TRtruust-io
Payins

Refund payin

Changed on

Issues a partial or full refund for a confirmed payin. Only supported payment methods can be refunded. For bank wire payins, a bankaccount_id is required to specify the refund destination.

post/payins/{id}/refund

Request

  • Base URL
    https://your-subdomain.truust.io/2.0
  • URL
    https://your-subdomain.truust.io/2.0/payins/{id}/refund
  • Auth
    HTTP bearer

Path parameters

idinteger required

Payin ID.

Request body

amountnumber

Amount to refund. Defaults to full amount if not provided.

multipayin0 | 1

Set to 1 to refund all payins associated with the order of this payin.

bankaccount_idinteger

Required if the payin is of Bankwire type. Bank account ID to receive the refund.

tagstring
metadataobject

Example request

{
  "amount": 2,
  "multipayin": 0
}

Response

Payin with refund details

idinteger
selfstring
referencestring nullable

Provider's payment reference ID.

typestring

Payment method type (e.g. CARD, BANKWIRE, WALLET).

subtypestring nullable
status'CREATED' | 'AUTHORIZED' | 'CONFIRMED' | 'DENIED' | 'REFUNDED' | 'CANCELLED'
providerobject

Raw provider response data.

tagstring nullable
direct_linkstring uri nullable

Payment page URL. Only present when status is CREATED or AUTHORIZED.

created_atstring date-time nullable
confirmed_atstring date-time nullable
denied_atstring date-time nullable
connectionsConnections

Hypermedia links to related resources.

Example response

{
  "self": "/2.0/payins/456"
}

Changes