Pular para o conteúdo principal
Versão: 1.15.0

Solicitando Pagamentos Remotos

POST /v1/transaction/register

Headers

Authorization

Token de usuário fornecido pela equipe GetCard.

Parâmetros de Query

terminalId (opcional)

ID do terminal para qual se deseja enviar a solicitação de pagamento. Para solicitar um pagamento que pode ser processado em qualquer terminal basta não informar este parâmetro.

Corpo da requisição

JSON

{
"description": "Venda 123 do caixa 001",
"amount": 5162,
"paymentType": "DEBIT",
"installmentType": "ONE_TIME",
"installmentNumber": 1
}
ChaveTipoDescrição
descriptionStringDescrição do pagamento p/ facilitação de identifição no GetCard Pay.
amountInteiroValor do pagamento em centavos.
paymentTypeStringTipo de pagamento. CREDIT, DEBIT, PIX ou VOUCHER.
installmentTypeStringTipo de parcelamento. ONE_TIME, INSTALLMENT_BUYER ou INSTALLMENT_SELLER.
installmentNumberInteiroNúmero de parcelas.

Corpo da resposta

JSON

{
"data": {
"transactionId": "7581edf0-b893-45be-b835-dfd539f4e84c"
},
"resultCode": 201,
"message": "Created"
}
dataObject

Objeto com os dados do pagamento solicitado.

idUUID
  • Exemplo: "7581edf0-b893-45be-b835-dfd539f4e84c"
  • Descrição: ID do pagamento solicitado. Utilizado para consultar o status e realizar o estorno.
resultCodeInt
  • Exemplo: 201
  • Descrição: Código de status HTTP.
messageString
  • Exemplo: "Created"
  • Descrição: Descrição do resultado da operação.