PaymentAPI (open)

Properties

• PROPERTY paymentattribute
• PROPERTY paymentattributeid
• PROPERTY paymenttype
• PROPERTY providerattribute
• PROPERTY providerattributeid
• PROPERTY providertype
• PROPERTY wrdschema

Functions

• MACRO CancelPendingPayment(INTEGER entityid, RECORD options)
• RECORD FUNCTION DescribePaymentMethod(RECORD paymentmethod)
  

  Describe a payment method

• RECORD ARRAY FUNCTION EnrichWithExplainedPayments(RECORD ARRAY payments, RECORD options)
  

  Enrich an array with payment explanations

• RECORD FUNCTION ExplainPayment(RECORD paymentdata)
  

  Explain a payment status

• RECORD FUNCTION ForceRecheckPayment(INTEGER entityid)
• RECORD FUNCTION GetPaymentData(INTEGER entityid)
• RECORD FUNCTION GetReturnInfo(STRING url)
• RECORD ARRAY FUNCTION ListAllPaymentOptions(RECORD options)
  

  List paymnet options

• RECORD ARRAY FUNCTION ListPaymentOptions(INTEGER paymentprovider, RECORD options)
  

  Lists the payment options for a specific payment provider

• RECORD FUNCTION MakePaymentMethod(RECORD paymentdata)
  

  Create a value that can be stored in a PAYMENT value to store the method used to pay, but without actually setting up the PSP

• OBJECT FUNCTION OpenPayment(RECORD paymentdata)
  

  Open a payment object

• MACRO ResetPayment(INTEGER entityid)
  

  Reset a payment. Resetting should be avoided as you lose tracking information for the previous payment. Instead, keep separate entities (eg attachments) for every payment action

• MACRO RunManagePaymentProvidersDialog(OBJECT parent, RECORD options)
• MACRO RunShowPaymentDetailsDialog(OBJECT parent, INTEGER entity, RECORD options)
• MACRO SetPaymentStatus(INTEGER entityid, STRING newstatus, RECORD options)
• RECORD FUNCTION StartPayment(INTEGER entityid, MONEY amount, RECORD paymentdata)
  

  Start a payment