Create a payment instrument group

post/paymentInstrumentGroups

Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.

Endpoint destination URL
https://balanceplatform-api-test.adyen.com/bcl/v2/paymentInstrumentGroups
Click to copy

Request Parameters

balancePlatformstringRequired

The unique identifier of the balance platform to which the payment instrument group belongs.

descriptionstring
Max length: 300

Your description for the payment instrument group.

propertiesobject

Properties of the payment instrument group.

referencestring
Max length: 150

Your reference for the payment instrument group.

txVariantstringRequired

The tx variant of the payment instrument group.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less