AccountsPayment Methods

Create Payment Method

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

accountIdUUIDRequired

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
PSPenumRequired
The payment service provider of the payment method.
maskedPANstringRequired
The masked PAN of the card. The exact structure depends on the PSP.
PANLastDigitsstringRequired
The last 4 digits of the payment card number.
paymentTokenstringRequired
The shopper reference of the payment method.
paymentInstrumentstringOptional
The payment method type.
paymentBrandstringOptional
The payment method brand.
expiryDatedateOptional
The expiry date of the card.
aliasstringOptional
A short description that can be assigned to each payment method by the end user.
shopperReferencestringOptional
The shopper reference of the payment method.
membershipIdslist of UUIDsOptional
Specifies which membership IDs the payment method should be applied to.

Response

This endpoint returns an object.
idUUID
Unique identifier for a payment method.
PANLastDigitsstringOptional
The last 4 digits of the payment card number.
PSPenumOptional
The payment service provider of the payment method.
aliasstringOptional
A short description that can be assigned to each payment method by the end user.
defaultbooleanOptional
Indicates whether the payment method should be set up as default.
expiryDatedateOptional
The expiry date of the card.
maskedPANstringOptional
The masked PAN of the card. The exact structure depends on the PSP.
paymentBrandstringOptional
The payment method brand.
paymentInstrumentstringOptional
The payment method type.
paymentTokenstringOptional
The shopper reference of the payment method.
shopperReferencestringOptional
The shopper reference of the payment method.
statusenumOptional
The status of the payment method.