Constraints
Get Payment Constraints Rules
Retrieve institution specific constraints for payment authorisation and submission requests
get/institutions/constraints/payments
Request
- Base URLhttps://api.yapily.com
- AuthHTTP basic
Query parameters
institutionIdsstring[] required
Unique Id(s) of the Institution(s) to retrieve the Payment Constraints for. Multiple institutionIds need to be separated by ,
institutionCountryCodestring required
Country code of the Institution(s). Ensure that the country code matches the respective institutionIds; any mismatch will result in an HTTP 404 error response.
paymentType'DOMESTIC_PAYMENT' | 'DOMESTIC_INSTANT_PAYMENT' | 'DOMESTIC_VARIABLE_RECURRING_PAYMENT' | 'DOMESTIC_SCHEDULED_PAYMENT' | 'DOMESTIC_PERIODIC_PAYMENT' | 'INTERNATIONAL_PAYMENT' | 'INTERNATIONAL_SCHEDULED_PAYMENT' | 'INTERNATIONAL_PERIODIC_PAYMENT' required
Type of payment to retrieve payment constraints for
endpointPathstring
The path on the API that is associated with the operation for which constraints are to be retrieved
endpointMethod'POST' | 'PATCH' | 'PUT' | 'GET' | 'DELETE'
The HTTP method that is associated with the operation for which constraints are to be retrieved
Response
Ok
Example response
{
"meta": {
"tracingId": "661471ddb4344113a2d185b861cb3dcf"
},
"data": [
{
"institutionId": "mock-sandbox",
"institutionCountryCode": "GB",
"endpointPath": "/payments",
"endpointMethod": "POST",
"paymentType": "DOMESTIC_PAYMENT",
"request": {
"headers": {
"title": "Header",
"type": "object",
"properties": {
"psuID": {
"title": "PSU Id",
"type": "string",
"description": ""
}
}
},
"body": {
"title": "Payment Request",
"required": [
"payee",
"amount",
"paymentIdempotencyId",
"type"
],
"type": "object",
"properties": {
"paymentIdempotencyId": {
"title": "Payment Idempotency Id",
"pattern": "^.{1,35}$",
"type": "string",
"description": "Id for the payment"
},
"type": {
"enum": [
"DOMESTIC_PAYMENT"
],
"title": "Payment Type",
"type": "string",
"description": "type of the payment"
},
"contextType": {
"default": "OTHER",
"enum": [
"BILL",
"GOODS",
"SERVICES",
"OTHER",
"PERSON_TO_PERSON"
],
"title": "Context Type",
"type": "string",
"description": "__Optional__. The payment context code. This defaults to `OTHER` if not specified."
},
"reference": {
"title": "Reference",
"pattern": "^.{1,18}$",
"type": "string",
"description": "__Mandatory__. The payment reference or description. Limited to a maximum of 18 characters long.",
"example": "Bill payment"
},
"payee": {
"title": "Payee",
"required": [
"accountIdentifications",
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"pattern": "^.{1,18}$",
"type": "string",
"description": "__Mandatory__. The account holder name of the beneficiary.",
"example": "Jane Doe"
},
"accountIdentifications": {
"title": "Account Identifications",
"type": "array",
"items": {
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Used to describe the format of the account.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type."
},
"identification": {
"title": "Account Identification",
"type": "string",
"description": "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values."
}
}
},
"description": "__Mandatory__. The account identifications that identify the `Payee` bank account."
},
"address": {
"title": "Address",
"type": "object",
"properties": {
"addressLines": {
"title": "Address Lines",
"type": "array",
"items": {
"title": "Address Line",
"type": "string"
},
"description": "__Optional__. The address line of the address"
},
"streetName": {
"title": "Street Name",
"type": "string",
"description": "__Optional__. The street name of the address"
},
"buildingNumber": {
"title": "Building Number",
"type": "string",
"description": "__Optional__. The building number of the address"
},
"postCode": {
"title": "Postcode",
"type": "string",
"description": "__Optional__. The post code of the address"
},
"townName": {
"title": "Town",
"type": "string",
"description": "__Optional__. The town name of the address"
},
"county": {
"title": "County",
"type": "array",
"items": {
"type": "string"
},
"description": "__Optional__. The list of counties for the address"
},
"country": {
"title": "Country",
"type": "string",
"description": "__Conditional__. The 2-letter country code for the address. \n\nAn `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment"
},
"department": {
"title": "Department",
"type": "string",
"description": "__Optional__. The department for the address"
},
"subDepartment": {
"title": "Sub-department",
"type": "string",
"description": "__Optional__. The sub-department for the address"
},
"addressType": {
"enum": [
"BUSINESS",
"CORRESPONDENCE",
"DELIVERY_TO",
"MAIL_TO",
"PO_BOX",
"POSTAL",
"RESIDENTIAL",
"STATEMENT",
"UNKNOWN"
],
"title": "Address Type",
"type": "string",
"description": "__Optional__. The type of address"
}
},
"description": "__Conditional__. The address of the `Payee` or `Payer`."
}
},
"description": "__Mandatory__. Details of the beneficiary [person or business]."
},
"payer": {
"title": "Payer",
"required": [
"accountIdentifications"
],
"type": "object",
"properties": {
"accountIdentifications": {
"title": "Account Identifications",
"type": "array",
"items": {
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"enum": [
"IBAN"
],
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Should be IBAN only."
},
"identification": {
"title": "Account Identification",
"pattern": "DE\\d{20}",
"type": "string",
"description": "__Mandatory__. The IBAN value associated with the account identity"
}
}
},
"description": "__Mandatory__. The account identifications that identify the `Payer` bank account."
},
"address": {
"title": "Address",
"type": "object",
"properties": {
"addressLines": {
"title": "Address Lines",
"type": "array",
"items": {
"title": "Address Line",
"type": "string"
},
"description": "__Optional__. The address line of the address"
},
"streetName": {
"title": "Street Name",
"type": "string",
"description": "__Optional__. The street name of the address"
},
"buildingNumber": {
"title": "Building Number",
"type": "string",
"description": "__Optional__. The building number of the address"
},
"postCode": {
"title": "Postcode",
"type": "string",
"description": "__Optional__. The post code of the address"
},
"townName": {
"title": "Town",
"type": "string",
"description": "__Optional__. The town name of the address"
},
"county": {
"title": "County",
"type": "array",
"items": {
"type": "string"
},
"description": "__Optional__. The list of counties for the address"
},
"country": {
"title": "Country",
"type": "string",
"description": "__Conditional__. The 2-letter country code for the address. \n\nAn `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment"
},
"department": {
"title": "Department",
"type": "string",
"description": "__Optional__. The department for the address"
},
"subDepartment": {
"title": "Sub-department",
"type": "string",
"description": "__Optional__. The sub-department for the address"
},
"addressType": {
"enum": [
"BUSINESS",
"CORRESPONDENCE",
"DELIVERY_TO",
"MAIL_TO",
"PO_BOX",
"POSTAL",
"RESIDENTIAL",
"STATEMENT",
"UNKNOWN"
],
"title": "Address Type",
"type": "string",
"description": "__Optional__. The type of address"
}
},
"description": "__Conditional__. The address of the `Payee` or `Payer`."
}
}
},
"amount": {
"title": "Amount",
"required": [
"amount",
"currency"
],
"type": "object",
"properties": {
"amount": {
"title": "Amount",
"minimum": 0,
"type": "number",
"description": "__Mandatory__. The monetary value"
},
"currency": {
"title": "Currency",
"pattern": "^[A-Z]{3,3}$",
"type": "string",
"description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code"
}
},
"description": "__Mandatory__. Monetary Amount."
},
"paymentDateTime": {
"type": "string",
"description": "__Optional__, If present date should be greater than or equal to current date",
"format": "date-time"
}
},
"description": "Domestic payment request schema"
}
}
}
]
}Changes
No recorded changes to this operation across all 4 revisions of this API.