Saltar para o conteúdo

Cancels a capture
Soon

Pedido

This endpoint is rolling out shortly. The shape below is stable, but calls against it will not succeed until the feature ships.

Cancels a capture before it is processed.

Only captures still in delayed, waiting or pending can be cancelled, and only for these payment methods:

  • Multibanco: SPG and FILE references. SPG cancels in real time. FILE can take up to 24 hours, so the reference may still be paid in that window. CHECKDIGIT references cannot be cancelled.
  • Direct Debit: until the instruction is sent to the customer's bank.
  • Credit Card, Apple Pay, Google Pay and Samsung Wallet: until the customer provides their payment details on the payment page or checkout.

Once a capture has succeeded, the money has already moved, so issue a Refund instead.

Required scope: capture:delete

Segurança
accountId and apiKey
Caminho
idstring, (uuid)obrigatório

Resource Identification

curl -i -X DELETE \
  'https://api.test.easypay.pt/2.0/capture/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Respostas

No Content

Response
Sem conteúdo