POST api/PaymentProcessor/ProcessPayment
Request Information
URI Parameters
None.
Body Parameters
BankPaymentViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SingleUseTokenId | string |
None. |
|
| MerchantId | string |
None. |
|
| BankAccountId | string |
None. |
|
| CustomerNumber | string |
None. |
|
| TransactionType | string |
None. |
|
| PrincipalAmount | decimal number |
None. |
|
| Currency | string |
None. |
|
| OrderNumber | string |
None. |
|
| InvoiceNumber | string |
None. |
|
| CustomerIpAddress | string |
None. |
|
| IdempotencyKey | globally unique identifier |
None. |
|
| Fullname | string |
None. |
|
| string |
None. |
||
| paymentType | string |
None. |
|
| TransactionRemarks | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"singleUseTokenId": "sample string 1",
"merchantId": "sample string 2",
"bankAccountId": "sample string 3",
"customerNumber": "sample string 4",
"transactionType": "sample string 5",
"principalAmount": 6.0,
"currency": "sample string 7",
"orderNumber": "sample string 8",
"invoiceNumber": "sample string 9",
"customerIpAddress": "sample string 10",
"idempotencyKey": "19b90379-d57c-42fb-96cc-c28423057a55",
"fullname": "sample string 12",
"email": "sample string 13",
"paymentType": "sample string 14",
"transactionRemarks": "sample string 15"
}
application/xml, text/xml
Sample:
<BankPaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels"> <BankAccountId>sample string 3</BankAccountId> <Currency>sample string 7</Currency> <CustomerIpAddress>sample string 10</CustomerIpAddress> <CustomerNumber>sample string 4</CustomerNumber> <Email>sample string 13</Email> <Fullname>sample string 12</Fullname> <IdempotencyKey>19b90379-d57c-42fb-96cc-c28423057a55</IdempotencyKey> <InvoiceNumber>sample string 9</InvoiceNumber> <MerchantId>sample string 2</MerchantId> <OrderNumber>sample string 8</OrderNumber> <PrincipalAmount>6</PrincipalAmount> <SingleUseTokenId>sample string 1</SingleUseTokenId> <TransactionRemarks>sample string 15</TransactionRemarks> <TransactionType>sample string 5</TransactionType> <paymentType>sample string 14</paymentType> </BankPaymentViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TransactionViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderNumber | string |
None. |
|
| Status | string |
None. |
|
| ResponseCode | string |
None. |
|
| paywayResponseCode | string |
None. |
|
| ResponseText | string |
None. |
|
| IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"orderNumber": "sample string 1",
"status": "sample string 2",
"responseCode": "sample string 3",
"paywayResponseCode": "sample string 4",
"responseText": "sample string 5",
"isSuccessStatusCode": true
}
application/xml, text/xml
Sample:
<TransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels"> <IsSuccessStatusCode>true</IsSuccessStatusCode> <OrderNumber>sample string 1</OrderNumber> <ResponseCode>sample string 3</ResponseCode> <ResponseText>sample string 5</ResponseText> <Status>sample string 2</Status> <paywayResponseCode>sample string 4</paywayResponseCode> </TransactionViewModel>