From 44ab7877e894e558a6d7a1dc91e635da4a0404de Mon Sep 17 00:00:00 2001 From: Harika Baddula Date: Tue, 17 Feb 2026 16:37:22 +1100 Subject: [PATCH 1/4] feat(payment): PAYMENTS-11169 Add provider token fields to Orders Get Transactions API public docs --- reference/orders.v3.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 3cb1ae320..ab6425d71 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -1884,6 +1884,16 @@ components: 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. nullable: true + provider_instrument_token: + type: string + description: | + Optional. 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: | + Optional. 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. type: object From f5df1946b4369d63e1072078a7a90b418e800274 Mon Sep 17 00:00:00 2001 From: Harika Baddula Date: Wed, 18 Feb 2026 10:32:07 +1100 Subject: [PATCH 2/4] refactor(payment): PAYMENTS-11169 Remove optional prefix and add note in separate line for both the fields --- reference/orders.v3.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index ab6425d71..cb939fd26 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -1887,12 +1887,16 @@ components: provider_instrument_token: type: string description: | - Optional. 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.) + 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: | - Optional. 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.) + 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. From 7afb6809d9c6451151efc9816b3fa82e120cce18 Mon Sep 17 00:00:00 2001 From: Harika Baddula Date: Wed, 18 Feb 2026 11:12:53 +1100 Subject: [PATCH 3/4] feat(payment): PAYMENTS-11169 Add the provider token fields to the example response --- reference/orders.v3.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index cb939fd26..bb9da22bc 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -2029,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 From aa643fba58e587868b0dbc0d05b2caf3edd7edbf Mon Sep 17 00:00:00 2001 From: Harika Baddula Date: Thu, 19 Feb 2026 09:57:13 +1100 Subject: [PATCH 4/4] feat(payment): PAYMENTS-11169 Update the description of the existing field payment_instrument_token --- reference/orders.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index bb9da22bc..b9a141a01 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -1882,7 +1882,7 @@ 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