POST api/OuterGateLinkToPayment/order

Request a link to pay

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
amount	decimal number	Required
currency	string	Required Max length: 10
type-generation	string	Required Max length: 5
payment-types	Collection of TypeOfPayments	Required
provider-info	Collection of ProviderInfo	None.
callback	Callback	Required
payer	Payer	None.
contract	NexiContract	None.
pis-type	TypeOfPis	None.
creditor-iban	string	Max length: 100
creditor-name	string	Max length: 100
creditor-country	string	Max length: 2 Min length: 2
debtor-iban	string	Max length: 100
pis-instrument	TypeOfInstrument	None.

Request Formats

application/json, text/json

Sample:

{
  "amount": 1.0,
  "currency": "sample string 2",
  "type-generation": "sample string 3",
  "payment-types": [
    0,
    0
  ],
  "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
        }
      ]
    }
  ],
  "callback": {
    "success": "sample string 1",
    "failure": "sample string 2",
    "cancel": "sample string 3"
  },
  "payer": {
    "name": "sample string 1",
    "surname": "sample string 2",
    "email": "sample string 3"
  },
  "contract": {
    "number": "sample string 1",
    "type": 0,
    "user-id": "sample string 2",
    "renewal": true
  },
  "pis-type": 0,
  "creditor-iban": "sample string 4",
  "creditor-name": "sample string 5",
  "creditor-country": "sample string 6",
  "debtor-iban": "sample string 7",
  "pis-instrument": 0
}

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

OuterLinkToPaymentOrderOut

Name	Type	Additional information
date	date time	None.
status	string	None.
transaction-id	string	None.
url	string	None.

Response Formats

application/json, text/json

Sample:

{
  "date": "2025-05-14T03:11:11.2949557+02:00",
  "status": "sample string 2",
  "transaction-id": "sample string 3",
  "url": "sample string 4"
}

application/xml, text/xml

Sample:

<OuterLinkToPaymentOrderOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Plugin.Payments.Services.Models.LinkToPayment">
  <Date>2025-05-14T03:11:11.2949557+02:00</Date>
  <Status>sample string 2</Status>
  <Transactionid>sample string 3</Transactionid>
  <Url>sample string 4</Url>
</OuterLinkToPaymentOrderOut>