Viviot.Api

<back to all web services

MakePaymentRequest

Requires Authentication
The following routes are available for this service:
POST/mobile/payments/makePaymentSends a payment request to the integrated payment provider.
MakePaymentRequest Parameters:
NameParameterData TypeRequiredDescription
PaymentIdquerystringYesPayment Id (GUID).
PaymentMethodbodyJsonObjectYesContains a custom data in JSON format regarding the selected payment options from the client.
ClientTypequeryClientTypeYesType of client initiating the payment methods request.

Allowable Values

  • IOS
  • Android
  • Web
StorePaymentMethodquerybooleanNoFlag indicating whether the selected payment method should be stored with the payment provider.
ReturnUrlquerystringNoReturn URL which will be triggered afther the payment is made.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ClientType Enum:
NameValue
IOS1
Android2
Web3
MakePaymentResponse Parameters:
NameParameterData TypeRequiredDescription
DataformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /mobile/payments/makePayment HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MakePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Mobile">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <ClientType>IOS</ClientType>
  <PaymentId>00000000-0000-0000-0000-000000000000</PaymentId>
  <PaymentMethod xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </PaymentMethod>
  <ReturnUrl>String</ReturnUrl>
  <StorePaymentMethod>false</StorePaymentMethod>
</MakePaymentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MakePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Mobile">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data>String</Data>
</MakePaymentResponse>