Payment Token Updated Webhook
Payload
Optional ISO-8601 timestamp of when the LMN expires
Response
Webhook received successfully (HTTP 204 No Content)
Optional ISO-8601 timestamp of when the LMN expires
Webhook received successfully (HTTP 204 No Content)
The partner is required to implement an endpoint that Truemed requests to inform the partner of updates made to payment tokens which back customer subscriptions.
The payment_token_updated webhook is invoked when:
payment_token is provisioned using create_payment_sessionupdate_payment_tokenpayment_token is provisioned using create_payment_tokenThe request body includes the payment_token, and one of 3 optional IDs mapping back to the
originating entity (payment_session_id, failed_payment_session_id, or
provision_token_request_id).
Once you receive this webhook, the payment_token can successfully be used in subsequent
calls to create_payment_session.
Authentication: Partners should verify the request comes from Truemed by checking that
the API key is present in the x-truemed-api-key HTTP header.
payment_token: the payment_token returned to the partner by Truemed in response to a
create_payment_session request
when tokenize was set to Truepayment_session_id: (Optional) the id of the payment_session returned by
create_payment_session
payment_token was provisioned as part of a create_payment_session
with tokenize=true.failed_payment_session_id: (Optional) the id returned to the partner by Truemed in
response to a create_payment_session request
payment_token was used in create_payment_session
and failed to be charged as outlined in the failure cases in the Subscriptions Guide.provision_token_request_id: (Optional)
payment_token with a call to
create_payment_token or
update_payment_tokenHTTP Status: 204
The partner does not need to include any content in the body, but MUST respond with 204.
Truemed will retry the requests to your backend with backoff for up to 7 days