Network Interoperability Status Request

PUT/payments/{uetr}/status

Authorization

oauthBearerToken

AuthorizationBearer <token>

The access token obtained as a result of OAuth 2.0 flows. SWIFT supports two OAuth grant types depending on the API service.

JWT-Bearer grant type RFC 7523
Password grant type

This API uses JWT-Bearer grant type.

Please visit SWIFT OAuth Token API page for more information and examples on how to generate an OAuth token.

In this declaration only the basic security element to transport the bearer token of an OAuth2 process is declared.

In: header

Path Parameters

uetr*string

Identifies the payment transaction resource, events linked to this uetr will be retrieved

Match^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$

Specifies the sending MessagingEndpoint that has created this Business Message for the receiving MessagingEndpoint that will process this Business Message. The sending MessagingEndpoint might be different from the sending address potentially contained in the transport header (as defined in the transport layer).

Based on datatype BICFIDec2014Identifier: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Match^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$

transaction_status*string

Provides detailed information on the transaction status to be updated in the tracker.

Specifies the status of a single payment transaction.

Code Name Definition: *ACCC - AcceptedCreditSettlementCompleted - Settlement on the creditor's account has been completed. *ACSP - AcceptedSettlementInProcess - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. *RJCT - Rejected - Payment initiation or individual transaction included in the payment initiation has been rejected.

Value in"ACCC" | "ACSP" | "RJCT"

transaction_status_date*string

Date for the status. Date Time must be expressed as UTC/Zulu time (YYYY-MM-DDThh:mm:ss.sssZ) or local time with UTC offset (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm). Local time is not allowed.

Based on datatype ISONoLocalDateTime: an ISODateTime whereby only Zulu/UTC and Local Time with UTC offset are allowed and where local time is blocked.

Match

^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]+)?(?:Z|[+-][01]\d:[0-5]\d)?$

transaction_status_reason?string

Provides detailed information on the status reason.

Provides reason for reject/return.

Code Name Definition: *G007 - MIPaymentTransferred - The payment of the (gpi) sending MI agent was transferred to the receiving MI agent. *G008 - MIPaymentTransferredAndReceived - The payment of the (gpi) sending MI agent was transferred to and received by the receiving MI agent. *OBO1 - OnBehalfCreditConfirmationWithCreditAmountTransparency - On-behalf credit confirmation with credit amount transparency *OBO2 - OnBehalfCreditConfirmationWithoutCreditAmountTransparency - On-behalf credit confirmation without credit amount transparency

Value in"G007" | "G008" | "OBO1" | "OBO2"

reject_return_reason?string

Provides detailed information on the reject/return reason.

Provides reason for reject/return.

Code Name Definition: *AC01 - IncorrectAccountNumber - Account number is invalid or missing *AC02 - InvalidDebtorAccountNumber - Debtor account number invalid or missing

