What's changing?
We are introducing a new endpoint that offers additional data on approved funding transactions. This improved response will include all the existing details from our Get Sender Details API, with the addition of new fields such as rail and sender account specifics.
While both endpoints will coexist for some time, please note that the new endpoint will eventually supersede the current Get Sender Details API, which will be phased out following a deprecation period. We will keep you fully informed of the deprecation process and timeline.
What do I need to do?
To access detailed transaction data, we kindly ask that you start using our new Get Funding Transaction endpoint.
Here's a sample response from this endpoint with the newly added fields highlighted:
{
"id": "4924919a-6c28-11ee-a3e3-63774946bad2",
"amount": "1.11",
"currency": "USD",
"rail": "SEPA",
"additional_information": "ABCD20231016143117",
"receiving_account_routing_code": "123456789",
"value_date": "2023-10-16T00:00:00+00:00",
"receiving_account_number": "32847346",
"receiving_account_iban": null,
"created_at":"2023-10-16T13:31:18+00:00",
"updated_at":"2023-10-16T13:32:24+00:00",
"completed_at": null,
"sender":
{
"sender_id": "5c675fa4-fdf0-4ee6-b5bb-156b36765433",
sender_address": "Some street",
"sender_country":"GB",
"sender_name":"Test sender",
"sender_bic": null,
"sender_iban": null,
"sender_account_number": null,
"sender_routing_code": null,
}
}
How do I use it?
As we're currently in the pilot phase of the new endpoint, it's not yet listed on our developer center or included in our SDKs. You can still utilize it by making direct calls. All the information you need to do this is provided below:
Endpoint Name
GET /v2/funding_transactions/{id}
Parameters
| Parameter | Description | Optional / Required | Location |
|---|---|---|---|
| X-Auth-Token | Authentication token | Required | Header |
| id | The Related Entity UUID (related_entity_id) for the Transaction. | Required | Path |
| on_behalf_of | A contact UUID for the sub-account you're acting on behalf of. Note that you cannot act on behalf of your own contacts. | Optional | Query |
cURL Request:
curl -X GET https://devapi.currencycloud.com/v2/funding_transactions/{id} \
-H 'X-Auth-Token: XXXX-XXXX-XXXX'
Response:
An example of the JSON response is given in the answer to the previous question. A description of the response fields is given below.
| Field | Type | Description |
|---|---|---|
| id | string | The Related Entity UUID (related_entity_id) for the Transaction. |
| amount | string | The transaction amount. |
| currency | string | The three-letter currency code. |
| rail | string | The transaction rail. |
| additional_information | string | Any additional information. |
| receiving_account_routing_code | string | The routing code. |
| value_date | string | The value date in ISO-8601 format. |
| receiving_account_number | string | The transaction receiving account number. |
| receiving_account_iban | string | The transaction receiving account IBAN. |
| created_at | string | The created at date in ISO-8601 format. |
| updated_at | string | The last time the transaction was updated in ISO-8601 format. |
| completed_at | string | The completed date in ISO-8601 format. |
| sender | object | The sender information. |
| sender_id | string | The id for a unique sender (same account number, name, etc.) on the given House or Sub-account. |
| sender_address | string | The unstructured sender address. |
| sender_country | string | The two-letter sender country code. |
| sender_name | string | The sender name. |
| sender_bic | string | The sender bic |
| sender_iban | string | The sender iban. |
| sender_account_number | string | The sender account number. |
| sender_routing_code | string | The sender routing code |
Help and support
Should you encounter any issues or have any feedback during the pilot phase, please don't hesitate to reach out to your Customer Success Manager (CSM)