Skip to main content

Payment Request Cancellation​

Payment Request Cancellations are handled via RTP API using header application/vnd.gini.v1+json. You can use this endpoint on any step of the flow to cancel any processing Payment request. If payment request is already on success or failure state, an error will be thrown.

Path Parameters
    paymentRequestId string required

    Payment Request ID from the Payment Request to be cancelled

Responses

Payment request successfully cancelled

Schema
    id string

    The id of the payment request

    iban string

    The iban (international bank account number) of the payment recipient

    recipient string

    Name of the recipient of the payment

    address string

    Address of the recipient of the payment

    amount number

    The amount in Euros (EUR) of the payment

    paymentProvider string

    The id of the target payment provider. Used for security reasons.

    purpose string

    The purpose of the payment, e.g. the invoice or the customer identifier. Used to match Gini's RTP payment with your transaction in the future.

    requesterUri string

    The uri of the business SDK app for returning after successful payment. Contains the payment request id as parameter. This is going to be used by you in case of an App-to-App integration.

    rtpBankUri string

    The uri of the bank app selected by the customer for opening the App via deeplink.

    createdAt string

    ISO Date String for the RTP Request payment creation

    expirationDate string

    Expiry Date/Time of the RTP. Beyond this date/time the RTP becomes void.

    status string

    Status depending on the comparison of the payment request with the actual payment can be "created", "scanned", "paid" or "invalid". By created means that the payment flow has been initiated; by scanned it means the RTP payment has already started (you can probably show a loader); paid means the RTP request have successfully finished and invalid any other refusal/denial of the payment.

Loading...