Create a new contract
POST/contracts
Create a new contract
Request
Header Parameters
sub-account stringrequired
Sub-account identifier required for all requests
- application/json
Body
required
contract_type stringrequired
Possible values: [RIBPAY
, VADS
]
Type of contract to be created.
iban stringrequired
IBAN number for the contract.
account_id stringrequired
Unique identifier for the account.
terminal_id string
Unique identifier for the terminal.
Responses
- 201
- 400
Contract created successfully
- application/json
- Schema
- Example (from schema)
Schema
contract_id stringrequired
Unique identifier of the contract
contract_last_modified date-time
Timestamp of the last modification to the contract
contract_type stringrequired
Type of the contract
contract_number stringrequired
Contract number
contract_beneficiary_name stringrequired
Name of the beneficiary of the contract
contract_merchant_id stringrequired
Merchant ID associated with the contract
contract_alias_id stringrequired
Alias ID for the contract
terminal_id string
ID of the terminal associated with the contract
account_id stringrequired
Account ID associated with the contract
creator_id stringrequired
ID of the creator of the contract
{
"contract_id": "be4118e9-a345-42ee-8af4-ea63a45708b7",
"contract_last_modified": "2024-04-24T16:38:37.467Z",
"contract_type": "RIBPAY",
"contract_number": "OXLN_K6CSK68ZZZSK6DZZZSK6DK6CSK68",
"contract_beneficiary_name": "FORTAINE SOFTWARE",
"contract_merchant_id": "99999999-ffff-9999-ffff-999999999999",
"contract_alias_id": "e227c3b0-751e-49ea-b2b8-99b263233b2b",
"terminal_id": null,
"account_id": "efc21e45-79d1-48d8-ac19-ea0ecaef2bc5",
"creator_id": "TestKey1"
}
Bad Request
Loading...