*AC04 - ClosedAccountNumber - Account number specified has been closed on the bank of account's books. *AC06 - BlockedAccount - Account specified is blocked, prohibiting posting of transactions against it. *AC07 - ClosedCreditorAccountNumber - Creditor account number closed. *AC13 - InvalidDebtorAccountType - Debtor account type is missing or invalid. *AGNT - IncorrectAgent - Agent in the payment workflow is incorrect. *AM02 - NotAllowedAmount - Specific transaction/message amount is greater than allowed maximum. *AM03 - NotAllowedCurrency - Specific message amount is an non processable currency outside of existing agreement. *AM04 - InsufficientFunds - Amount of funds available to cover specified message amount is insufficient. *AM06 - AmountTooLow - Below limit. *AM07 - BlockedAmount - Amount specified in message has been blocked by regulatory authorities. *AM09 - WrongAmount - Amount received is not the amount agreed or expected. *BE01 - InconsistentWithEndCustomer - Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency). *BE04 - MissingCreditorAddress - Specification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress). *BE05 - UnrecognisedInitiatingParty - Party who initiated the message is not recognised by the end customer. *BE07 - MissingDebtorAddress - Specification of debtor's address, which is required for payment, is missing/not correct. *CURR - IncorrectCurrency - Currency of the payment is incorrect. *CUST - RequestedByCustomer - At request of creditor. *DUPL - Duplication - Payment is a duplicate of another payment. *ERIN - ERIOptionNotSupported - The Extended Remittance Information (ERI) option is not supported. *FF03 - InvalidPaymentTypeInformation - Payment Type Information is missing or invalid. Generic usage if cannot specify Service Level or Local Instrument code. *FF04 - InvalidServiceLevelCode - Service Level code is missing or invalid. *FF05 - InvalidLocalInstrumentCode - Local Instrument code is missing or invalid. *FF06 - InvalidCategoryPurposeCode - Category Purpose code is missing or invalid. *FF07 - InvalidPurpose - Purpose is missing or invalid. *FOCR - FollowingCancellationRequest - Return following a cancellation request. *FR01 - Fraud - Returned as a result of fraud. *G004 - CreditPendingFunds - Credit to the creditor's account is pending as status Originator is waiting for funds provided via a cover. *MS02 - NotSpecifiedReasonCustomerGenerated - Reason has not been specified by end customer. *MS03 - NotSpecifiedReasonAgentGenerated - Reason has not been specified by agent. *NOAS - NoAnswerFromCustomer - Failed to contact beneficiary. *NOCM - NotCompliant - Customer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements which render an account inactive for certain processing. *RC01 - BankIdentifierIncorrect - Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode). *RC03 - InvalidDebtorBankIdentifier - Debtor bank identifier is invalid or missing *RC04 - InvalidCreditorBankIdentifier - Creditor bank identifier is invalid or missing. *RC08 - InvalidClearingSystemMemberIdentifier - Routing code not valid for local clearing. *RC11 - InvalidIntermediaryAgent - Intermediary Agent is invalid or missing. *RR01 - MissingDebtorAccountOrIdentification - Specification of the debtor’s account or unique identification needed for reasons of regulatory requirements is insufficient or missing *RR02 - MissingDebtorNameOrAddress - Specification of the debtor’s name and/or address needed for regulatory requirements is insufficient or missing.

*RR03 - MissingCreditorNameOrAddress - Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing. *RR04 - RegulatoryReason - Regulatory Reason *RR05 - RegulatoryInformationInvalid - Regulatory or Central Bank Reporting information missing, incomplete or invalid. *RR06 - TaxInformationInvalid - Tax information missing, incomplete or invalid. *RR07 - RemittanceInformationInvalid - Remittance information structure does not comply with rules for payment type. *RR08 - RemittanceInformationTruncated - Remittance information truncated to comply with rules for payment type. *RR09 - InvalidStructuredCreditorReference - Structured creditor reference invalid or missing. *RR11 - InvalidDebtorAgentServiceID - Invalid or missing identification of a bank proprietary service. *RR12 - InvalidPartyID - Invalid or missing identification required within a particular country or payment type. *RUTA - ReturnUponUnableToApply - Return following investigation request and no remediation possible. *UPAY - UnduePayment - Payment is not justified.

Value in

"AC01" | "AC02" | "AC04" | "AC06" | "AC07" | "AC13" | "AGNT" | "AM02" | "AM03" | "AM04" | "AM06" | "AM07" | "AM09" | "BE01" | "BE04" | "BE05" | "BE07" | "CURR" | "CUST" | "DUPL" | "ERIN" | "FF03" | "FF04" | "FF05" | "FF06" | "FF07" | "FOCR" | "FR01" | "G004" | "MS02" | "MS03" | "NOAS" | "NOCM" | "RC01" | "RC03" | "RC04" | "RC08" | "RC11" | "RR01" | "RR02" | "RR03" | "RR04" | "RR05" | "RR06" | "RR07" | "RR08" | "RR09" | "RR11" | "RR12" | "RUTA" | "UPAY"

tracker_informing_party*|

Specifies the details to identify a financial institution.

instruction_identification*string

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Usage: The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.

Based on datatype RestrictedFINXMax35Text: Specifies a character string with a maximum length of 35 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + .

