diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 3cb1ae320..b9a141a01 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -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. @@ -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