Returns

Make a refund

post

Header parameters

AccessTokenstringRequired

access token

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ProcessorGuidstring · nullableOptional

optional for Non-Profit transactions like donations but required if For-Profit API Partner - Identifies Processor being used by an API Partner

CharityIdstring · nullableOptional

optional - Valid CharityId Guid from Charity Search

OrganizationGuidstring · nullableOptional

internal use - Valid Panorama Organization Guid

IntegrationSourcestring · nullableOptional

internal use - Identifies integrated Product

PaymentGuidstring · nullableOptional

optional if not using PaymentExternalId - Payment API PaymentGuid to be refunded

PaymentExternalIdstring · max: 200 · nullableOptional

optional (max: 200) if not using PaymentGuid - 3rd Party Payment External Id to be refunded

Reasonstring · max: 500Required

required - reason for refund request

Responses

200

Success

application/json

SuccessfulbooleanOptional

"true" if the transaction was processed successfully, and "false" if the transaction was not processed successfully.

Messagestring · nullableOptional

ProcessorMessagestring · nullableOptional

TransactionIdstring · nullableOptional

OriginalTransactionIdstring · nullableOptional

PaymentGuidstring · uuidOptional

PaymentIdinteger · int32Optional

ResponseCodestring · nullableOptional

PaymentResultinteger · enumOptionalPossible values:

ProcessStatusinteger · enumOptionalPossible values:

400

Failure

application/json

post

/api/refund

HTTPcURLJavaScriptPython

POST /api/refund HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 160

{
  "ProcessorGuid": "text",
  "CharityId": "text",
  "OrganizationGuid": "text",
  "IntegrationSource": "text",
  "PaymentGuid": "text",
  "PaymentExternalId": "text",
  "Reason": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "Successful": true,
  "Message": "text",
  "ProcessorMessage": "text",
  "TransactionId": "text",
  "OriginalTransactionId": "text",
  "PaymentGuid": "123e4567-e89b-12d3-a456-426614174000",
  "PaymentId": 1,
  "ResponseCode": "text",
  "PaymentResult": 1,
  "ProcessStatus": 1
}

Make a void

post

Header parameters

AccessTokenstringRequired

access token

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ProcessorGuidstring · nullableOptional

optional for Non-Profit transactions like donations but required if For-Profit API Partner - Identifies Processor being used by an API Partner

CharityIdstring · nullableOptional

optional - Valid CharityId Guid from Charity Search

OrganizationGuidstring · nullableOptional

internal use - Valid Panorama Organization Guid

IntegrationSourcestring · nullableOptional

internal use - Identifies integrated Product

PaymentGuidstring · nullableOptional

optional - if not using PaymentExternalId - Payment API PaymentGuid to be refunded

PaymentExternalIdstring · max: 200 · nullableOptional

optional (max: 200) - if not using PaymentGuid - 3rd Party Payment External Id to be refunded

Reasonstring · max: 500Required

required - reason for void request

Responses

200

Success

application/json

SuccessfulbooleanOptional

"true" if the transaction was processed successfully, and "false" if the transaction was not processed successfully.

Messagestring · nullableOptional

ProcessorMessagestring · nullableOptional

TransactionIdstring · nullableOptional

OriginalTransactionIdstring · nullableOptional

PaymentGuidstring · uuidOptional

PaymentIdinteger · int32Optional

ResponseCodestring · nullableOptional

PaymentResultinteger · enumOptionalPossible values:

ProcessStatusinteger · enumOptionalPossible values:

400

Failure

application/json

post

/api/void

HTTPcURLJavaScriptPython

POST /api/void HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 160

{
  "ProcessorGuid": "text",
  "CharityId": "text",
  "OrganizationGuid": "text",
  "IntegrationSource": "text",
  "PaymentGuid": "text",
  "PaymentExternalId": "text",
  "Reason": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "Successful": true,
  "Message": "text",
  "ProcessorMessage": "text",
  "TransactionId": "text",
  "OriginalTransactionId": "text",
  "PaymentGuid": "123e4567-e89b-12d3-a456-426614174000",
  "PaymentId": 1,
  "ResponseCode": "text",
  "PaymentResult": 1,
  "ProcessStatus": 1
}