HiSoftwareHiSoftware

Criar transação

POSThttps://api.hiso.com.br/v1/payment-transaction/create

Cria uma nova transação de pagamento com cartão, boleto ou PIX.

Body Params

amountintegerrequired

Valor total em centavos. Ex: 1000 = R$ 10,00

payment_methodstringrequired
pixcredit_cardboleto
postback_urlstring

URL para receber atualizações da transação

customerobjectrequired
namestringrequired
emailstringrequired
documentobjectrequired
phonestringrequired
itemsarray of objectsrequired
titlestringrequired
unit_priceintegerrequired

Em centavos

quantityintegerrequired
tangiblebooleanrequired

Define se o produto é físico ou não

external_refstring
shippingobject
feenumber
addressobject
pixobject
expires_in_daysintegerrequired
cardobject

Obrigatório para cartão. Envie o hash gerado pelo SDK (recomendado, ver "Cartão com 3DS") ou os dados abertos do cartão.

hashstring

Token gerado pelo encrypt() do SDK. Quando enviado, os demais campos do cartão não são necessários.

numberstring

Obrigatório quando não houver hash.

holder_namestring

Obrigatório quando não houver hash.

expiration_monthinteger

Obrigatório quando não houver hash.

expiration_yearinteger

Obrigatório quando não houver hash.

cvvstring

Obrigatório quando não houver hash.

boletoobject
expires_in_daysintegerrequired
installmentsinteger

Ex: 1

metadatajson

Ex: { "provider_name": "Nome da label" }

ipstring
splitarray of objects
company_idstring

Encontrado na tela Credenciais API

fixed_amountinteger

Valor fixo (em centavos). Exemplo: 500 = R$ 5,00

percentageinteger

Valor percentual. Exemplo: 20 = 20%

Responses

Response body — application/json

dataobject
idstring
amountinteger
installmentsinteger
payment_methodstring
statusstring
PENDINGPAIDREFUNDEDREFUSEDCHARGEBACKPRECHARGEBACKEXPIREDERROR
postback_urlstring
cardobject
three_dsobject

Presente quando o cartão exige autenticação 3DS. Repasse a resposta ao finishThreeDS() do SDK.

boletoobject
pixobject
successboolean
return_message_typeinteger
error_messagesarray