AccountsPayment Methods

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.
PSPenumRequired
The payment service provider of the payment method.
Allowed values:
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.
PANLastDigitsstring or null
The last 4 digits of the payment card number.
PSPenum or null
The payment service provider of the payment method.
Allowed values:
aliasstring or null
A short description that can be assigned to each payment method by the end user.
defaultboolean or null
Indicates whether the payment method should be set up as default.
expiryDatedate or null
The expiry date of the card.
maskedPANstring or null
The masked PAN of the card. The exact structure depends on the PSP.
paymentBrandstring or null
The payment method brand.
paymentInstrumentstring or null
The payment method type.
paymentTokenstring or null
The shopper reference of the payment method.
shopperReferencestring or null
The shopper reference of the payment method.
statusenum or null
The status of the payment method.
Allowed values: