Added

• "City", "Province" and "Postcode" field into both Payer and Beneficiary Unstructured examples on "Unstructured Identity Examples" page
• "PAYER_ACCOUNT_NUMBER" field into Payer Unstructured Example on "Unstructured Identity Examples" page
• "IdentityType", "DATE_OF_BIRTH", "ISO_COUNTRY_CODE_OF_BIRTH", "PASSPORT_NUMBER", "ISO_COUNTRY_CODE_ID_ISSUER", "LEGAL_ENTITY_REG_NUM", "LEGAL_ENTITY_REG_COUNTRY_PROVINCE" and "PAYER_ACCOUNT_NUMBER" to Unstructured Key Names enumeration page

Removed

• "AddressLine2" and "AddressLine3" field from both Payer and Beneficiary Unstructured examples on "Unstructured Identity Examples" page -"AddressLine2" and "AddressLine3" field from Unstructured Key Names enumeration page

Changed

• "settlementCalendar" field into an array to display this in console code example within 'Settlement Calendars Get Response' structure page

Changed

• Fields "beneficiaryBankAccountFieldGroup" and "beneficiaryBankAccountField" into an array within 'Beneficiary Bank Account Groups List' structure page.
• Example response for 'Get Metadata for Payment Request' to show field "beneficiaryBankAccountField" as an array.

Changed

• Field from 'usersBankId' to 'usersBankID' within example response for both 'Get Statement' and 'Search Transactions' page.

Added

• Field "dateSentToBank" to 'Payout Transaction' structure page.

Changed

• Data Type to 'Object' for "amountRefundedByBank", "amountRefundedToCustomer", "reason" and "originalPayoutTransaction" fields within 'Refund Transaction' structure page.
• Data Type to 'Object' for "refundPayoutID" field within 'Payout Transaction' structure page.

Added

• Fields such as "refundPayoutID" and "fxExecutedDetail" to 'Payout Transaction' structure page.
• Fields such as "fxExecutedDetail", "amountRefundedByBank", "amountRefundedToCustomer", "reason" and "originalPayoutTransaction" to 'Refund Transaction' structure page.
• "description" field to 'Journal Transaction' and 'Merchant Liquidity Movement Transaction' structure page.

Changed

• "Key" / "Value" fields to lowercase for 'Unstructured Identity' structure page.

Removed

• "description" field from 'Financial Transaction' structure page.

Changed

• Description within 'Additional Data' structure page.

Added

• Fields such as "feeValue", "fxMethodExpected" and "fxRate" to 'Payments Registered Beneficiary Create Response' structure page.

Changed

• Description within 'Beneficiary Bank Account Create Request' structure page.
• Description for 'payerIdentity' field within 'Users Create or Validate Request'.

Added

• "Unstructured Identity Examples" section under Guides.
• "Unstructured Key Names" page under Enumerations.

Changed

• Images within the 'Introduction' guide section to match API Documentation.
• Description for 'payerIdentity' field within 'Users Create or Validate Request'.

Added

• "Payment overview" section under Guides.

Changed

• Changed the spelling of 'Respone' to 'Response' within the structure 'Payments Registered Beneficiary Create Response'

Changed

• Changed the "IgnoreIfNullJson" field value from 'false' to 'true' within the API settings.
• Changed the field name 'Key' and 'Value' within the 'Additional Data' page to lowercase in the beginning located in the 'HTTP' section.

Changed

• Fixed an error that was caused when supplying an integer, instead of a string, into the key values of "Add bank account" API. This was changed so that only a string will be accepted for all value fields.
• Fixed an error that was caused when supplying long account numbers (ie. Morocco account numbers can be up to 24 digits), where a client provided the example "190170211401005132000877", this was then appearing in scientific notation (eg. 1.2345678901234568e+39) when using "Get bank account" API. This has been changed so that it returns as a string without losing any digits.

Added

• "Reason codes" section under Guides.

Changed

• Added brief description for each Webhook event type under "Webhooks" section.
• Added "Reason codes" link under "Webhooks" section.
• Added "Validation error codes" under "Errors" section.

Changed

• Fixed OAS spec and client SDKs. The structure BeneficiaryBankAccountFieldsList was changed to contain an array/list of BeneficiaryBankAccountField objects rather than a single BeneficiaryBankAccountField object.

Changed

• Fixed authentication endpoint so that it returns a valid OAuth token type. token_type is now "Bearer" rather than "BearerToken".
• Renamed managedMerchantIdentity to managedMerchantName in User to be consistent with other endpoints.
• Added max length for VAN(13)
• Added max length for managedMerchantName(30)
• Added max length for merchantUserID(100)
• Added max length for merchantBankID(100)
• Added max length for merchantTransactionID(255)
• Added optional FX Fees as part of payout response
• Descoped the locale field on the get meta service