StatusChangeEvent
Schema：StatusChangeEvent
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths: {}
components:
schemas:
StatusChangeEvent:
type: object
required:
- transactionId
- previousStatus
- newStatus
- changedAt
- transaction
- createdAt
properties:
transactionId:
type: string
description: Unique identifier of the transaction.
previousStatus:
type: string
description: Previous status of the transaction.
newStatus:
type: string
description: New status of the transaction.
changedAt:
type: integer
format: int64
description: Timestamp when the status changed.
changedBy:
type: string
description: Identifier of who changed the status.
reason:
$ref: '#/components/schemas/Reason'
transaction:
$ref: '#/components/schemas/MerchantTransaction'
createdAt:
type: integer
format: int64
description: Timestamp when the event was created.
x-apifox-orders:
- transactionId
- previousStatus
- newStatus
- changedAt
- changedBy
- reason
- transaction
- createdAt
x-apifox-folder: ''
Reason:
type: object
properties:
pt:
type: string
description: Reason in Portuguese.
en:
type: string
description: Reason in English.
es:
type: string
description: Reason in Spanish.
x-apifox-orders:
- pt
- en
- es
x-apifox-folder: ''
PixKeyType:
type: string
enum:
- CPF
- CNPJ
- PHONE
- EMAIL
- EVP
description: Type of PIX key.
x-apifox-folder: ''
MerchantTransaction:
oneOf:
- $ref: '#/components/schemas/MerchantPayInTransaction'
- $ref: '#/components/schemas/MerchantPayOutTransaction'
- $ref: '#/components/schemas/MerchantConversionTransaction'
description: >
A transaction object that can be a Pay-In, Pay-Out, or Conversion
transaction.
x-apifox-folder: ''
MerchantConversionTransaction:
allOf:
- &ref_0
$ref: '#/components/schemas/BaseMerchantTransaction'
- type: object
required:
- fromAmount
- fromCurrency
- toAmount
- toCurrency
- fee
properties:
type:
type: string
enum:
- conversion
description: Transaction type.
fromAmount:
type: number
description: Original amount before conversion.
fromCurrency:
type: string
enum:
- usdt
- brl
description: Currency before conversion.
toAmount:
type: number
description: Amount after conversion.
toCurrency:
type: string
enum:
- usdt
- brl
description: Currency after conversion.
fee:
type: object
properties:
percentage:
type: number
description: Fee percentage.
fixed:
type: number
description: Fixed fee amount.
x-apifox-orders:
- percentage
- fixed
x-apifox-orders:
- type
- fromAmount
- fromCurrency
- toAmount
- toCurrency
- fee
x-apifox-folder: ''
MerchantPayOutTransaction:
allOf:
- *ref_0
- type: object
required:
- amount
- netAmount
- fee
- currency
properties:
type:
type: string
enum:
- pay-out
description: Transaction type.
amount:
type: number
description: Transaction amount.
netAmount:
type: number
description: Net amount after fees.
fee:
type: object
properties:
percentage:
type: number
description: Fee percentage.
fixed:
type: number
description: Fixed fee amount.
x-apifox-orders:
- percentage
- fixed
currency:
type: string
enum:
- brl
- usdt
description: Currency used.
pixKey:
type: string
description: Recipient's PIX key.
pixKeyType:
$ref: '#/components/schemas/PixKeyType'
payeeDocument:
type: string
description: Recipient's CPF or CNPJ.
payeeName:
type: string
description: Recipient's full name.
payeeAccount:
type: string
description: Recipient's account number.
payeeBranch:
type: string
description: Recipient's bank branch.
payeeBankcode:
type: string
description: Recipient's bank code.
payeeBankname:
type: string
description: Recipient's bank name.
x-apifox-orders:
- type
- amount
- netAmount
- fee
- currency
- pixKey
- pixKeyType
- payeeDocument
- payeeName
- payeeAccount
- payeeBranch
- payeeBankcode
- payeeBankname
x-apifox-folder: ''
MerchantPayInTransaction:
allOf:
- *ref_0
- type: object
required:
- amount
- netAmount
- fee
- currency
properties:
type:
type: string
enum:
- pay-in
description: Transaction type.
amount:
type: number
description: Transaction amount.
netAmount:
type: number
description: Net amount after fees.
fee:
type: object
properties:
percentage:
type: number
description: Fee percentage.
fixed:
type: number
description: Fixed fee amount.
x-apifox-orders:
- percentage
- fixed
currency:
type: string
enum:
- brl
- usdt
description: Currency used.
qrCode:
type: string
description: QR Code in base64 format.
pixCode:
type: string
description: PIX code.
payerName:
type: string
description: Payer's full name.
payerDocument:
type: string
description: Payer's CPF or CNPJ.
payerAccount:
type: string
description: Payer's account number.
payerBranch:
type: string
description: Payer's bank branch.
payerBankcode:
type: string
description: Payer's bank code.
payerBankname:
type: string
description: Payer's bank name.
x-apifox-orders:
- type
- amount
- netAmount
- fee
- currency
- qrCode
- pixCode
- payerName
- payerDocument
- payerAccount
- payerBranch
- payerBankcode
- payerBankname
x-apifox-folder: ''
BaseMerchantTransaction:
type: object
required:
- transactionId
- type
- status
- createdAt
- updatedAt
properties:
transactionId:
type: string
description: Unique identifier of the transaction.
merchantExternalId:
type: string
description: Merchant's external identifier.
type:
type: string
description: Type of the transaction.
status:
type: string
description: Current status of the transaction.
createdAt:
type: string
format: date-time
description: Creation date and time.
updatedAt:
type: string
format: date-time
description: Last update date and time.
x-apifox-orders:
- transactionId
- merchantExternalId
- type
- status
- createdAt
- updatedAt
x-apifox-folder: ''
securitySchemes: {}
servers: []
security: []