Documentation

Formatting Standards

Suggest Edits

Formatting Standards

  • All dates and timestamp types provided by Convera use ISO 8601 and be in UTC unless specifically indicated
    • Example: 2022-01-01 12:15:30Z
  • All currency codes are defined as in ISO 4217
    • Example: USD, EUR, JPY
  • All country codes are defined as in ISO 3166 two-letter code (alpha-2)
    • Example: US, NP, AU
  • All amounts should be defined and submitted as an integer type and assumed to be in cents (minor currency unit) value. The number of cents are defined in ISO 4217
    • Example: 10089 would represent 100.89 USD, or 10089 JPY, or 10.089 KWD as each currency specifies a different minor currency unit (2 for USD, 0 for JPY, and 3 for KWD).
  • The following characters are reserved in JSON and must be properly escaped to be used in strings. Only SWIFT-accepted characters are allowed:
    • Double quote (“) is replaced with \"
    • Backslash () is replaced with a \\
    • Backspace is replaced with \b
    • Form feed is replaced with \f
    • Newline is replaced with \n
    • Carriage return is replaced with \r
    • Tab is replaced with \t

SWIFT Valid Characters

The following characters are the only characters accepted by the SWIFT network and by the API. All other characters will be rejected for fields that are passed on the payment message to the bank.

CharacterDescription
"a" - "z"26 small characters of the Latin alphabet
"A" - "Z"26 capital characters of the Latin alphabet
"0" - "9"10 numerical characters
"/"Forward slash
"-"Hyphen
"?"Question mark
":"Colon
"("Opening parenthesis
")"Closing parenthesis
"."Period
","Comma
"'"Apostrophe
"+"Plus sign
" "Space character

The fields in the Send Payment API request where this validation occurs are:

  1. payment.amount
  2. payment.currencyCode
  3. payment.settlementCurrencyCode
  4. payment.purposeOfPayment
  5. payment.purposeOfPaymentCode
  6. payment.instructionForBank
  7. payment.instructionCodeForBank
  8. payment.chargeType
  9. beneficiary.taxId
  10. beneficiary.firstName
  11. beneficiary.middleName
  12. beneficiary.lastName
  13. beneficiary.phoneNumber
  14. beneficiary.countryOfNationality
  15. beneficiary.identificationDocumentType
  16. beneficiary.identificationDocumentNumber
  17. beneficiary.identificationDocumentCountry
  18. beneficiary.employerName
  19. beneficiary.businessName
  20. beneficiary.address.line1
  21. beneficiary.address.line2
  22. beneficiary.address.line3
  23. beneficiary.address.city
  24. beneficiary.address.stateOrProv
  25. beneficiary.address.zipOrPostal
  26. beneficiary.address.countryCode
  27. bankAccount.accountNumber
  28. bankAccount.accountType
  29. bankAccount.bankName
  30. bankAccount.bankBranchName
  31. bankAccount.bankCode
  32. bankAccount.bankBranchCode
  33. bankAccount.address.line1
  34. bankAccount.address.line2
  35. bankAccount.address.line3
  36. bankAccount.address.city
  37. bankAccount.address.stateOrProv
  38. bankAccount.address.zipOrPostal
  39. bankAccount.address.countryCode
  40. bankAccount.intermediaryBank.bankName
  41. bankAccount.intermediaryBank.bankCode
  42. bankAccount.intermediaryBank.accountNumber
  43. bankAccount.intermediaryBank.address.line1
  44. bankAccount.intermediaryBank.address.line2
  45. bankAccount.intermediaryBank.address.line3
  46. bankAccount.intermediaryBank.address.city
  47. bankAccount.intermediaryBank.address.stateOrProv
  48. bankAccount.intermediaryBank.address.zipOrPostal
  49. bankAccount.intermediaryBank.address.countryCode
  50. thirdPartyRemitter.type
  51. thirdPartyRemitter.businessName
  52. thirdPartyRemitter.address.line1
  53. thirdPartyRemitter.address.line2
  54. thirdPartyRemitter.address.line3
  55. thirdPartyRemitter.address.city
  56. thirdPartyRemitter.address.stateOrProv
  57. thirdPartyRemitter.address.zipOrPostal
  58. thirdPartyRemitter.address.countryCode
  59. thirdPartyRemitter.phoneNumber
  60. thirdPartyRemitter.bankAccount.accountNumber
  61. thirdPartyRemitter.bankAccount.accountCurrency
  62. thirdPartyRemitter.bankAccount.bankCode
  63. thirdPartyRemitter.bankAccount.bankRoutingCode
  64. originatingFI.accountNumber
  65. originatingFI.accountType
  66. originatingFI.bankName
  67. originatingFI.bankCode
  68. originatingFI.accountCurrency
  69. originatingFI.bankRoutingCode
  70. originatingFI.address.line1
  71. originatingFI.address.line2
  72. originatingFI.address.line3
  73. originatingFI.address.city
  74. originatingFI.address.stateOrProv
  75. originatingFI.address.zipOrPostal
  76. originatingFI.address.countryCode

Updated about 13 hours ago