Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Payment.Settlement Accounts

Create payment request

Creates a payment request and sends the money to a specific settlement account for the specified currency. Note: in order to utilize this endpoint you need to have been onboarded for Settlement Accounts.

post/payment/v1/settlement-account-payment-requests

Request body

accountIdstring required

The id of the account to be used for this payment request.

idstring

The id of the settlement account payment request. Output only.

marketstring required

The country code (ISO 3166-1 alpha-2) of the market for the payer.

merchantIdstring required

The id of the merchant to affiliate the payment with.

metadataobject

A key-value dictionary with custom metadata for the settlement account payment request. All keys and values must be strings. For privacy protection, it is not allowed to use this dictionary for storing personal data (e.g. names and addresses).

payeeNamestring

Payee name to be used for payment.

payerNamestring

START GENAI Payer name to be used for payment verification. This field enables verified payment functionality where the payer's name can be validated against the actual payment sender.

referencestring

Reference of the payment. Optional. The input in the request is up to 10-character long and will be added at the end to Tink generated 8-character long reference to be used as a payment reference. In the response full reference is returned.

scheme'SCHEME_UNSPECIFIED' | 'FASTER_PAYMENTS' | 'SEPA_INSTANT_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER' | 'BACS' | 'CHAPS'

Payment scheme.

  • SCHEME_UNSPECIFIED: Default unspecified scheme.
  • FASTER_PAYMENTS: Faster payments scheme.
  • SEPA_INSTANT_CREDIT_TRANSFER: SEPA Instant Credit Transfer scheme.
  • SEPA_CREDIT_TRANSFER: SEPA Credit Transfer scheme.
  • BACS: BACS scheme.
  • CHAPS: CHAPS scheme.

Example request

{
  "accountId": "744cf927-29cd-475e-9ef2-2b11951d3cc9",
  "amount": {
    "currencyCode": "GBP",
    "value": {
      "scale": "0",
      "unscaledValue": "100"
    }
  },
  "id": "b0223349-65b3-4c8b-b500-74e33f2f643b",
  "market": "GB",
  "merchantId": "2c9ba5fd-cbdb-4ed5-84a4-01db5698f0d9",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "payeeName": "Test AB"
}

Response

A successful response.

accountIdstring required

The id of the account to be used for this payment request.

idstring

The id of the settlement account payment request. Output only.

marketstring required

The country code (ISO 3166-1 alpha-2) of the market for the payer.

merchantIdstring required

The id of the merchant to affiliate the payment with.

metadataobject

A key-value dictionary with custom metadata for the settlement account payment request. All keys and values must be strings. For privacy protection, it is not allowed to use this dictionary for storing personal data (e.g. names and addresses).

payeeNamestring

Payee name to be used for payment.

payerNamestring

START GENAI Payer name to be used for payment verification. This field enables verified payment functionality where the payer's name can be validated against the actual payment sender.

referencestring

Reference of the payment. Optional. The input in the request is up to 10-character long and will be added at the end to Tink generated 8-character long reference to be used as a payment reference. In the response full reference is returned.

scheme'SCHEME_UNSPECIFIED' | 'FASTER_PAYMENTS' | 'SEPA_INSTANT_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER' | 'BACS' | 'CHAPS'

Payment scheme.

  • SCHEME_UNSPECIFIED: Default unspecified scheme.
  • FASTER_PAYMENTS: Faster payments scheme.
  • SEPA_INSTANT_CREDIT_TRANSFER: SEPA Instant Credit Transfer scheme.
  • SEPA_CREDIT_TRANSFER: SEPA Credit Transfer scheme.
  • BACS: BACS scheme.
  • CHAPS: CHAPS scheme.

Example response

{
  "accountId": "744cf927-29cd-475e-9ef2-2b11951d3cc9",
  "amount": {
    "currencyCode": "GBP",
    "value": {
      "scale": "0",
      "unscaledValue": "100"
    }
  },
  "id": "b0223349-65b3-4c8b-b500-74e33f2f643b",
  "market": "GB",
  "merchantId": "2c9ba5fd-cbdb-4ed5-84a4-01db5698f0d9",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "payeeName": "Test AB"
}