Create Custom Field

post

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/paymentproperty

Create a custom field that appears on payment link checkout pages to collect additional information from payers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

echo

boolean

Defaults to true

If true, the API will echo the full payment resource in the response body

merchantId

int32

required

Defaults to 0

The unique identifier of the merchant. This is required for creating custom fields.

Body Params

{MXG.Core.Structure.Merchant.PaymentProperty}

Represents Payment Properties

name

string

Name of the payment property displayed to the user

fieldDataType

string

enum

Data Type of the value expected for this payment property

Allowed:

options

array of objects

Selectable options when payment property uses a list type

options

required

boolean

Indicates wether this payment property is required

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

201

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Entity

500Internal Server Error

503Service Unavailable