improved
Release Notes for Outgoing Transfer Returns: 12/02/2024
3 months ago
This release includes a new Webhook for returned outgoing transfers, new response examples for Get API of Outgoing Transfers and GET API of Incoming Transfers. Below, you'll find the details about the changes and new additions that have been included in this release.
Outgoing transfer API changes:
- A new type of webhook:
When an outgoing transfer is returned from the beneficiary's bank, an outgoing transfer-returned webhook will be triggered. Outgoing Transfer Webhooks
{
"webhook": {
"module": "outgoing-transfers",
"type": "outgoing-transfer-returned"
},
"data": {
"outgoingTransfer": {
"id": "00000000-0000-0000-0000-000000000000",
"transactionNumber": "20210419-000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"transferDate": "2021-04-19",
"status": "completed",
"currency": "GBP",
"amount": 100,
"feeCurrency": "GBP",
"feeAmount": 12,
"description": "freetext",
"returned": true,
"incomingTransferId": "00000000-0000-0000-0000-000000000000",
"transferReasonId": "00000000-0000-0000-0000-000000000000",
"transferCustomReason": null,
"originalTransferDate": "2021-04-19",
"cutOffDateTime": "2021-04-19T09:00:00",
"rollCount": 0,
"totalAmount": 112,
"ownerType": "client",
"scheme": "sepa",
"scope": "external",
"destination": {
"type": "beneficiary-bank-account",
"beneficiaryBankAccountId": "00000000-0000-0000-0000-000000000000"
},
"source": {
"type": "client-account",
"accountId": "00000000-0000-0000-0000-000000000000"
},
"requirementConfiguration": {
"transferDateStatus": "fulfilled",
"complianceCheckStatus": "fulfilled",
"balanceCheckStatus": "fulfilled",
"authorizationStatus": "not-required"
}
}
},
"connect": {},
"metadata": {}
}
- Added new response examples for Get API of Outgoing Transfer:
External, internal and returned external outgoing transfer response examples have been added to the GET API of outgoing transfer. Get an Outgoing Transfer
{
"workflow": {},
"data": {
"outgoingTransfer": {
"id": "00000000-0000-0000-0000-000000000000",
"transactionNumber": "20210419-000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"transferDate": "2021-04-19",
"status": "pending",
"currency": "GBP",
"amount": 100,
"feeCurrency": "GBP",
"feeAmount": 12,
"description": "freetext",
"incomingTransferId": null,
"transferReasonId": "00000000-0000-0000-0000-000000000000",
"transferCustomReason": null,
"originalTransferDate": "2021-04-19",
"cutOffDateTime": "2021-04-19T09:00:00",
"rollCount": 0,
"returned": false,
"totalAmount": 112,
"ownerType": "client",
"scheme": "sepa",
"scope": "external",
"destination": {
"type": "beneficiary-bank-account",
"beneficiaryBankAccountId": "00000000-0000-0000-0000-000000000000"
},
"source": {
"type": "client-account",
"accountId": "00000000-0000-0000-0000-000000000000"
},
"beneficiary": {
"fullName": "John Doe",
"identity": {
"type": "individual",
"country": null,
"identifications": null,
"givenName": "John",
"familyName": "Doe",
"birthDate": null
},
"address": {
"country": "GB",
"city": "London",
"street": "1",
"houseNumber": "1",
"refinement": "London St"
},
"account": {
"accountHolderName": null,
"country": "GB",
"currency": "EUR",
"routingCodes": {
"bic": "TESTGB12"
},
"accountNumber": null,
"iban": "GB96TEST71161299304760",
"ledgerNumber": null,
"alias": "EUR account"
},
"title": "John Doe Beneficiary"
},
"requirementConfiguration": {
"transferDateStatus": "fulfilled",
"complianceCheckStatus": "fulfilled",
"balanceCheckStatus": "fulfilled",
"authorizationStatus": "not-checked"
}
}
},
"connect": {},
"metadata": {}
}
{
"workflow": {},
"data": {
"outgoingTransfer": {
"id": "00000000-0000-0000-0000-000000000000",
"transactionNumber": "20240131-000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"transferDate": "2024-01-31",
"status": "completed",
"currency": "EUR",
"amount": 16.68,
"feeCurrency": "EUR",
"feeAmount": 0.00,
"description": "test",
"incomingTransferId": "00000000-0000-0000-0000-000000000000",
"transferCustomReason": null,
"originalTransferDate": "2024-01-31",
"rollCount": 0,
"returned": false,
"totalAmount": 16.68,
"scope": "internal",
"destination": {
"type": "client-account",
"accountId": "00000000-0000-0000-0000-000000000000"
},
"source": {
"type": "client-account",
"accountId": "00000000-0000-0000-0000-000000000000"
},
"requirementConfiguration": {
"transferDateStatus": "fulfilled",
"complianceCheckStatus": "fulfilled",
"balanceCheckStatus": "fulfilled",
"authorizationStatus": "not-required"
},
"beneficiary": {
"fullName": "Merve Testlhv",
"identity": {
"type": "individual",
"country": null,
"identificationNumbers": {
"passport": "000000",
"identity-card": "000000",
"driving-licence": "000000"
},
"identifications": null,
"givenName": "Merve",
"familyName": "Testlhv",
"birthDate": "1993-01-01"
},
"address": null,
"account": {
"accountHolderName": null,
"country": "EE",
"currency": "EUR",
"routingCodes": {
"bic": "LHVBEE22"
},
"accountNumber": null,
"iban": "EE937777000027746655",
"ledgerNumber": null,
"alias": "saving account lhv eur"
},
"title": "Merve Testlhv"
},
"ownerType": "client"
}
},
"connect": {},
"metadata": {}
}
{
"workflow": {},
"data": {
"outgoingTransfer": {
"id": "00000000-0000-0000-0000-000000000000",
"transactionNumber": "20240116-000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"transferDate": "2024-01-16",
"status": "completed",
"currency": "GBP",
"amount": 675.00,
"feeCurrency": "GBP",
"feeAmount": 2.00,
"description": "BeneficiaryTesting",
"incomingTransferId": "00000000-0000-0000-0000-000000000000",
"transferCustomReason": null,
"originalTransferDate": "2024-01-16",
"rollCount": 0,
"returned": true,
"transferReasonId": "00000000-0000-0000-0000-000000000000",
"totalAmount": 677.00,
"scheme": "local",
"scope": "external",
"destination": {
"type": "beneficiary-bank-account",
"beneficiaryId": "00000000-0000-0000-0000-000000000000",
"beneficiaryBankAccountId": "00000000-0000-0000-0000-000000000000"
},
"source": {
"type": "client-account",
"accountId": "00000000-0000-0000-0000-000000000000"
},
"requirementConfiguration": {
"transferDateStatus": "fulfilled",
"complianceCheckStatus": "fulfilled",
"balanceCheckStatus": "not-required",
"authorizationStatus": "not-required"
},
"beneficiary": {
"fullName": "Serkan Akagunduz",
"identity": {
"type": "individual",
"country": null,
"identifications": null,
"givenName": "Serkan",
"familyName": "Akagunduz",
"birthDate": "2000-02-09"
},
"address": {
"country": "GB",
"postalCode": "234578",
"city": "London",
"street": "Harry Potter",
"houseNumber": "67"
},
"account": {
"accountHolderName": null,
"country": "GB",
"currency": "GBP",
"routingCodes": {
"sort-code": "040720"
},
"accountNumber": "00000718",
"iban": null,
"ledgerNumber": null,
"alias": "Serkan Akagunduz GBP"
},
"title": "Serkan Akagunduz"
},
"ownerType": "client"
}
},
"connect": {},
"metadata": {}
}
Incoming transfer API changes:
- Added new response example for Get API of Incoming Transfer:
Incoming transfer for returned outgoing transfer response example have been added to the GET API of incoming transfer. Get an Incoming Transfer
{
"workflow": {},
"data": {
"incomingTransfer": {
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"accountId": "00000000-0000-0000-0000-000000000000",
"transactionNumber": "20240207-3QXMN7",
"status": "pending",
"currency": "GBP",
"amount": 675.00,
"feeAmount": 10.00,
"feeCurrency": "GBP",
"outgoingTransferId": "00000000-0000-0000-0000-000000000000",
"serviceProviderId": "00000000-0000-0000-0000-000000000000",
"serviceProviderReference": "BeneficiaryTest",
"senderInformation": null,
"senderName": "Serkan Akagunduz",
"transferDate": null,
"totalAmount": 665.00,
"provisionedAccountCreditId": "00000000-0000-0000-0000-000000000000",
"serviceProvider": "currencycloud",
"receiverAccount": {
"accountHolderName": "Demo Company 005",
"alias": "Joint Account with Amar",
"country": "GB",
"currency": "GBP",
"routingCodes": {},
"accountNumber": null,
"iban": null,
"ledgerNumber": "41735154"
},
"senderAccount": {
"accountHolderName": "Serkan Akagunduz",
"alias": "Serkan Akagunduz GBP",
"country": "GB",
"currency": "GBP",
"routingCodes": {
"sort-code": "040720"
},
"accountNumber": "00000718",
"iban": null,
"ledgerNumber": null
},
"scope": "external",
"scheme": null
}
},
"connect": {},
"metadata": {}
}