REST Payment Property

List, get, create and update properties and property types.

List properties for a payment

Lists all properties for a payment. The ID of the payment must be specified.

/rest/payments/{paymentId}/properties

Parameters

Field Type Description
itemsPerPage Int The number of items to list per page
page Int The page of results to search for

Success 200

Field Type Description
id Int The ID of the payment property
paymentId Int The ID of the payment
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
value String The value of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List properties

/rest/payments/properties

Parameters

Field Type Description
itemsPerPage Int The number of items to list per page
page Int The page of results to search for

Success 200

Field Type Description
id Int The ID of the payment property
paymentId Int The ID of the payment
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
value String The value of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a payment property

/rest/payments/properties

Request

Field Type Description
paymentId Int The ID of the payment required matching to /^[0-9]+$/
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
required matching to /^[0-9]+$/
value String The value of the property type optional matching to /.{0,255}/
null

Success 200

Field Type Description
id Int The ID of the payment property
paymentId Int The ID of the payment
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
value String The value of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a payment property

/rest/payments/properties

Request

Field Type Description
paymentId Int The ID of the payment required matching to /^[0-9]+$/
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
required matching to /^[0-9]+$/
value String The value of the property type optional matching to /.{0,255}/
null

Success 200

Field Type Description
id Int The ID of the payment property
paymentId Int The ID of the payment
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
value String The value of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a property

Gets a property. The ID of the property must be specified.

/rest/payments/properties/{propertyId}

Success 200

Field Type Description
id Int The ID of the payment property
paymentId Int The ID of the payment
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
value String The value of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a property type

Gets a property type. The ID of the type must be specified.

/rest/payments/properties/types/{typeId}

Success 200

Field Type Description
id Int The ID of the property type
erasable Int Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted.
position Int The position number of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List properties by creation date

Lists all properties by creation date. The start and the end of the date range must be specified.

/rest/payments/properties/date

Parameters

Field Type Description
startDate String The start date of the date range for the date of creation of the property
endDate String The end date of the date range for the date of creation of the property
itemsPerPage Int The number of items to list per page
page Int The page of results to search for

Success 200

Field Type Description
id Int The ID of the payment property
paymentId Int The ID of the payment
typeId Int The ID of the property type. The following property types are available:
  • Transaction ID = 1
  • Reference ID = 2
  • Booking text = 3
  • Transaction password = 4
  • Transaction code = 5
  • Authorisation ID = 6
  • Capture ID = 7
  • Refund ID = 8
  • Credit note ID = 9
  • Order reference = 10
  • Name of the sender = 11
  • Email of the sender = 12
  • The sender's sort code = 13
  • The sender's bank name = 14
  • The sender's bank account number = 15
  • The holder of the bank account = 16
  • The country of the sender's bank account = 17
  • The sender's IBAN = 18
  • The sender's BIC = 19
  • Name of the recipient = 20
  • The recipient's bank account = 21
  • Reference text of the payment = 22
  • Payment origin = 23
  • Shipping address ID = 24
  • Invoice address ID = 25
  • Item buyer = 26
  • Item number = 27
  • Item transaction ID = 28
  • External transaction type = 29
  • External transaction status = 30
  • The receiver's IBAN = 31
  • The receiver's BIC = 32
  • Transaction fee = 33
  • Transaction lifespan = 34
value String The value of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List property types

Lists all property types. The language must be specified.

/rest/payments/properties/types

Parameters

Field Type Description
itemsPerPage Int The number of items to list per page
page Int The page of results to search for

Success 200

Field Type Description
id Int The ID of the property type
erasable Int Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted.
position Int The position number of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a property type

/rest/payments/properties/types

Request

Field Type Description
erasable Int Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted. required matching to /^[1-9]+$/
position Int The position number of the property type optional matching to /^[0-9]+$/
null

Success 200

Field Type Description
id Int The ID of the property type
erasable Int Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted.
position Int The position number of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a property type

/rest/payments/properties/types

Request

Field Type Description
erasable Int Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted. required matching to /^[1-9]+$/
position Int The position number of the property type optional matching to /^[0-9]+$/
null

Success 200

Field Type Description
id Int The ID of the property type
erasable Int Specifies whether the property type can be deleted. Property types that can be deleted have the value 1. Default property types cannot be deleted.
position Int The position number of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List names of property types

/rest/payment/properties/types/names/{lang?}

Parameters

Field Type Description
itemsPerPage Int The number of items to list per page
page Int The page of results to search for

Success 200

Field Type Description
id Int The ID of the name of the property type
typeId Int The ID of the property type
lang String The language of the name of the property type
name String The name of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a name of a property type

Gets a name of a property type. The ID of the name must be specified.

/rest/payment/properties/types/names/{nameId}

Success 200

Field Type Description
id Int The ID of the name of the property type
typeId Int The ID of the property type
lang String The language of the name of the property type
name String The name of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a name of a property type

/rest/payment/properties/types/names

Request

Field Type Description
typeId Int The ID of the property type required matching to /^[0-9]+$/
lang String The language of the name of the property type required matching to /^[A-Z]{2}$/
name String The name of the property type required matching to /^[A-Za-z]{3,255}$/
null

Success 200

Field Type Description
id Int The ID of the name of the property type
typeId Int The ID of the property type
lang String The language of the name of the property type
name String The name of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a name of a property type

/rest/payment/properties/types/names

Request

Field Type Description
typeId Int The ID of the property type required matching to /^[0-9]+$/
lang String The language of the name of the property type required matching to /^[A-Z]{2}$/
name String The name of the property type required matching to /^[A-Za-z]{3,255}$/
null

Success 200

Field Type Description
id Int The ID of the name of the property type
typeId Int The ID of the property type
lang String The language of the name of the property type
name String The name of the property type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!