| POST | /mobile/payments/makePayment | Sends a payment request to the integrated payment provider. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentId | query | string | Yes | Payment Id (GUID). |
| PaymentMethod | body | JsonObject | Yes | Contains a custom data in JSON format regarding the selected payment options from the client. |
| ClientType | query | ClientType | Yes | Type of client initiating the payment methods request.Allowable Values
|
| StorePaymentMethod | query | boolean | No | Flag indicating whether the selected payment method should be stored with the payment provider. |
| ReturnUrl | query | string | No | Return URL which will be triggered afther the payment is made. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Value |
|---|---|
| IOS | 1 |
| Android | 2 |
| Web | 3 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
paymentId: 00000000000000000000000000000000,
paymentMethod:
{
String: "String"
},
clientType: 1,
storePaymentMethod: False,
returnUrl: 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
}
}
}