Get Sender Details - Currencycloud API Documentation

Home > Get Sender Details

/v2/transactions/sender/{id}

GET

Returns a JSON structure with details of the sender of funds. The format of the sender tag in the response is "sender":"name; address; country; account_number or iban; bic; routing_code"

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required

Name	In	Type	Description
X-Auth-Token	header	string	Authentication token.
id	path	string	The Related Entity UUID (related_entity_id) of the Transaction.
Optional
Name	In	Type	Description
on_behalf_of	query	string	A contact UUID for the sub-acccount you're acting on behalf of.

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/transactions/sender/{id}

Response

{
  "id": "e68301d3-5b04-4c1d-8f8b-13a9b8437040",
  "amount": "1701.51",
  "currency": "EUR",
  "additional_information": "USTRD-0001",
  "value_date": "2018-07-04T00:00:00+00:00",
  "sender": "David Jenkins; 31 High Street, Brighton, East Sussex, BN1 2NW;GB;1111111111;;00000000",
  "receiving_account_number": null,
  "receiving_account_iban": "GB99OXPH94665099600083",
  "created_at": "2018-07-04T14:57:38+00:00",
  "updated_at": "2018-07-04T14:57:39+00:00"
}

Error Codes

HTTP Status	Code	Description
400	sender_not_found	Sender was not found for this id
400	id_is_not_valid_uuid	id should be in UUID format
401	invalid_supplied_credentials	Authentication failed with the supplied credentials
429	too_many_requests	Too many requests have been made to the api. Please refer to the Developer Center for more information
500	internal_server_error	Internal server error
503	service_unavailable	Service is temporary unavailable

Was this post helpful?

Let us know if you liked the post. That’s the only way we can improve.

Yes

/v2/transactions/sender/{id}

GET

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies