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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'MakePaymentRequest' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'MakePaymentResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)