Pix reversal (refund) status changed
A Pix reversal (refund) status change event. The following endpoints generate this event: Create refund request, Cancel refund request, and Close refund. For more information, see the Pix instant payments guide. Also see the Pix payments data events guide.
Type: object
Domain: pix-dict
Event: refund_status_change
Version: 1
contested_participant required
Title: Contested participant
Description: Participant's ISPB (Identifcador do Sistema de Pagamento Brazil) - the Brazilian Payment System identifier, an 8-digit value.
Type: string
Max length: 8
Example:
99999011
creation_date_time required
Title: Creation date time
Description: Infraction report creation datetime. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-15T16:59:06.389Z
id required
Title: Refund Id
Description: Pix refund ID.
Type: string
Example:
cfdff46e-5d58-45b8-b7aa-591a65f7760d
last_modified required
Title: Last modified
Description: Last status update datetime. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-15T16:59:06.389Z
refund_reason required
Title: Refund Reason
Description: Return request reason.
Type: string
Max length: 16
Must be one of the following:
FRAUD
OPERATIONAL_FLAW
REFUND_CANCELLED
Example:
FRAUD
requesting_participant required
Title: Requesting participant
Description: Requesting participant's ISPB (Identifcador do Sistema de Pagamento Brazil) - the Brazilian Payment System identifier, an 8-digit value.
Type: string
Max length: 8
Example:
40867163
status required
Title: Refund status
Type: string
Max length: 9
Must be one of the following:
OPEN
CLOSED
CANCELLED
Example:
OPEN
transaction_id required
Title: Transaction Id
Description: ID of transaction being contested.
Type: string
Example:
E30306294202110041316KL5BCD0OHEM
analysisDetails
Title: Analysis details
Description: Details of the return request analysis explaining result.
Type: string or null
Max length: 2000
analysis_result
Title: Analysis result
Description: Refund request analysis
Type: string or null
Max length: 18
Must be one of the following:
TOTALLY_ACCEPTED
PARTIALLY_ACCEPTED
REJECTED
Example:
REJECTED
correlation_id
Title: Correlation Id
Description: The correlation ID (CID) field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. You can find the CID field in the response header from an API endpoint call.
Type: string or null
Example:
B20211015233837f151ffe5060723e26
infraction_report_id
Title: Infraction report ID
Description: Infraction report referene in case of fraud refund.
Type: string or null
Example:
cfdff46e-5d58-45b8-b7aa-591a65f74444
refund_amount
Title: Refund amount
Description: Amount requested for return.
Type: number or null
Example:
0.1
refund_details
Title: Refund details
Description: Brief description of the reason for requesting a return.
Type: string or null
Max length: 2000
refund_rejection_reason
Title: Refund rejection reason
Description: Reason for rejecting the refund request.
Type: string or null
Max length: 15
Must be one of the following:
NO_BALANCE
ACCOUNT_CLOSURE
CANNOT_REFUND
Example:
NO_BALANCE
refund_transaction_id
Title: Refund transaction ID
Description: Refund transaction end to end ID (full or partial).
Type: string or null
Example:
D0000000202110041316KL5BCD0O111
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Pix reversal (refund) status changed",
"description": "A Pix reversal (refund) status change event. The following endpoints generate this event: <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-pix-refund-create' target='_blank'>Create refund request</a>, <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-pix-refund-cancel' target='_blank'>Cancel refund request</a>, and <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-pix-refund-close' target='_blank'>Close refund</a>. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/pix-instant-payments' target='_blank'>Pix instant payments</a> guide. Also see the <a href='https://developers.pismo.io/pismo-docs/docs/pix-payments-data-events' target='_blank'>Pix payments data events</a> guide.",
"required": [
"contested_participant",
"creation_date_time",
"id",
"last_modified",
"refund_reason",
"requesting_participant",
"status",
"transaction_id"
],
"properties": {
"contested_participant": {
"type": "string",
"title": "Contested participant",
"description": "Participant's ISPB (Identifcador do Sistema de Pagamento Brazil) - the Brazilian Payment System identifier, an 8-digit value.",
"maxLength": 8,
"examples": [
"99999011"
]
},
"creation_date_time": {
"type": "string",
"title": "Creation date time",
"description": "Infraction report creation datetime. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
"format": "date-time",
"examples": [
"2021-10-15T16:59:06.389Z"
]
},
"id": {
"type": "string",
"title": "Refund Id",
"description": "Pix refund ID.",
"examples": [
"cfdff46e-5d58-45b8-b7aa-591a65f7760d"
]
},
"last_modified": {
"type": "string",
"title": "Last modified",
"description": "Last status update datetime. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
"format": "date-time",
"examples": [
"2021-10-15T16:59:06.389Z"
]
},
"refund_reason": {
"type": "string",
"title": "Refund Reason",
"description": "Return request reason.",
"maxLength": 16,
"enum": [
"FRAUD",
"OPERATIONAL_FLAW",
"REFUND_CANCELLED"
],
"example": "FRAUD"
},
"requesting_participant": {
"type": "string",
"title": "Requesting participant",
"description": "Requesting participant's ISPB (Identifcador do Sistema de Pagamento Brazil) - the Brazilian Payment System identifier, an 8-digit value.",
"maxLength": 8,
"examples": [
"40867163"
]
},
"status": {
"type": "string",
"title": "Refund status",
"maxLength": 9,
"enum": [
"OPEN",
"CLOSED",
"CANCELLED"
],
"example": "OPEN"
},
"transaction_id": {
"type": "string",
"title": "Transaction Id",
"description": "ID of transaction being contested.",
"examples": [
"E30306294202110041316KL5BCD0OHEM"
]
},
"analysisDetails": {
"type": [
"string",
"null"
],
"title": "Analysis details",
"description": "Details of the return request analysis explaining result.",
"maxLength": 2000
},
"analysis_result": {
"type": [
"string",
"null"
],
"title": "Analysis result",
"description": "Refund request analysis",
"maxLength": 18,
"enum": [
"TOTALLY_ACCEPTED",
"PARTIALLY_ACCEPTED",
"REJECTED"
],
"example": "REJECTED"
},
"correlation_id": {
"type": [
"string",
"null"
],
"title": "Correlation Id",
"description": "The correlation ID (CID) field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. You can find the CID field in the response header from an API endpoint call.",
"examples": [
"B20211015233837f151ffe5060723e26"
]
},
"infraction_report_id": {
"type": [
"string",
"null"
],
"title": "Infraction report ID",
"description": "Infraction report referene in case of fraud refund.",
"examples": [
"cfdff46e-5d58-45b8-b7aa-591a65f74444"
]
},
"refund_amount": {
"type": [
"number",
"null"
],
"title": "Refund amount",
"description": "Amount requested for return.",
"examples": [
0.1
]
},
"refund_details": {
"type": [
"string",
"null"
],
"title": "Refund details",
"description": "Brief description of the reason for requesting a return.",
"maxLength": 2000
},
"refund_rejection_reason": {
"type": [
"string",
"null"
],
"title": "Refund rejection reason",
"description": "Reason for rejecting the refund request.",
"maxLength": 15,
"enum": [
"NO_BALANCE",
"ACCOUNT_CLOSURE",
"CANNOT_REFUND"
],
"example": "NO_BALANCE"
},
"refund_transaction_id": {
"type": [
"string",
"null"
],
"title": "Refund transaction ID",
"description": "Refund transaction end to end ID (full or partial).",
"examples": [
"D0000000202110041316KL5BCD0O111"
]
}
}
}
Updated 16 days ago