search

Preview

createRefundPayment is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

createRefundPayment

Create a refund payment for an intent, e.g. USER, COMPANY, INVOICE

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    ROLE_PARTNER

    Arguments

    input CreateRefundPaymentInput! PREVIEW

    CreateRefundPaymentInput fields

    originalPaymentId ID!

    Intents for which payment is being made, Intent can be USER/COMPANY/INVOICE

    flowType FlowType! PREVIEW

    Information about from where payment is being initiated

    intent RefundIntent! PREVIEW

    Refund intent for which payment is being made

    source PaymentSource! PREVIEW

    Payment Source for payment

    userId ID!

    Target user's id for which payment is being made

    accountId ID!

    Target account's id for which payment is being made

    merchantOfRecordType String!

    Merchant of record type, e.g. TENANT, RESELLER etc

    isRefundProcessedOffPlatform Boolean!

    Refund is processed off platform

    refundReason String!

    Refund Reason

    properties [PropertyInput] PREVIEW

    Payment additional properties

    Return Fields

    payment Payment PREVIEW
    userErrors [CreatePaymentError!] PREVIEW

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.