Consulta de pedido de pagamento

GET /api/orders

Retorna informações de um pedido de pagamento SCI pelo ID do pedido do lojista e, opcionalmente, pelo nome da SCI.

Requisição

Parâmetros Query

orderId stringobrigatório

Valores possíveis: <= 64 caracteres

Identificador do pedido do lojista.

Exemplo: test-order-001

sciName string

Nome da integração SCI, opcional.

Exemplo: sandbox-sci

Respostas

application/json

Esquema
Exemplo

Esquema

orderIdstring

ID do pedido.

Exemplo: ORDER_123456

sciNamestring

Nome da SCI.

Exemplo: test-value

paymentStatusstring

Status do pagamento.

Valores possíveis: [PENDING, COMPLETED, CANCELED, REFUNDED]

Exemplo: COMPLETED

paymentMethodstring

Método de pagamento.

Valores possíveis: [INTERNAL_OTHERS, CRYPTO_INVOICE]

Exemplo: CRYPTO_INVOICE

paymentCreateddate-time

Data de criação do pagamento.

transaction object

Esquema Payment Order Transaction Dto.

iduuid

ID.

Exemplo: 11111111-1111-4111-8111-111111111111

statusstring

Status.

Valores possíveis: [PENDING, COMPLETED, CANCELED, REFUNDED]

Exemplo: COMPLETED

senderAmountnumber

Valor do remetente.

Exemplo: 10.25

senderCurrencystring

Moeda do remetente.

Valores possíveis: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

Exemplo: USD

receiverAmountnumber

Valor do destinatário.

Exemplo: 10.25

receiverCurrencystring

Moeda do destinatário.

Exemplo: USD

createddate-time

Data de criação.

completeddate-time

Data de conclusão.

canceleddate-time

Data de cancelamento.

notestring

Observação.

Exemplo: Sandbox transfer note

srcWalletIdstring

ID da carteira de origem.

Exemplo: USD880390848110

buyerEmailstring

E-mail do comprador.

Exemplo: [email protected]

invoice object

Esquema Payment Order Invoice Dto.

createddate-time

Data de criação.

receiveddate-time

Data de recebimento.

completeddate-time

Data de conclusão.

refundRequesteddate-time

Data da solicitação de reembolso.

refundeddate-time

Data do reembolso.

externalStatusstring

Status externo.

Valores possíveis: [NEW, EXPIRED, PAYMENT_RECEIVED, UNDERPAYMENT_RECEIVED, OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_RECEIVED, EXPIRED_UNDERPAYMENT_RECEIVED, EXPIRED_OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_REFUND_REQUESTED, UNDERPAYMENT_REFUND_REQUESTED, EXPIRED_UNDERPAYMENT_REFUND_REQUESTED, OVERPAYMENT_REFUND_REQUESTED, FULL_OVERPAYMENT_REFUND_REQUESTED, EXPIRED_PAYMENT_REFUNDED, UNDERPAYMENT_REFUNDED, OVERPAYMENT_REFUNDED, FULL_OVERPAYMENT_REFUNDED, EXPIRED_PAYMENT_REFUND_CONFIRMATION_REQUIRED, UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, EXPIRED_UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, FULL_OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, CLOSED]

Exemplo: NEW

invoiceStatusstring

Status da fatura.

Valores possíveis: [NEW, RECEIVED, EXCHANGING, COMPLETED, REFUND_CONFIRMATION, REFUND_REQUESTED, REFUNDED, CLOSED]

Exemplo: NEW

penaltiesstring[]

Penalidades.

Valores possíveis: [EXPIRED, UNDERPAYMENT, OVERPAYMENT]

Exemplo: ["EXPIRED"]

refundTypestring

Tipo de reembolso.

Valores possíveis: [FULL_REFUND, PARTIAL_REFUND]

Exemplo: FULL_REFUND

cryptoCurrencyAddressstring

Endereço cripto.

Exemplo: USD

initialSenderAmountnumber

Valor inicial do remetente.

Exemplo: 10.25

actualReceivedAmountnumber

Valor efetivamente recebido.

Exemplo: 10.25

senderCurrencystring

Moeda do remetente.

Exemplo: USD

cryptoCurrencyTransactionIdstring

ID da transação cripto.

Exemplo: 11111111-1111-4111-8111-111111111111

refundAddressstring

Endereço de reembolso.

Exemplo: test-value

