Skip to main content

Traceability

Every request to the TransferGo Business API is assigned a correlation ID that lets us trace it end-to-end. When you report an issue, providing this ID allows us to pinpoint the exact request and debug it quickly.

Sending a correlation ID​

You can attach your own correlation ID to any request through the CorrelationId HTTP header:

curl -X GET \
  --url https://business-api.transfergo.com/v1/ping \
  --cert client.crt \
  --key client.key \
  --header "Authorization: Bearer {access_token}" \
  --header "CorrelationId: my-request-123"

To see how to make the first call to the API, visit Calling the API.

Sending your own value is optional; the response will always contain a generated one.

Validation rules​

The value you provide must satisfy the following constraints:

  • Between 1 and 64 characters long.
  • Limited to the characters A-Z, a-z, 0-9, -, _, ., and :.

Requests with a CorrelationId header that violates these rules are rejected with a 400 Bad Request and the INVALID_CORRELATION_ID error code. See Error handling for the error format.

Reading the correlation ID back​

All responses from the Business API will have a CorrelationId header.

Keep this value in your logs. When something goes wrong, contact our support team and include the correlation ID so we can trace exactly what happened with your request.

How the response correlation ID is constructed​

We always combine your value (if any) with a randomly generated UUID to build the response correlation ID:

  • If you provide CorrelationId, the value in the response is {yourCorrelationId}:{autoGeneratedUuid}.
  • If you don't provide it, the final value is just the auto-generated UUID.

Next steps​