Forwarding data using Yapily headers

Yapily API now facilitates additional data communications to and from banks using the HTTP headers.

There are instances where your application requires specific HTTP header details to be retrieved from the institution’s API. Furthermore, you might need to pass a specific HTTP header from your app to the institution API. The wiki below shows how we facilitate these cases.

Yapily notes that this is typically used for the purpose of interaction audit trail and speedy debugging of large volumes of API calls. The data sent and received using HTTP headers are useful meta-data such as x-fapi-interaction-id, server details, connection details, content-type and other parameters supported by the given institution.

How to forward and receive data via Yapily API using headers?

For example, you’d like to pass a unique interaction ID for the API call from your side to the bank and check if the value is successfully passed, you can use the following HTTP headers:

• Y-Send-H-X-FAPI-Interaction-ID: <yourinput>
• Y-Receive-Headers: x-fapi-interaction-id

Using Y-Receive-Headers , you can also retrieve the following info from your bank-side header such as Server, ETag, Connection, Content-Length, Date etc in the forwardedData object of the response.

Note:

• The headers are case insensitive

Have questions or just want to say Hi 👋? Feel free to reach out to us via developers@yapily.com or slack.yapily.com