Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bc-harika wants to merge 4 commits into
base: main
Choose a base branch
from
+17 −1
Open

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44ab787
feat(payment): PAYMENTS-11169 Add provider token fields to Orders Get…
bc-harika Feb 17, 2026
f5df194
refactor(payment): PAYMENTS-11169 Remove optional prefix and add note…
bc-harika Feb 17, 2026
7afb680
feat(payment): PAYMENTS-11169 Add the provider token fields to the ex…
bc-harika Feb 18, 2026
aa643fb
feat(payment): PAYMENTS-11169 Update the description of the existing …
bc-harika Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion reference/orders.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1882,7 +1882,21 @@ components:
format: date-time
payment_instrument_token:
type: string
description: This field contains internal BigPay token for stored card that is then mapped to the actual third-party token. We currently do not offer a way to get third party tokens.These tokens are read-only and do not return any information about the payment.
description: This field contains the internal BigPay token for the stored card, mapped to the third-party token. When the optional feature to expose provider tokens is enabled, the payment provider's instrument token and customer identifier are exposed via `provider_instrument_token` and `provider_customer_id`. These tokens are read-only and do not return any information about the payment.
nullable: true
provider_instrument_token:
type: string
description: |
The payment provider's instrument token associated with the stored instrument used to process this transaction, if applicable.

**Note:** This field is connected to an optional feature and may not be returned when using this endpoint. If your implementation requires access to this field, please reach out to support or your account manager to enable the inclusion of a provider token here.
nullable: true
provider_customer_id:
type: string
description: |
The payment provider's customer identifier associated with the stored instrument used to process this transaction, if applicable.

**Note:** This field is connected to an optional feature and may not be returned when using this endpoint. If your implementation requires access to this field, please reach out to support or your account manager to enable the inclusion of a provider customer id here.
nullable: true
avs_result:
description: Address Verification Service (AVS) result from the payment gateway.
Expand Down Expand Up @@ -2015,6 +2029,8 @@ components:
id: 0
order_id: string
payment_instrument_token: string
provider_instrument_token: null
provider_customer_id: null
avs_result:
code: string
message: string
Expand Down