refundExecutionCredit

Refund a debited execution credit transaction for a control sync status

refundExecutionCredit(
  input: RefundExecutionCreditInput!
): RefundExecutionCreditPayload

Arguments

refundExecutionCredit.input ● RefundExecutionCreditInput! non-null input

Parameters for RefundExecutionCredit

Type

RefundExecutionCreditPayload object

Autogenerated return type of RefundExecutionCredit.

Example request

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the executionCredits query first and use data.executionCredits.collection[].id as executionCreditId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateRefundExecutionCredit($input: RefundExecutionCreditInput!) {\n  refundExecutionCredit(input: $input) { clientMutationId errors executionCreditTransaction { id createdAt credits } }\n}","variables":{"input":{"executionCreditId":"<execution_credit_id>","entityId":"<entity_id>","entityType":"CONTROL_SYNC_STATUS"}}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "mutation MutateRefundExecutionCredit($input: RefundExecutionCreditInput!) {\n  refundExecutionCredit(input: $input) { clientMutationId errors executionCreditTransaction { id createdAt credits } }\n}",
    variables: {
    "input": {
        "executionCreditId": "<execution_credit_id>",
        "entityId": "<entity_id>",
        "entityType": "CONTROL_SYNC_STATUS"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "mutation MutateRefundExecutionCredit($input: RefundExecutionCreditInput!) {\n  refundExecutionCredit(input: $input) { clientMutationId errors executionCreditTransaction { id createdAt credits } }\n}",
        'variables': json.loads("{\"input\":{\"executionCreditId\":\"<execution_credit_id>\",\"entityId\":\"<entity_id>\",\"entityType\":\"CONTROL_SYNC_STATUS\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])