Create Merchant Payment Control

POST 
/v1/acquirer/merchants/:merchant_id/payment_controls/:type

Create a payment control scoped to a single merchant.

Required permission: payment_controls_create.

Request

Path Parameters

merchant_id stringrequired

Acquirer-assigned merchant identifier (the merchant_id field of the merchant, not its internal UUID).

type stringrequired

Possible values: [bin_range, bin_country, pan, fingerprint, ip, ip_country, eci, tds_status]

The identifier type of the rules to operate on.

application/json

Body

required

activity stringrequired

Possible values: [allow, deny]

Whether matching payments are allowed or denied.

identifier stringrequired

The value to match, in the format dictated by the rule's identifier type (see the API description table).

Responses

201

The created payment control.

application/json

Schema

Schema

id uuidrequired

A 36-character UUIDv7 identifier.

identifier_type stringrequired

Possible values: [bin_range, bin_country, pan, fingerprint, ip, ip_country, eci, tds_status]

identifier stringrequired
owner_type stringrequired

Possible values: [Acquirer, Merchant]

Whether the rule is acquirer-level or merchant-level.

owner_id uuidrequired

A 36-character UUIDv7 identifier.

activity stringrequired

Possible values: [allow, deny]

created_at date-timerequired

ISO 8601 UTC timestamp with time zone designator.

updated_at date-timerequired

ISO 8601 UTC timestamp with time zone designator.

Example (from schema)

{
  "id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
  "identifier_type": "bin_range",
  "identifier": "SA",
  "owner_type": "Acquirer",
  "owner_id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
  "activity": "allow",
  "created_at": "2025-01-15T14:30:00Z",
  "updated_at": "2025-01-15T14:30:00Z"
}

400

Business rule violation.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Invalid type"
}

401

Authentication failed.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Missing authentication information"
}

403

The API key lacks the required permission.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Unauthorized"
}

404

The referenced resource does not exist or belongs to another acquirer.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "The Order you are looking for was not found."
}

422

Validation error.

application/json

Schema

Schema

message stringrequired

errors

object

required

property name*

string[]

Array [

string

]

Example (from schema)

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "This field is missing."
    ]
  }
}

Loading...