--- title: "create a payment" method: POST path: "/v3/payments" tags: ["Merchant Endpoints"] --- # create a payment `POST /v3/payments` This API is intended for merchants initiating payments for specific profiles. Onboarded merchants should have api keys for each profile, the api key will carry the profileId information required to find the correct creditor in the merchant-service The token/api-key necessary to call this endpoint must contain: * `subjectType` : "`INTEGRATOR:{CCV_ID}`" or "`MERCHANT:{ID}`" * `resource`: "`PAYMENTPROFILE:{profileId}`", * `authority`: `MERCHANT_PAYMENT` ## Request body - PaymentCreateRequest — Request to initiate/create a payment as a Merchant - `reference` string — Merchant payment reference, used to reference the Bancontact Company payment in the merchant's system. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). - `bulkId` string — Field used to reference a bulk batch, so the merchant can inform how the payments should be bulked. If it's not set here it will default to the one configured in the profile. - `amount` integer, required — Amount in cents requested - `currency` 'EUR' — Currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) - `description` string — Description of the payment that will be shown to the debtor, also used in the bank statement for reconciliation purposes. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). - `identifyCallbackUrl` string — Callback url to which merchants will be notified about the payment identification. If it's not set here it will default to the one configured in the profile - `callbackUrl` string — callbackUrl to which the merchant will be notified about the payment payout. If it's not set here it will default to the one set in the profile - `returnUrl` string — Merchant return url to which the dynamic payment page will redirect after the payment is completed - `voucherEligibility` VoucherEligibleAmount[] — List of Value Added Services (vouchers) eligible amounts within the payment - `voucherSchemes` VoucherScheme[], required — List of voucher schemes could be used to pay the amount - `amount` integer, required — Amount in cents eligible for payment with voucher. EUR 10.13 will be 1013 ## Response `201` Payment has been created successfully - PaymentCreateResponse — Object returned if the payment gets successfully created - `paymentId` string, required — Payment ID - `status` 'PENDING', required — the status of the payment created - `createdAt` string, date-time, required — the creation time of the payment - `expiresAt` string, date-time, required — the time from which the payment will be expired - `description` string — Description of the payment that will be shown to the debtor, also used in the bank statement for reconciliation purposes. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). Only first 35 characters will be used for the remittance info - `reference` string — Merchant payment reference, used to reference the Bancontact Company payment in the merchant's system. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). - `amount` integer, required — Amount in cents requested - `currency` 'EUR', required — Currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) - `creditor` PaymentCreditorResponse, required — Creditor account set to receive the payment - `profileId` string — The configuration ID of the Merchant - `merchantId` string — the Id of the merchant - `name` string — Merchant's company name that will be shown to the debtor - `iban` string — Creditor's Bank Account Iban to where the money will be sent to for this current payment - `identifyCallbackUrl` string — callbackUrl to which the merchant will be notified about the payment identification - `callbackUrl` string — callbackUrl to which the merchant will be notified about the payment payout - `_links` Links, required — Provides information to navigate to our REST interfaces dynamically, by including hypermedia links to them. Note that for some links inclusion depends on the status of the payment (e.g. cancel link will be available on PENDING and refund on SUCCEEDED) - `self` Link, required - `href` string, required - `deeplink` Link, required - `href` string, required - `qrcode` Link, required - `href` string, required - `cancel` Link - `href` string, required - `refund` Link - `href` string, required - `checkout` Link - `href` string, required ## Other responses - `400` — **Error Codes** * `BODY_MISSING`: A json needs to be provided * `FIELD_IS_REQUIRED`: Field X is mandatory * `FIELD_IS_INVALID`: Field X is invalid - `401` — **Error Codes** * `UNAUTHORIZED`: user doesn’t have an access token - `403` — **Error Codes** * `ACCESS_DENIED`: The JWT could not be verified (different format) - The JWT doesn’t contain the required authority to access the resource requested - `404` — **Error Codes** * `MERCHANT_PROFILE_NOT_FOUND`: The merchant profile does not exist - `422` — **Error Codes** * `UNABLE_TO_PAY_CREDITOR`: Variable reason(Depends on automatic processing). - `429` — **Error Codes** - `500` — **Error Codes** * `TECHNICAL_ERROR`: Technical error in Payment service - `503` — **Error Codes** * `TRY_AGAIN_LATER`: one of the internal services is unavailable --- [API](https://skmtc.net/bancontactpro/apis/payment-v3-api.md) · [All operations](https://skmtc.net/bancontactpro/apis/payment-v3-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bancontactpro/payment-v3-api/versions/4093d799b771/schema)