Match^[0-9a-zA-Z/\-\?:\.,'\+ ]{1,35}$

Length1 <= length <= 35

settlement_method*string

Method used to settle the (batch of) payment instructions.

Specifies the method used to settle the credit transfer instruction.

Code Name Definition: *CLRG - ClearingSystem - Settlement is done through a payment clearing system. *COVE - CoverMethod - Settlement is done through a cover payment. *INDA - InstructedAgent - Settlement is done by the agent instructed to execute a payment instruction. *INGA - InstructingAgent - Settlement is done by the agent instructing and forwarding the payment to the next party in the payment chain.

Value in"CLRG" | "COVE" | "INDA" | "INGA"

clearing_system?string

Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

Specifies the cash clearing system, as published in an external cash clearing system code list. External code sets can be downloaded from www.iso20022.org.

Length1 <= length <= 3

instructing_agent?|

Specifies the details to identify a financial institution.

instructed_agent?|

Specifies the details to identify a financial institution.

interbank_settlement_amount*

Amount of money moved between the instructing agent and the instructed agent.

Based on datatype ActiveCurrencyAndAmount: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

source_currency?string

Specifies the currency from which an amount is to be converted in a currency conversion

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Match^[A-Z]{3,3}$

target_currency?string

Specifies the currency into which an amount is to be converted in a currency conversion

Match^[A-Z]{3,3}$

exchange_rate?string

Specifies the factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currenty. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).

Based on datatype BaseOneRate: Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.

Lengthlength <= 12

foreign_exchange_agent?string

Agent that performed the foreign exchange operation.

Match^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$

charge_bearer*string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Specifies which party(ies) will pay charges due for processing of the instruction.

Code Name Definition: *CRED - BorneByCreditor - All transaction charges are to be borne by the creditor. *DEBT - BorneByDebtor - All transaction charges are to be borne by the debtor. *SHAR - Shared - In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor. *SLEV - FollowingServiceLevel - Charges are to be applied following the rules agreed in the service level and/or scheme.

Value in"CRED" | "DEBT" | "SHAR" | "SLEV"

charges_information?array<>

Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction.

confirmed_date?string

Specifies the date and time at which the funds are available, as reported in the ACCC status update. Date Time must be expressed as UTC/Zulu time (YYYY-MM-DDThh:mm:ss.sssZ) or local time with UTC offset (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm). Local time is not allowed.

Based on datatype ISONoLocalDateTime: an ISODateTime whereby only Zulu/UTC and Local Time with UTC offset are allowed and where local time is blocked.

Match

^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]+)?(?:Z|[+-][01]\d:[0-5]\d)?$

confirmed_amount?

Specifies the amount confirmed by the Tracker Informing Party for the ACCC-OBO1 status.

Based on datatype ActiveCurrencyAndAmount: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

intermediary_agent1?|

Specifies the details to identify a financial institution.

creditor_agent*|

Specifies the details to identify a financial institution.

Response Body

`application/json`

Empty

{
  "severity": "Fatal",
  "code": "Sw.gpi.InvalidRequest",
  "text": "Invalid request"
}

{
  "severity": "Fatal",
  "code": "Sw.gpi.FromAuthorizationFailure",
  "text": "From %From does not have the appropriate RBAC role"
}

{
  "severity": "Transient",
  "code": "Sw.gpi.NoResultFound",
  "text": "No result found"
}

{
  "severity": "Fatal",
  "code": "string",
  "text": "string",
  "user_message": "string",
  "more_info": "http://example.com"
}

{
  "severity": "Transient",
  "code": "SwAP507",
  "text": "Request cannot be processed at this time. Please try later. (header Retry-After indicates how long to wait before making a follow-up request)."
}

{
  "severity": "Transient",
  "code": "Sw.gpi.InternalError",
  "text": "Internal error"
}

{
  "severity": "Fatal",
  "code": "string",
  "text": "string",
  "user_message": "string",
  "more_info": "http://example.com"
}

{
  "severity": "Fatal",
  "code": "string",
  "text": "string",
  "user_message": "string",
  "more_info": "http://example.com"
}

{
  "severity": "Transient",
  "code": "Sw.gpi.InternalError",
  "text": "Internal error"
}

Payments Scheme

Network Interoperability Status Request

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Network Interoperability Status Request

Authorization

Path Parameters

Request Body

Response Body

204

400application/json

401application/json

404application/json

413application/json

429application/json

500application/json

503application/json

504application/json

defaultapplication/json

Example invalid_request

Example missing_mandatory_field

Example invalid_rbac

Example request_malformed

Example unknown_uetr

Example no_result_found

Example resource_not_exist

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`