Fluxo em dois passos: cative fundos com uma autorização e depois efetue a compra, a devolução ou o cancelamento.
Autorização
Pede ao banco do titular do meio de pagamento que cative um montante. Use-a quando precisa de garantir fundos antes de concluir a venda. O montante fica cativo até à data de expiração definida pelo banco ou até receber a compra associada, momento em que o saldo do cliente é atualizado. Suporta Cartão e telemóvel (MULTICAIXA Express).
É criado um recurso Authorization sempre que o banco do cliente responde, quer o processador aceite ou recuse. Se a comunicação falhar, não é criado recurso e é devolvido um erro.
path Parameters
posIdIdentificador do terminal (ponto de venda).
Autorização › Request Body
amountAmount to authorise or charge.
currencyISO 4217 currency code.
merchantReferenceNumberUnique merchant reference for this order. Reusing it returns 400 REFERENCE_NUMBER.
Payment method data.
orderOriginOrigin of the order.
Autorização › Responses
Operação criada. Use o id para consultar a transação.
idTransaction identifier.
Capturar fundos
Captura (cobra) os fundos cativos por uma autorização, transformando a reserva numa compra. Também designada compra após autorização.
amountpode ser igual ou inferior ao montante autorizado, nunca superior.currencytem de ser igual à moeda da autorização.- Uma autorização só pode ser capturada uma vez. Para cobrar o valor remanescente após uma captura parcial, use uma autorização parcial.
- Autorizações recusadas, expiradas (timeout) ou canceladas não podem ser capturadas.
É criado um recurso AuthorizedPayment sempre que o banco do cliente responde, quer o processador aceite ou recuse. Se a comunicação falhar, não é criado recurso e é devolvido um erro.
path Parameters
posIdIdentificador do terminal (ponto de venda).
authorizationIdIdentificador da autorização (id devolvido na sua criação).
Capturar fundos › Request Body
amountAmount to capture. Equal to or lower than the authorised amount.
currencyMust match the authorisation currency.
Capturar fundos › Responses
Operação criada. Use o id para consultar a transação.
idTransaction identifier.
Autorização parcial
Quando capturou apenas parte de um montante autorizado, use uma autorização parcial para cobrar o valor remanescente. Comporta-se como uma autorização, mantém a mesma referência do comerciante e um único id de transação, mas cobre apenas o montante ainda não cobrado.
Para que nunca guarde os dados de pagamento do cliente, o pedido envia um token de pagamento. O GPO atribui o token automaticamente à referência da autorização original; obtenha-o em paymentToken.id com Consultar referência. Capture a nova autorização como habitualmente.
path Parameters
posIdIdentificador do terminal (ponto de venda).
Autorização parcial › Request Body
amountRemaining amount to authorise.
currencymerchantReferenceNumberMerchant reference of the original authorisation.
orderOriginAutorização parcial › Responses
Operação criada. Use o id para consultar a transação.
idTransaction identifier.
Devolução da compra
Devolve uma compra efetuada após autorização. O montante pode ser igual ou inferior ao da compra. Por debitar o comerciante, é obrigatório o cartão de supervisor associado ao terminal.
path Parameters
posIdIdentificador do terminal (ponto de venda).
authorizationIdIdentificador da autorização (id devolvido na sua criação).
paymentIdIdentificador da compra (id devolvido na sua criação).
Devolução da compra › Request Body
amountAmount to refund. Equal to or lower than the purchase amount.
supervisorCardSupervisor card associated with the terminal.
Devolução da compra › Responses
Operação criada. Use o id para consultar a transação.
idTransaction identifier.
Cancelamento da autorização
Cancela uma autorização. O cancelamento liberta sempre a totalidade do montante autorizado.
path Parameters
posIdIdentificador do terminal (ponto de venda).
authorizationIdIdentificador da autorização (id devolvido na sua criação).
Cancelamento da autorização › Responses
Operação criada. Use o id para consultar a transação.
idTransaction identifier.