When submitting a request with the Authorized Payment Protection API, certain parameters are required to avoid errors or false positives. Adding optional parameters provides greater accuracy when analyzing transfers.
The following table identifies required and optional parameters for each transfer type.
|
Property |
Person to Person (P2P) Transfer |
Person to Business (P2B) Transfer |
Business to Person (B2P) Transfer |
Business to Business (B2B) Transfer |
|
eventTransactionId |
Required |
Required |
Required |
Required |
|
sessionId |
Required |
Required |
Required |
Required |
|
eventTypeName |
Optional |
Optional |
Optional |
Optional |
|
eventTimestamp |
Required |
Required |
Required |
Required |
|
paymentTransfer.amount |
Required |
Required |
Required |
Required |
|
paymentTransfer.currencyCode |
Required |
Required |
Required |
Required |
|
paymentTransfer.originatingCountry |
Required |
Required |
Required |
Required |
|
paymentTransfer.transactionType |
Required |
Required |
Required |
Required |
|
paymentTransfer.transactionReference |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
paymentTransfer.originatingIpAddress |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
originAccount (object) |
||||
|
bankInformation.countryCode |
Required |
Required |
Required |
Required |
|
bankInformation.localBankCode |
Required |
Required |
Required |
Required |
|
bankInformation.bankName |
Required |
Required |
Required |
Required |
|
bankInformation.localBranchCode |
Recommended |
Recommended |
Recommended |
Recommended |
|
bankInformation.swiftCode |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountInformation.accountType |
Required |
Required |
Required |
Required |
|
accountInformation.accountSubType |
Optional |
Optional |
Optional |
Optional |
|
accountInformation.accountStatus |
Optional |
Optional |
Optional |
Optional |
|
accountInformation.openingDate |
Highly Recommended |
Highly Recommended |
Highly Recommended |
Highly Recommended |
|
accountInformation.accountNumber |
Required |
Required |
Required |
Required |
|
accountInformation.iban |
Optional |
Optional |
Optional |
Optional |
|
accountHolder.customerId |
Required |
Required |
Required |
Required |
|
accountHolder.nationality |
Required |
Required |
Required |
Required |
|
accountHolder.person.name.first |
Required |
Required |
Required |
Required |
|
accountHolder.person.name.preferred |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.name.family |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.name.middle |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.name.prefix |
Optional |
Optional |
Optional |
Optional |
|
accountHolder.person.name.suffix |
Optional |
Optional |
Optional |
Optional |
|
accountHolder.person.phoneNumber |
Required |
Required |
Required |
Required |
|
accountHolder.person.emailAddress |
Required |
Required |
Required |
Required |
|
accountHolder.person.address |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.address.line1 |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.address.line2 |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.address.city |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.address.region |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.address.countryCode |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.address.postalCode |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.person.dateOfBirth |
Optional |
Optional |
Optional |
Optional |
|
accountHolder.governmentIds.idType |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.governmentIds.idNumber |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.governmentIds.idExpiryDate |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountHolder.businessIdNumber |
No |
No |
Required |
Required |
|
accountHolder.businessName |
No |
No |
Required |
Required |
|
accountHolder.businessOpeningDate |
Optional |
Recommended |
Recommended |
Recommended |
|
destinationAccount (object) |
||||
|
bankInformation (object) |
||||
|
bankInformation.countryCode |
Required |
Required |
Required |
Required |
|
bankInformation.localBankCode |
Required |
Required |
Required |
Required |
|
bankInformation.bankName |
Required |
Required |
Required |
Required |
|
bankInformation.localBranchCode |
Recommended |
Recommended |
Recommended |
Recommended |
|
bankInformation.swiftCode |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountInformation (object) |
||||
|
accountInformation.accountType |
Required |
Required |
Required |
Required |
|
accountInformation.accountSubType |
Optional |
Optional |
Optional |
Optional |
|
accountInformation.accountStatus |
Optional |
Optional |
Optional |
Optional |
|
accountInformation.openingDate |
Highly Recommended |
Highly Recommended |
Highly Recommended |
Highly Recommended |
|
accountInformation.accountNumber |
Required |
Required |
Required |
Required |
|
accountInformation.iban |
Optional |
Optional |
Optional |
Optional |
|
accountHolder (object) |
||||
|
accountholder.customerId |
Required |
Required |
Required |
Required |
|
accountholder.nationality |
Required |
Required |
Required |
Required |
|
accountholder.person (object) |
||||
|
accountholder.person.name (array) |
||||
|
accountholder.person.name.first |
Required |
Required |
Required |
Required |
|
accountholder.person.name.preferred |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountholder.person.name.family |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountholder.person.name.middle |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountholder.person.name.prefix |
Optional |
Optional |
Optional |
Optional |
|
accountholder.person.name.suffix |
Optional |
Optional |
Optional |
Optional |
|
accountholder.person.phoneNumber |
Required |
Required |
Required |
Required |
|
accountholder.person.emailAddress |
Required |
Required |
Required |
Required |
|
accountholder.person.address (array) |
||||
|
accountholder.person.address.line1 |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
accountholder.person.address.line2 |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
accountholder.person.address.city |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
accountholder.person.address.region |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
accountholder.person.address.countryCode |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
accountholder.person.address.postalCode |
Optional but recommended |
Optional but recommended |
Optional but recommended |
Optional but recommended |
|
accountholder.person.dateOfBirth |
Optional |
Optional |
Optional |
Optional |
|
accountholder.governmentIds (object) |
||||
|
accountholder.governmentIds.idType |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountholder.governmentIds.idNumber |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountholder.governmentIds.idExpiryDate |
Recommended |
Recommended |
Recommended |
Recommended |
|
accountholder.businessIdNumber |
No |
Required |
No |
Required |
|
accountholder.businessName |
No |
Required |
No |
Required |
|
accountholder.businessOpeningDate |
Optional |
Recommended |
Recommended |
Recommended |
|
accountholder.paymentKey |
Optional |
Optional |
Optional |
Optional |
|
clientId |
Required |
Required |
Required |
Required |