Skip to main content

Cancel Payin

DELETE 
/v1/payin/:id
Tag: api-payments-gateway-delete-payinDescription: Cancel an existing payin. (Only CREDIT_CARD for the moment)

Request​

Path Parameters

    id stringrequired

    Payin ID.

Query Parameters

    payment_method stringrequired

    Possible values: [CREDIT_CARD]

    Payment Method.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    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​

Payin canceled successfully.

Schema
    id stringrequired

    Payin ID

    status stringrequired

    Possible values: [PENDING, WAITING, WAITING_THREE_DS, AUTHORIZED, EXPIRED, DECLINED, REVERTED, CANCELLATION_IN_PROGRESS, CANCELLED, SETTLED, REFUNDED, FAILED]

    Current payin status

    createdAt date-timerequired

    Payin creation date

    updatedAt date-timerequired

    Payin last update date

Loading...