--- title: "Create payment request" method: POST path: "/payment/v1/settlement-account-payment-requests" tags: ["Payment.Settlement Accounts"] --- # Create payment request `POST /payment/v1/settlement-account-payment-requests` 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. ## Request body - V1SettlementAccountPaymentRequest — Parameters for the settlement account payment request to be created. - `accountId` string, required — The id of the account to be used for this payment request. - `amount` TypeCurrencyDenominatedAmount, required — The amount with regard to currency and its value should be accurately represent the monetary amount. - `currencyCode` string — The currency code which follows ISO-4217 standard. - `value` TypeExactNumber — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `id` string — The id of the settlement account payment request. Output only. - `market` string, required — The country code (ISO 3166-1 alpha-2) of the market for the payer. - `merchantId` string, required — The id of the merchant to affiliate the payment with. - `metadata` object — 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). - `payeeName` string — Payee name to be used for payment. - `payerName` string — 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. - `reference` string — 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. ## Response `200` A successful response. - V1SettlementAccountPaymentRequest — Parameters for the settlement account payment request to be created. - `accountId` string, required — The id of the account to be used for this payment request. - `amount` TypeCurrencyDenominatedAmount, required — The amount with regard to currency and its value should be accurately represent the monetary amount. - `currencyCode` string — The currency code which follows ISO-4217 standard. - `value` TypeExactNumber — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `id` string — The id of the settlement account payment request. Output only. - `market` string, required — The country code (ISO 3166-1 alpha-2) of the market for the payer. - `merchantId` string, required — The id of the merchant to affiliate the payment with. - `metadata` object — 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). - `payeeName` string — Payee name to be used for payment. - `payerName` string — 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. - `reference` string — 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. ## Other responses - `400` — The request does not pass validation. Check the error message or the documentation of each field for more information. - `401` — The scopes associated with the access token is not allowed the resource. - `403` — The resource does not belong to subject associated with the access token. - `404` — The merchant or the belonging account could not be found. - `default` — An unexpected error response. --- [API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)