Automatic Pix

Cancel payment order

Cancel the payment order in the provider.

post/inst-pull-pay/v1/pix/automatic/payment/order/cancel

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/inst-pull-pay/v1/pix/automatic/payment/order/cancel
  • Auth
    none declared. Required headers: Authorization, Idempotency-Key, x-account-id

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

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

Idempotency-Keystring required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

x-account-idinteger required

Account ID

Request body

end_to_end_idstring required

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

reason'ACCT' | 'BLCK' | 'CCLD' | 'FAIL' | 'OTHR' | 'SLBD' | 'SLCR' required

Payment order cancellation reason:

  • ACCT - Paying or receiving user's transactional account closed
  • BLCK - Paying or receiving user's transactional account blocked
  • CCLD - Recurring payments authorization cancelled
  • FAIL - Settlement process failure or error
  • OTHR - Paying or receiving user requested cancellation for other reasons
  • SLBD - Paying user request
  • SLCR - Receiving user request

Example request

{
  "end_to_end_id": "E3030629420200808195101608910248",
  "reason": "ACCT"
}

Response

OK

end_to_end_idstring required

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

reason'ACCT' | 'BLCK' | 'CCLD' | 'FAIL' | 'OTHR' | 'SLBD' | 'SLCR' required

Payment order cancellation reason:

  • ACCT - Paying or receiving user's transactional account closed
  • BLCK - Paying or receiving user's transactional account blocked
  • CCLD - Recurring payments authorization cancelled
  • FAIL - Settlement process failure or error
  • OTHR - Paying or receiving user requested cancellation for other reasons
  • SLBD - Paying user request
  • SLCR - Receiving user request
cancelled_atstring required

Cancellation date time, RFC 3339 format: YYYY-MM-DDThh:mm:ssZ.

Example response

{
  "end_to_end_id": "E3030629420200808195101608910248",
  "reason": "ACCT",
  "cancelled_at": "2024-11-14T17:54:40Z"
}

Changes

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