Payment API

Charge Attempt

API Documentation

Senest redigeret:

Introduction

A Payment and its corresponding Transaction can have one or more Charge Attempts. The Charge Attempt collects information about the result directly from the payment gateway and provides details about the final state of the Payment (Rejected, Charged, Failed, etc.). OnlineFundraising always interprets responses and error responses but the raw response is stored as well. This is particularly useful for the purpose of troubleshooting.

Schema

Property
Format and Description
transactionGuid
string <uuid>

Unique Guid

createdTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of creation

paymentGuid
string <uuid>

Unique Guid

paymentMethodGuid
string <uuid>

Unique Guid

paymentGatewayProvider
string

Payment gateway provider

Enum: "ePay", "MobilePaySubscription", "Betalingsservice", "Test", "QuickPay"
paymentGatewayGuid
string <uuid>

Unique Guid

paymentGatewaySubscriptionReferenceId string

Subscription token in Payment Gateway

paymentGatewayPaymentReferenceId string

Payment token in Payment Gateway

state string

Current state of Charge Attempt

attemptTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of attempt

chargedTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of charge

failedTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of failure

rejectedTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of rejection

cancelledTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of cancellation

expiredTs
string <yyyy-MM-dd HH:mm:ss zzzz>

Timestamp of expiration

gatewayErrorCode string

Error code from Payment Gateway

gatewayErrorDescription string

Error description from Payment Gateway

rawErrorString string

Uninterpreted error response provided by Payment Gateway