Skip to main content

Cancel Payment

DELETE 
/v1/payments/:id
Description: Endpoint that process the cancellation of a payment.

Request​

Path Parameters

    id stringrequired

    Payment ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Payment canceled successfully.

Schema
    id stringrequired

    Payment ID.

    status stringrequired

    Possible values: [PENDING, AUTHORIZED, REVERTED, CANCELLED, SETTLED]

    Payment status.

    created_at date-timerequired

    Payment creation date.

    updated_at date-timerequired

    Payment update date.

Loading...