{
  "orderId": "ORDER_123456",
  "sciName": "test-value",
  "paymentStatus": "CREATED",
  "paymentMethod": "CRYPTO_INVOICE",
  "paymentCreated": "2026-01-15T10:30:00",
  "transaction": {
    "status": "success"
  },
  "invoice": {
    "status": "success"
  }
}

Requisição inválida. A requisição está malformada ou contém parâmetros inválidos.

application/json

Esquema
Exemplo

Esquema

statusstringobrigatório

Status da resposta.

Valores possíveis: [error]

Exemplo: error

data objectobrigatório

Dados da resposta de erro.

errors object[]obrigatório

Lista de erros retornados para a requisição.

Array [

errorMessagestringobrigatório

Código de erro estável e legível por máquina.

Exemplo: disabled

errorTypestringobrigatório

Categoria do erro.

Exemplo: FORM

errorIdstringobrigatório

Identificador curto e único do erro para suporte e logs.

Exemplo: errTest1234

errorDescriptionstringobrigatório

Descrição legível do erro.

Exemplo: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API

errorFieldstringnullable

Campo da requisição relacionado ao erro, se houver.

Exemplo: null

paramsobject[]obrigatório

Parâmetros adicionais do erro.

requestParamsobjectobrigatório

Parâmetros da requisição registrados para diagnóstico.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Não autorizado. Os cabeçalhos de autenticação do lojista estão ausentes ou inválidos.

application/json

Esquema
Exemplo

Esquema

statusstringobrigatório

Status da resposta.

Valores possíveis: [error]

Exemplo: error

data objectobrigatório

Dados da resposta de erro.

errors object[]obrigatório

Lista de erros retornados para a requisição.

Array [

errorMessagestringobrigatório

Código de erro estável e legível por máquina.

Exemplo: userDoesNotExistException

errorTypestringobrigatório

Categoria do erro.

Exemplo: GENERAL

errorIdstringobrigatório

Identificador curto e único do erro para suporte e logs.

Exemplo: errTest1234

errorDescriptionstringobrigatório

Descrição legível do erro.

Exemplo: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]

errorFieldstringnullable

Campo da requisição relacionado ao erro, se houver.

Exemplo: null

paramsobject[]obrigatório

Parâmetros adicionais do erro.

requestParamsobjectobrigatório

Parâmetros da requisição registrados para diagnóstico.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Não encontrado. O recurso solicitado não existe.

application/json

Esquema
Exemplo

Esquema

statusstringobrigatório

Status da resposta.

Valores possíveis: [error]

Exemplo: error

data objectobrigatório

Dados da resposta de erro.

errors object[]obrigatório

Lista de erros retornados para a requisição.

Array [

errorMessagestringobrigatório

Código de erro estável e legível por máquina.

Exemplo: resourceNotFound

errorTypestringobrigatório

Categoria do erro.

Exemplo: GENERAL

errorIdstringobrigatório

Identificador curto e único do erro para suporte e logs.

Exemplo: errTest1234

errorDescriptionstringobrigatório

Descrição legível do erro.

Exemplo: Resource not found

errorFieldstringnullable

Campo da requisição relacionado ao erro, se houver.

Exemplo: null

paramsobject[]obrigatório

Parâmetros adicionais do erro.

requestParamsobjectobrigatório

Parâmetros da requisição registrados para diagnóstico.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Erro interno do servidor. Erro inesperado, entre em contato com o suporte

application/json

Esquema
Exemplo

Esquema

statusstringobrigatório

Status da resposta.

Valores possíveis: [error]

Exemplo: error

data objectobrigatório

Dados da resposta de erro.

errors object[]obrigatório

Lista de erros retornados para a requisição.

Array [

errorMessagestringobrigatório

Código de erro estável e legível por máquina.

Exemplo: internalServerError

errorTypestringobrigatório

Categoria do erro.

Exemplo: GENERAL

errorIdstringobrigatório

Identificador curto e único do erro para suporte e logs.

Exemplo: errTest1234

errorDescriptionstringobrigatório

Descrição legível do erro.

Exemplo: Internal server error

errorFieldstringnullable

Campo da requisição relacionado ao erro, se houver.

Exemplo: null

paramsobject[]obrigatório

Parâmetros adicionais do erro.

requestParamsobjectobrigatório

Parâmetros da requisição registrados para diagnóstico.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Consulta de pedido de pagamento

/api/orders

Requisição​

Parâmetros Query

Respostas​

Requisição

Respostas