POST api/OuterGateMerchantAggregator/payRecurring
Request Information
URI Parameters
None.
Body Parameters
MerchantAggregatorPayRecurringIn| Name | Description | Type | Additional information |
|---|---|---|---|
| amount | decimal number |
Required |
|
| currency | string |
Required Max length: 10 |
|
| contract | string |
Required Max length: 26 |
|
| payer | Payer |
None. |
|
| provider-info | Collection of ProviderInfo |
None. |
|
| description | string |
Max length: 50 |
|
| note | string |
Max length: 500 |
Request Formats
application/json, text/json
Sample:
{
"amount": 1.0,
"currency": "sample string 2",
"contract": "sample string 3",
"payer": {
"name": "sample string 1",
"surname": "sample string 2",
"email": "sample string 3"
},
"provider-info": [
{
"id": 1,
"name": "sample string 2",
"custom-field": [
{
"name": "sample string 1",
"value": null
},
{
"name": "sample string 1",
"value": null
}
]
},
{
"id": 1,
"name": "sample string 2",
"custom-field": [
{
"name": "sample string 1",
"value": null
},
{
"name": "sample string 1",
"value": null
}
]
}
],
"description": "sample string 4",
"note": "sample string 5"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MerchantAggregatorPayRecurringOut| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | LinkToPaymentTransactionStateEnum |
None. |
|
| IdPaymentOrder | string |
None. |
|
| ExternalTransactionID | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 0,
"IdPaymentOrder": "sample string 1",
"ExternalTransactionID": "sample string 2"
}
application/xml, text/xml
Sample:
<MerchantAggregatorPayRecurringOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Buffetti.MerchantAggregator.Api.Dto"> <ExternalTransactionID>sample string 2</ExternalTransactionID> <IdPaymentOrder>sample string 1</IdPaymentOrder> <Status>Unknown</Status> </MerchantAggregatorPayRecurringOut>