Skip to content
Gowd Platform Sandbox Sandbox

Your postback notification for a scheduled payment cancellation.

POST
/order/example-postback-to-banking-scheduled-payment-cancellation/[your_notification_url]

Every time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.

We expect that your system returns to ours: status code 200. If not, we’ll retry 4 more times.

Request Body required

Section titled “Request Body required ”
object
event
required

Webhook event for the cancellation of a scheduled payment.

string
Allowed values: SUBSCRIPTION.SCHEDULED_PAYMENT.CANCELLATION.ACCEPTED SUBSCRIPTION.SCHEDULED_PAYMENT.CANCELLATION.REJECTED SUBSCRIPTION.SCHEDULED_PAYMENT.CANCELLATION.PENDING
Example
SUBSCRIPTION.SCHEDULED_PAYMENT.CANCELLATION.ACCEPTED
occurredAt
required

When the event occurred (UTC ISO-8601).

string
Example
2026-02-19T13:41:12.991Z
data
required

The updated scheduled payment data.

object
id
required

Identifier of the scheduled payment.

string
Example
7c3f2e2a-5b3a-4f7e-9a0a-2e2f9d0c1a2b
externalId
required

The unique code on the partner system.

string
Example
scheduled-payment-partner-id
subscriptionId
required

Identifier of the subscription this payment belongs to.

string
Example
550e8400-e29b-41d4-a716-446655440000
status
required

Current status of the scheduled payment, not of the cancellation request.

string
Allowed values: INITIAL PENDING ACCEPTED REJECTED COMPLETED ERROR CANCELED CANCELED_INSUFFICIENT_BALANCE
Example
ACCEPTED
purpose

Purpose of the scheduled payment.

  • FIRST_ATTEMPT and NEW_ATTEMPT_AFTER_DUE_DATE: created by the partner.
  • RESEND_DUE_TO_SETTLEMENT_ERROR: created by Gowd on the due date, until 21h, after the payer PSP canceled the original with reason SETTLEMENT_ERROR. Its id and externalId are not the partner ones; use settlementErrorRetryRootId to match it with the charge the partner created.
string
Allowed values: FIRST_ATTEMPT NEW_ATTEMPT_AFTER_DUE_DATE RESEND_DUE_TO_SETTLEMENT_ERROR
Example
FIRST_ATTEMPT
originalScheduledPaymentId

Scheduled payment this one refers to. On a RESEND_DUE_TO_SETTLEMENT_ERROR, the one it resends (on a second resend, the first resend); on a NEW_ATTEMPT_AFTER_DUE_DATE, the first attempt it retries. Not sent otherwise.

string
Example
7c3f2e2a-5b3a-4f7e-9a0a-2e2f9d0c1a2b
settlementErrorRetryRootId

Scheduled payment the partner created, the first of the chain of resends. Sent only on a RESEND_DUE_TO_SETTLEMENT_ERROR.

string
Example
7c3f2e2a-5b3a-4f7e-9a0a-2e2f9d0c1a2b
settlementErrorRetryAttempt

Attempt number of the resend, from 1 to 3. Sent only on a RESEND_DUE_TO_SETTLEMENT_ERROR.

number
Example
1
updatedAt
required

Date of the last status transition of the scheduled payment (UTC ISO-8601).

string
Example
2026-02-19T13:41:12.991Z
cancellation
required

The cancellation request.

object
id
required

Identifier of the cancellation request.

string
Example
e4d1f9b2-6c3a-4a2e-8b1a-1a2b3c4d5e6f
status
required

Status of the cancellation request.

string
Allowed values: ACCEPTED REJECTED PENDING
Example
ACCEPTED
endToEndId
required

PIX end-to-end id of the cancellation request.

string
Example
E12345678202602191341a1b2c3d4e5
reason
required

Reason for the cancellation of the scheduled payment.

string
Allowed values: ACCOUNT_CLOSURE ACCOUNT_BLOCKED AUTHORIZATION_CANCELED SETTLEMENT_ERROR OTHER_REASONS REQUESTED_BY_PAYER REQUESTED_BY_RECEIVER
Example
REQUESTED_BY_PAYER
canceledAt
required

Date when the scheduled payment was canceled (UTC ISO-8601).

string
Example
2026-02-19T13:41:12.991Z
customer
required

Customer who requested the cancellation.

object
document
required

Document of the customer who requested the cancellation.

object
type
required

Document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

Document number

string
Example
12345678901
Examples

SUBSCRIPTION.SCHEDULED_PAYMENT.CANCELLATION.ACCEPTED

The cancellation request was accepted and the scheduled payment is canceled.

{
  "event": "SUBSCRIPTION.SCHEDULED_PAYMENT.CANCELLATION.ACCEPTED",
  "occurredAt": "2026-02-19T13:41:12.991Z",
  "data": {
    "id": "7c3f2e2a-5b3a-4f7e-9a0a-2e2f9d0c1a2b",
    "externalId": "scheduled-payment-2024-0001",
    "subscriptionId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "CANCELED",
    "updatedAt": "2026-02-19T13:41:12.991Z",
    "cancellation": {
      "id": "e4d1f9b2-6c3a-4a2e-8b1a-1a2b3c4d5e6f",
      "status": "ACCEPTED",
      "endToEndId": "E12345678202602191341a1b2c3d4e5",
      "reason": "REQUESTED_BY_PAYER",
      "canceledAt": "2026-02-19T13:41:12.991Z",
      "customer": {
        "document": {
          "type": "CPF",
          "number": "52998224725"
        }
      }
    }
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
returnCode
required

The current page.

string
Example
SUCCESS