POST api/OuterGateLinkToPayment/payRecurring

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
amount	decimal number	Required
currency	string	Required Max length: 10
contract	string	Required Max length: 26
payer	Payer	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"
  },
  "description": "sample string 4",
  "note": "sample string 5"
}

application/xml, text/xml

Sample:

<OuterLinkToPaymentRecurringIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Plugin.Payments.Services.Models.PIS">
  <Amount>1</Amount>
  <ContractNumber>sample string 3</ContractNumber>
  <Currency>sample string 2</Currency>
  <Description>sample string 4</Description>
  <Note>sample string 5</Note>
  <Payer xmlns:d2p1="http://schemas.datacontract.org/2004/07/tocode.Plugin.Payments.Services.Models.LinkToPayment">
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:Surname>sample string 2</d2p1:Surname>
  </Payer>
</OuterLinkToPaymentRecurringIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterLinkToPaymentRecurringOut

Name	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:

<OuterLinkToPaymentRecurringOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Plugin.Payments.Services.Models.PIS">
  <ExternalTransactionID>sample string 2</ExternalTransactionID>
  <IdPaymentOrder>sample string 1</IdPaymentOrder>
  <Status>Unknown</Status>
</OuterLinkToPaymentRecurringOut>