Payment Preparation
Validate payment details
Copy
curl --request POST \
--url https://api.paysway.dev/payments/validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"country": "<string>",
"currency": "<string>",
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"creditorAccount": {
"id": {
"value": "<string>",
"type": "IBAN"
},
"type": "<string>"
},
"creditor": {
"name": "<string>",
"address": {
"country": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>",
"department": "<string>",
"streetName": "<string>",
"buildingNumber": "<string>",
"buildingName": "<string>",
"floor": "<string>",
"room": "<string>",
"townName": "<string>",
"townLocationName": "<string>",
"districtName": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"countrySubdivision": "<string>"
},
"contactDetails": {
"email": "<string>",
"phone": "<string>"
},
"dateOfBirth": "2023-12-25",
"taxId": "<string>",
"documents": [
{
"value": "<string>",
"type": "<string>"
}
],
"type": "INDIVIDUAL"
},
"intermediaryAgent1": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent2": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent3": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"settlementInformation": {
"settlementSystem": "SCT"
}
}
'Copy
{
"status": "ALERT",
"alerts": [
{
"code": "CREDITOR_IBAN_INVALID_FORMAT"
}
]
}Payment Preparation
Validate payment details
Accepts the full or partial payment instruction and validates it against local and global payment regulations, scheme requirements, bank reference data, and heuristics. If the payment details in the instruction are likely to be valid, the response will indicate success. If there are issues, the response will include a list of validation errors with specific reasons.
POST
/
payments
/
validations
Validate payment details
Copy
curl --request POST \
--url https://api.paysway.dev/payments/validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"country": "<string>",
"currency": "<string>",
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"creditorAccount": {
"id": {
"value": "<string>",
"type": "IBAN"
},
"type": "<string>"
},
"creditor": {
"name": "<string>",
"address": {
"country": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>",
"department": "<string>",
"streetName": "<string>",
"buildingNumber": "<string>",
"buildingName": "<string>",
"floor": "<string>",
"room": "<string>",
"townName": "<string>",
"townLocationName": "<string>",
"districtName": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"countrySubdivision": "<string>"
},
"contactDetails": {
"email": "<string>",
"phone": "<string>"
},
"dateOfBirth": "2023-12-25",
"taxId": "<string>",
"documents": [
{
"value": "<string>",
"type": "<string>"
}
],
"type": "INDIVIDUAL"
},
"intermediaryAgent1": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent2": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent3": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"settlementInformation": {
"settlementSystem": "SCT"
}
}
'Copy
{
"status": "ALERT",
"alerts": [
{
"code": "CREDITOR_IBAN_INVALID_FORMAT"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
ISO 3166-1 alpha-2 code
ISO 4217 alpha code
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 code
Available options:
INDIVIDUAL, BUSINESS Show child attributes
Show child attributes
Encoded cash settlement system
Available options:
SCT, SCT_INST, SDD_CORE, SDD_B2B, US_FEDWIRE, US_FEDACH, GB_FPS, GB_CHAPS, GB_CCCC, GB_BACS_CR, GB_BACS_DR, CA_ACSS, CA_LYNX, AU_PCS, AU_RITS, AU_BECS, AU_HVCS Response
200 - application/json
Validations result returned successfully
Available options:
OK, ALERT Show child attributes
Show child attributes
Encoded alert reason
Available options:
CREDITOR_IBAN_INVALID_FORMAT, CREDITOR_IBAN_INVALID_COUNTRY_CODE, CREDITOR_IBAN_COUNTRY_NOT_SUPPORTED, CREDITOR_IBAN_INVALID_BBAN_STRUCTURE, CREDITOR_IBAN_INCORRECT_CHECK_DIGITS, CREDITOR_IBAN_COUNTRY_INCONSISTENCY, CREDITOR_IBAN_NO_SSI_FOR_CURRENCY, CREDITOR_BIC_INVALID_FORMAT, CREDITOR_BIC_INVALID_COUNTRY_CODE, CREDITOR_BIC_DOES_NOT_EXIST, CREDITOR_BIC_IBAN_INCONSISTENCY, CREDITOR_BIC_SCHEME_UNSUPPORTED, CREDITOR_BIC_NO_SSI_FOR_CURRENCY, CREDITOR_BIC_COUNTRY_INCONSISTENCY, CREDITOR_BIC_COMPLIANCE_HIT, CREDITOR_BANK_IDENTIFIER_INVALID_FORMAT, CREDITOR_BANK_IDENTIFIER_DOES_NOT_EXIST, CREDITOR_BRANCH_IDENTIFIER_INVALID_FORMAT, CREDITOR_BRANCH_IDENTIFIER_DOES_NOT_EXIST, CREDITOR_ACCOUNT_NUMBER_INVALID_FORMAT, CREDITOR_ACCOUNT_NUMBER_TOO_SHORT, CREDITOR_ACCOUNT_NUMBER_TOO_LONG, CREDITOR_ACCOUNT_NUMBER_INCORRECT_CHECKSUM, CREDITOR_ACCOUNT_NUMBER_INVALID_BANK_IDENTIFIER, CREDITOR_ACCOUNT_ID_EMAIL_INVALID_FORMAT, CREDITOR_ACCOUNT_ID_MSISDN_INVALID_FORMAT, CREDITOR_BANK_IDENTIFIER_ACCOUNT_NUMBER_INCONSISTENCY, CREDITOR_BANK_IDENTIFIER_ACCOUNT_NUMBER_SWAP, CREDITOR_BANK_IDENTIFIER_ACCOUNT_NUMBER_DUPLICATION, CREDITOR_BANK_IDENTIFIER_SCHEME_UNSUPPORTED, INTERMEDIARY_1_INVALID_FORMAT, INTERMEDIARY_1_DOES_NOT_EXIST, INTERMEDIARY_1_NO_SSI, INTERMEDIARY_1_COMPLIANCE_HIT, INTERMEDIARY_2_INVALID_FORMAT, INTERMEDIARY_2_DOES_NOT_EXIST, INTERMEDIARY_2_NO_SSI, INTERMEDIARY_2_COMPLIANCE_HIT, INTERMEDIARY_3_INVALID_FORMAT, INTERMEDIARY_3_DOES_NOT_EXIST, INTERMEDIARY_3_NO_SSI, INTERMEDIARY_3_COMPLIANCE_HIT ⌘I