Add payment method

POST

Add a new payment method for a membership.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

membershipIdUUIDRequired

Unique identifier for a membership.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.

paymentMethodobjectRequired

The PaymentMethodCreateRequestDTO extends the PaymentMethodDTO and includes additional properties such as the paymentToken and shopperReference. This DTO is used when creating a new payment method.

Response

This endpoint returns an object.

paymentMethodobject

The PaymentMethodCreateResponseDTO extends the PaymentMethodCreateRequestDTO and includes additional property - the payment method ID. This DTO is used when returning results for the payment method create request.

POST

1 curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/paymentmethods \
2      -H "Content-Type: application/json" \
3      -d '{
4   "paymentMethod": {
5     "PANLastDigits": "1234",
6     "PSP": "Adyen",
7     "alias": "",
8     "default": false,
9     "expiryDate": "2029-09-30",
10     "paymentBrand": "visa",
11     "paymentInstrument": "Card",
12     "paymentToken": "FMF7KDR3WL9S2DK5",
13     "shopperReference": "3AE8115C-D7A4-B9FC-4FCA-B09BFD311895",
14     "status": "Active"
15   }
16 }'

200ExamplePaymentMethod

1 {
2   "paymentMethod": {
3     "id": "a7b41af8-d187-48d9-89e0-a57c47039004",
4     "PANLastDigits": "1234",
5     "PSP": "Adyen",
6     "alias": "",
7     "default": false,
8     "expiryDate": "2029-09-30",
9     "paymentBrand": "visa",
10     "paymentInstrument": "Card",
11     "paymentToken": "FMF7KDR3WL9S2DK5",
12     "shopperReference": "3AE8115C-D7A4-B9FC-4FCA-B09BFD311895",
13     "status": "Active"
14   }
15 }

Built with

1	curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/paymentmethods \
2	-H "Content-Type: application/json" \
3	-d '{
4	"paymentMethod": {
5	"PANLastDigits": "1234",
6	"PSP": "Adyen",
7	"alias": "",
8	"default": false,
9	"expiryDate": "2029-09-30",
10	"paymentBrand": "visa",
11	"paymentInstrument": "Card",
12	"paymentToken": "FMF7KDR3WL9S2DK5",
13	"shopperReference": "3AE8115C-D7A4-B9FC-4FCA-B09BFD311895",
14	"status": "Active"
15	}
16	}'

1	{
2	"paymentMethod": {
3	"id": "a7b41af8-d187-48d9-89e0-a57c47039004",
4	"PANLastDigits": "1234",
5	"PSP": "Adyen",
6	"alias": "",
7	"default": false,
8	"expiryDate": "2029-09-30",
9	"paymentBrand": "visa",
10	"paymentInstrument": "Card",
11	"paymentToken": "FMF7KDR3WL9S2DK5",
12	"shopperReference": "3AE8115C-D7A4-B9FC-4FCA-B09BFD311895",
13	"status": "Active"
14	}
15	}