Skip to content

feat(payment): PAYMENTS-11169 Add provider token fields to Orders GetTransactions API public docs#1263

Open
bc-harika wants to merge 3 commits intomainfrom
PAYMENTS-11169
Open

feat(payment): PAYMENTS-11169 Add provider token fields to Orders GetTransactions API public docs#1263
bc-harika wants to merge 3 commits intomainfrom
PAYMENTS-11169

Conversation

@bc-harika
Copy link

@bc-harika bc-harika commented Feb 17, 2026

PAYMENTS-11169

What changed?

  • This PR updates the OpenAPI specification to reflect the addition of the new provider token fields (provider_instrument_token and provider_customer_id) in the Orders V3 Get Transactions API response.
  • These fields are optional and will be included in the response only when the Expose Provider Tokens feature is enabled for the store.

Release notes draft

We've added two new optional fields to the Orders V3 Get Transactions API:

  • provider_instrument_token
  • provider_customer_id

These fields return the payment provider's stored instrument token and customer identifier associated with a transaction, when available.

This functionality is controlled by the Expose Provider Tokens feature flag and will only be included in API responses for stores where the feature is enabled.

Anything else?

Verified the OpenAPI spec in both Swagger UI and the Redoc previews. The syntax and the formatting is all good.
Swagger UI preview
Response Schema
Screenshot 2026-02-18 at 10 30 15 am

Response Sample
Screenshot 2026-02-18 at 10 28 33 am

Redoc preview
Response Schema
Screenshot 2026-02-18 at 10 25 42 am

Response Sample
Screenshot 2026-02-18 at 10 26 56 am

ping @bigcommerce/team-payments

provider_customer_id:
type: string
description: |
The payment provider's customer identifier associated with the stored instrument used to process this transaction, if applicable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth calling out the 1:n relationship between provider_customer_id and provider_instrument_token

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments