Viviot.Api

<back to all web services

DetailsRequest

Requires Authentication
The following routes are available for this service:
POST/mobile/payments/detailsSends a request to provide payment details to the integrated payment provider.
DetailsRequest Parameters:
NameParameterData TypeRequiredDescription
PaymentIdquerystringYesPayment Id (GUID).
BodybodyDetailsRequestBodyYesContains body data in regard with the payment method selected from the client.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
DetailsRequestBody Parameters:
NameParameterData TypeRequiredDescription
PaymentDataformstringYesContains encrypted payment data in regard with the payment method selected from the client.
DetailsformDictionary<string, string>YesAdditional details.
DetailsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

HTTP + JSV

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

POST /mobile/payments/details HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	paymentId: 00000000000000000000000000000000,
	body: 
	{
		paymentData: String,
		details: 
		{
			String: String
		}
	},
	version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}