feat(api)!: move to generic refund status API #19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The refund batch status API is at path `GET /refund/batch/{batchID}`,
which while continuing to work, will no longer return `batchID` as
part of the response. This allows the internal API to be more generic,
supporting fetching the refund status by more identifiers.
The path for the internal API has now changed to:
`GET /refund/{identifierType}/{identifierValue}`
The allowed values for `identifierType` at this point are:
- batch
- bill
If you were not using the `batchID` in the response in your code,
then your integration will continue to work. In either case, the
`getRefundBatchStatus` is deprecated and it is recommended to use
the new `getRefundStatusByIdentifier` method instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The refund batch status API is at path
GET /refund/batch/{batchID},which while continuing to work, will no longer return
batchIDaspart of the response. This allows the internal API to be more generic,
supporting fetching the refund status by more identifiers.
The path for the internal API has now changed to:
GET /refund/{identifierType}/{identifierValue}The allowed values for
identifierTypeat this point are:If you were not using the
batchIDin the response in your code,then your integration will continue to work. In either case, the
getRefundBatchStatusis deprecated and it is recommended to usethe new
getRefundStatusByIdentifiermethod instead.