GpiTracking
A SWIFT gpi tracking lookup.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
POST |
/gpi-tracking |
create |
Returns matching GPI tracking transactions |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
created, err := client.GpiTracking(nil).Create(map[string]any{"identifier": "example", "identifierType": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(created)
Lua
Construct client as shown in the Lua setup, then call the operations:
local created, err = client:GpiTracking():create({ identifier = "example", identifierType = "example" })
PHP
Construct client as shown in the PHP setup, then call the operations:
$created = $client->GpiTracking()->create(["identifier" => "example", "identifierType" => "example"]);
Python
Construct client as shown in the Python setup, then call the operations:
created = client.GpiTracking().create({ "identifier": "example", "identifierType": "example" })
Ruby
Construct client as shown in the Ruby setup, then call the operations:
created = client.GpiTracking.create({ "identifier" => "example", "identifierType" => "example" })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const created = await client.GpiTracking().create({ identifier: "example", identifierType: "example" })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
identifier |
string |
Yes | The UETR or Wise transfer ID of the transfer to look up, matching identifierType. |
identifierType |
string |
Yes | The type of identifier used to look up the transfer. |
transactions |
array |
No | The matching GPI tracking transactions. |
create
POST /gpi-tracking
Operation ID: LookupGpiTracking.
Authentication: bearer token (ClientCredentialsToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
identifier |
string |
Yes | The UETR or Wise transfer ID of the transfer to look up, matching identifierType. Must be a UUID (for example 97ed4827-7b6f-4491-a206-42bcf859a919) when identifierType is UETR, or a positive integer (int64) (for example 16521632) when identifierType is TRANSFER_ID. |
identifierType |
enum: UETR, TRANSFER_ID |
Yes | The type of identifier used to look up the transfer. |
Responses
200: Returns matching GPI tracking transactions
application/json
| Property | Type | Required | Description |
|---|---|---|---|
transactions |
array of object |
No | The matching GPI tracking transactions. |
transactions[].cancellationStatus |
enum: CANCELLED, PENDING_CANCELLATION, CANCELLATION_REJECTED |
No | Cancellation status, when a cancellation has been requested or resolved. |
transactions[].completedAt |
string (date-time) |
No | When the transaction reached a completed state. |
transactions[].confirmedAmount |
object |
No | Amount credited to the creditor's account. Present when status is ACCC. |
transactions[].confirmedAmount.amount |
number (decimal) |
No | Non-negative monetary amount. |
transactions[].confirmedAmount.currency |
string |
No | ISO 4217 currency code. |
transactions[].confirmedAt |
string (date-time) |
No | When the funds were made available to the creditor. Present when status is ACCC. |
transactions[].events |
array of object |
No | Ordered tracking events, latest first. |
transactions[].events[].amountInconsistency |
boolean |
No | Whether instructed and settled amounts are inconsistent. |
transactions[].events[].cancellationRequestStatus |
object |
No | Cancellation request status conveyed by this event. |
transactions[].events[].cancellationRequestStatus.indemnityAgreement |
boolean |
No | Whether an indemnity agreement applies to the cancellation request. |
transactions[].events[].cancellationRequestStatus.reasonCode |
string |
No | Cancellation reason code, passed through as a SWIFT gpi cancellation reason code. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].cancellationRequestTrackingStatus |
string |
No | Cancellation request tracking status conveyed by this event, passed through as a SWIFT gpi cancellation request tracking status code. Known values: S000, S001, S002, S003, S004. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].cancellationResponseStatus |
object |
No | Cancellation response status conveyed by this event. |
transactions[].events[].cancellationResponseStatus.code |
string |
No | Cancellation response code, passed through as a SWIFT gpi cancellation response code. Known values: CNCL (cancelled), PDCR (pending), RJCR (rejected). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].cancellationResponseStatus.reasonCode |
string |
No | Cancellation response reason code, passed through as a SWIFT gpi cancellation response reason code. Present for PDCR and RJCR. |
transactions[].events[].chargeBearer |
string |
No | Charge bearer indicator, passed through as a SWIFT gpi charge bearer code. Known values: DEBT, CRED, SHAR, SLEV. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].charges |
array of object |
No | Charges applied at this hop. Omitted when there are none. |
transactions[].events[].charges[].amount |
object |
No | Charge amount. |
transactions[].events[].charges[].amount.amount |
number (decimal) |
No | Non-negative monetary amount. |
transactions[].events[].charges[].amount.currency |
string |
No | ISO 4217 currency code. |
transactions[].events[].charges[].bic |
string |
No | BIC of the charging agent. |
transactions[].events[].charges[].name |
string |
No | Name of the charging agent. |
transactions[].events[].confirmedAmount |
object |
No | Amount credited to the creditor's account. Present when status is ACCC. |
transactions[].events[].confirmedAmount.amount |
number (decimal) |
No | Non-negative monetary amount. |
transactions[].events[].confirmedAmount.currency |
string |
No | ISO 4217 currency code. |
transactions[].events[].confirmedAt |
string (date-time) |
No | When the funds were made available to the creditor. Present when status is ACCC. |
transactions[].events[].creditorAgent |
string |
No | Creditor agent BIC. |
transactions[].events[].debtorAgent |
string |
No | Debtor agent BIC. |
transactions[].events[].endToEndId |
string |
No | End-to-end identifier. |
transactions[].events[].eventCreationTime |
string (date-time) |
No | When this event was created. |
transactions[].events[].eventTarget |
string |
No | Target of the tracking event, passed through as a SWIFT gpi tracker event target code. Known values: CREDIT_TRANSFER, CREDIT_TRANSFER_RETURN, CREDIT_TRANSFER_COVER, CREDIT_TRANSFER_COVER_RETURN, FINANCIAL_INSTITUTION_CREDIT_TRANSFER, FINANCIAL_INSTITUTION_CREDIT_TRANSFER_RETURN, FINANCIAL_INSTITUTION_CREDIT_TRANSFER_COVER, FINANCIAL_INSTITUTION_CREDIT_TRANSFER_COVER_RETURN. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].eventType |
string |
No | Type of the tracking event, passed through as a SWIFT gpi tracker event type code. Known values: PAYMENT, STATUS_UPDATE, CANCELLATION_REQUEST, CANCELLATION_RESPONSE, CANCELLATION_REQUEST_STATUS_UPDATE. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].exchangeRate |
number (decimal) |
No | Exchange rate applied between the source and target currencies. |
transactions[].events[].from |
string |
No | Sending agent BIC. |
transactions[].events[].instructedAgent |
string |
No | Instructed agent BIC. |
transactions[].events[].instructedAmount |
object |
No | Amount as instructed at this hop. |
transactions[].events[].instructedAmount.amount |
number (decimal) |
No | Non-negative monetary amount. |
transactions[].events[].instructedAmount.currency |
string |
No | ISO 4217 currency code. |
transactions[].events[].instructingReimbursementAgent |
string |
No | Instructing reimbursement agent BIC. |
transactions[].events[].instructionId |
string |
No | Instruction identifier. |
transactions[].events[].intermediaryAgent1 |
string |
No | Intermediary agent 1 BIC. |
transactions[].events[].intermediaryAgent2 |
string |
No | Intermediary agent 2 BIC. |
transactions[].events[].intermediaryAgent3 |
string |
No | Intermediary agent 3 BIC. |
transactions[].events[].messageNameIdentification |
string |
No | Message name identification (ISO 20022 message type). |
transactions[].events[].previousInstructingAgent1 |
string |
No | Previous instructing agent 1 BIC. |
transactions[].events[].previousInstructingAgent2 |
string |
No | Previous instructing agent 2 BIC. |
transactions[].events[].previousInstructingAgent3 |
string |
No | Previous instructing agent 3 BIC. |
transactions[].events[].rejectionReason |
string |
No | Rejection reason code, passed through as a SWIFT gpi rejection reason code (ISO 20022 external return/reason code). Present when status is RJCT. Known values include AC04 (closed account number), AC06 (blocked account), AM09 (wrong amount), BE01 (inconsistent with end customer), RR04 (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].returnReason |
string |
No | Return reason code associated with this event, passed through as a SWIFT gpi return reason code (ISO 20022 external return/reason code). Known values include AC04 (closed account number), AC06 (blocked account), AM09 (wrong amount), BE01 (inconsistent with end customer), RR04 (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].serviceLevel |
string |
No | Service level of the transaction, passed through as a SWIFT gpi service level code. Known values: G001, G002, G004, G005, G009. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].settledAmount |
object |
No | Amount as settled at this hop. |
transactions[].events[].settledAmount.amount |
number (decimal) |
No | Non-negative monetary amount. |
transactions[].events[].settledAmount.currency |
string |
No | ISO 4217 currency code. |
transactions[].events[].settlementDate |
string (date) |
No | Settlement date of this event. |
transactions[].events[].sourceCurrency |
string |
No | Source currency of the exchange, if any. |
transactions[].events[].status |
string |
No | Status conveyed by this event, passed through as a SWIFT gpi transaction status code. Known values: ACSP (accepted, settlement in progress), ACCC (accepted, settlement completed), RJCT (rejected). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].statusReason |
object |
No | Sub-status detail, present when status is ACSP. |
transactions[].events[].statusReason.chargeBearer |
string |
No | Charge bearer code. Present for G000, G001, G005, G006. |
transactions[].events[].statusReason.code |
string |
No | Sub-status code, passed through as a SWIFT gpi transaction status reason code. Known values: G000, G001, G002, G003, G004, G005, G006. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].statusReason.instructedAgent |
string |
No | BIC the transaction was forwarded to. Present for G000, G001, G005, G006. |
transactions[].events[].statusReason.settlementMethod |
object |
No | Settlement method. Present for G000, G001, G005, G006. |
transactions[].events[].statusReason.settlementMethod.clearingSystem |
string |
No | Clearing system, present when the settlement method is CLRG. |
transactions[].events[].statusReason.settlementMethod.code |
string |
No | Settlement method code, passed through as a SWIFT gpi settlement method code. Known values: INDA, INGA, COVE, CLRG. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].events[].statusTime |
string (date-time) |
No | When this status was reached. Present when status is ACSP or RJCT. |
transactions[].events[].targetCurrency |
string |
No | Target currency of the exchange, if any. |
transactions[].events[].to |
string |
No | Receiving agent BIC. |
transactions[].events[].trackerInformingParty |
string |
No | Party informing the tracker. |
transactions[].initiatedAt |
string (date-time) |
No | When transaction tracking was initiated. |
transactions[].lastUpdatedAt |
string (date-time) |
No | When the tracking record was last updated. |
transactions[].rejectionReason |
string |
No | Rejection reason code, passed through as a SWIFT gpi rejection reason code (ISO 20022 external return/reason code). Present when status is RJCT. Known values include AC04 (closed account number), AC06 (blocked account), AM09 (wrong amount), BE01 (inconsistent with end customer), RR04 (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].returnReason |
string |
No | Return reason code, present when the transaction was returned or rejected, passed through as a SWIFT gpi return reason code (ISO 20022 external return/reason code). Known values include AC04 (closed account number), AC06 (blocked account), AM09 (wrong amount), BE01 (inconsistent with end customer), RR04 (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].status |
string |
No | Overall tracking status of the transaction, passed through as a SWIFT gpi transaction status code. Known values: ACSP (accepted, settlement in progress), ACCC (accepted, settlement completed), RJCT (rejected). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].statusReason |
object |
No | Sub-status detail, present when status is ACSP. |
transactions[].statusReason.chargeBearer |
string |
No | Charge bearer code. Present for G000, G001, G005, G006. |
transactions[].statusReason.code |
string |
No | Sub-status code, passed through as a SWIFT gpi transaction status reason code. Known values: G000, G001, G002, G003, G004, G005, G006. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].statusReason.instructedAgent |
string |
No | BIC the transaction was forwarded to. Present for G000, G001, G005, G006. |
transactions[].statusReason.settlementMethod |
object |
No | Settlement method. Present for G000, G001, G005, G006. |
transactions[].statusReason.settlementMethod.clearingSystem |
string |
No | Clearing system, present when the settlement method is CLRG. |
transactions[].statusReason.settlementMethod.code |
string |
No | Settlement method code, passed through as a SWIFT gpi settlement method code. Known values: INDA, INGA, COVE, CLRG. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists. |
transactions[].statusTime |
string (date-time) |
No | When this status was reached. Present when status is ACSP or RJCT. |
transactions[].uetr |
string |
No | The UETR of the tracked transaction. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.