GetCompletedPaymentForm: Get details of a completed payment form

This function allows you to retreive the status of a "completed (or filled) payment form"

Scenario

  • Using the CreatePaymentForm function, you (WHITE BRAND) had generated a re-usable Payment Form (with the form Id is for example 579c7def4bb0411da294d9b57c2c1323)
  • Some clients filled the form and make payment.
  • Each time a client completes the form and click on the "Accept and Pay" button, LemonWay will store the completed form and generate a new id for it, for example 7e98be392a5e45f6bc357a9ab8c623d2
  • The initial status of the "completed form" is PENDING. When client finish the payment process, it will switch to PAID. It could also switch to CANCEL or ERROR..

In this example, the completed form 7e98.. was created from the parent form 579c.. The form 579c.. is reusable, which means it can be completed several time by different clients, so it could have many completed version.

This function allows you to retreive the status of a the filled form via its id (7e98..).

Request

<GetCompletedPaymentForm xmlns="Service_mb">
  <wlLogin>string</wlLogin>
  <wlPass>string</wlPass>
  <language>string</language>
  <version>string</version>
  <walletIp>string</walletIp>
  <walletUa>string</walletUa>
  <formId>string</formId>  
</GetCompletedPaymentForm>

{

    "wlLogin": "string",
    "wlPass": "string",
    "language": "string",
    "version": "string",
    "walletIp": "string",
    "walletUa": "string",
    "formId": "string",
}

Element

Description

Mandatory

Format

Example

formId

Filled form Id

yes

32

7e98be392a5e45f6bc357a9ab8c623d2

Response

<SetPaymentFormStatusResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="Service_mb_xml">

     <form>
         <id>string</id>
         <optId>string</optId>
         <parentId>string</parentId>
         <parentComment>string</parentComment>
         <walletPayer>string</walletPayer>
         <walletReceiver>string</walletReceiver>
         <amountTot>string</amountTot>
         <comment>string</comment>
         <firstNamePayer>string</firstNamePayer>
         <lastNamePayer>string</lastNamePayer>
         <emailPayer>string</emailPayer>
         <status>PENDING | PAID | ERROR | CANCEL</status>
         <utcdate>2016-09-20 14:58:09Z</utcdate>
         <created>2016-09-19 15:09:12Z</created>
         <returnUrl>string</returnUrl>
         <cancelUrl>string</cancelUrl>
         <errorUrl>string</errorUrl>
     </form>
</SetPaymentFormStatusResult>

{
    "form": {
        "id": string,

        "optId": string,
        "parentId": string,
        "parentComment": string,
        "walletPayer": string,
        "walletReceiver": string,
        "amountTot": string,
        "comment": string,
        "firstNamePayer": string,
        "lastNamePayer": string,
        "emailPayer": string,
        "status": "PENDING | PAID | ERROR | CANCEL",
        "utcdate": string,
        "created": string,
        "returnUrl": string,
        "cancelUrl": string,
        "errorUrl": string,
    }

}

In the response:

  • id is the id of the completed form (7e98.. in our example)
  • parentId is the id of the configuration form which you created with the CreatePaymentForm function (579c.. in our example)