PIpismo
Recurring payment

Cancel recurrent compound QR Code [Beta]

Cancel a recurring payment authorization (compound) QR Code and return the updated QR Code image, EMV (Europay Mastercard Visa) string, and recurrence payload.

Notes:

  • This endpoint takes an account token - an access token encoded with a Pismo account ID.
  • This endpoint is beta, use in the dev-ext environment only.
post/v1/pix/qrcode/recurrence/cancel

Request

  • Base URL
    https://sandbox-cdn.pismolabs.io/qrcode
  • URL
    https://sandbox-cdn.pismolabs.io/qrcode/v1/pix/qrcode/recurrence/cancel
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Request body

idstring required

Pismo QR Code identifier of the recurrence to cancel.

status'REMOVED_BY_PSP' | 'REMOVED_BY_PAYEE' required

Cancellation status to apply to the recurrence QR Code.

Example request

{
  "id": "55d3992a-2f89-46fb-820a-958693bde84d",
  "status": "REMOVED_BY_PAYEE"
}

Response

Cancel recurrence QR Code response

idstring required

Pismo QR Code identifier

external_idstring required

Client-generated record identifier for client tracking and monitoring.

emvstring

Base 64 encoded discount QR Code payload. EMV = Europay, Mastercard and Visa, a global standard for credit and debit payment. The EMV might include details required for secure transactions such as cardholder informatipn, transaction amount, merchant information, and other relevant data.

qrcode_image_b64string

Base64 encoded QR Code

jws_recstring

Signed JWS payload, referring to the data of the recurrence.

access_tokenstring required

QR Code access token generated and returned at creation.

recurrence_idstring required

Recurrence ID. Either this or the recurrence object is REQUIRED.

Example response

{
  "id": "442e992a-2f89-46fb-820a-958693bde84d",
  "external_id": "my-external-id-9999-6474",
  "emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/...***63040441",
  "qrcode_image_b64": "dfkk7830o*&#)@#9FEE",
  "jws_rec": "eYqqqwq.heif.jk2w",
  "access_token": "1234567890",
  "recurrence_id": "RN219952X6X02505XXCONTRACTXXX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.