Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Payment.Payment Request

Create payment request

Create a payment request with the given values. This endpoint returns an id which can be used with Tink Link to create a full payment journey for an end user.

post/api/v1/payments/requests

Request body

amountnumber required

The IS0 4217 payment amount.

currencystring required

The IS0 4217 currency code of the payment.

executionDatestring

The ISO 8601 date when the bank should execute the payment. If no date is provided, the payment will be executed as soon as possible. This feature’s availability depends on the market. Check availability in market-specific information or reach out to our support team for more details.

market'AT' | 'CZ' | 'DE' | 'DK' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'IT' | 'LT' | 'LV' | 'NL' | 'NO' | 'PL' | 'PT' | 'SE' required

The IS0 3166-1 alpha-2 country code.

merchantIdstring

Id of the merchant to affiliate with this payment request.

metadataobject

Custom metadata for the payment request. Keys and values must be strings. For privacy protection, you may not store personal data (e.g., names and addresses) in metadata.

paymentScheme'DANISH_DOMESTIC_CREDIT_TRANSFER' | 'FASTER_PAYMENTS' | 'INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_INTRADAG' | 'INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_STRAKS' | 'INSTANT_NORWEGIAN_DOMESTIC_CREDIT_TRANSFER_STRAKS' | 'INSTANT_POLISH_DOMESTIC_CREDIT_TRANSFER' | 'MULTIBANCO_SERVICE' | 'NORWEGIAN_DOMESTIC_CREDIT_TRANSFER' | 'POLISH_DOMESTIC_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER' | 'SEPA_INSTANT_CREDIT_TRANSFER' | 'SWISS_DOMESTIC_CREDIT_TRANSFER'

The payment scheme identifier.

recipientNamestring required

The recipient name shown to the payer on signing payments. Maximum character count of 30. Special characters such as á, ã or ç can be used.

sourceMessagestring

A description of the transaction that appears on the payer’s account. Supported only in Sweden (SE). Maximum 50 characters, though some banks may require fewer.

Example request

{
  "amount": 10,
  "currency": "GBP",
  "destinations": [
    {
      "accountNumber": "31245678901234",
      "type": "sort-code"
    }
  ],
  "executionDate": "2023-11-20",
  "merchantId": "c7f2de71-ad83-4eb7-b7df-5ed6445cb2af",
  "metadata": {
    "custom key": "custom value",
    "merchantReference": "17172137"
  },
  "recipientName": "Test AB",
  "remittanceInformation": {
    "type": "UNSTRUCTURED"
  },
  "sourceMessage": "Gym Equipment",
  "userConsent": {
    "consentCaptured": true,
    "consentText": "I agree to the Terms of Service and Privacy Notice."
  }
}

Response

The payment request was created.