Create Payment Method

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

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
PANLastDigitsstringOptional

The last 4 digits of the payment card number.

PSPenumOptional

The payment service provider of the payment method.

Allowed values:
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.

membershipIdslist of UUIDsOptional

Specifies which membership IDs the payment method should be applied to.

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.

Allowed values:

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.

Allowed values:
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.

Allowed values: