Service Endpoint

POST https://webservices.coriunder.cloud/Balance.svc/GetWire

Request Headers

Parameter Mandatory Type Description
Content-Type Yes string application/json
applicationToken Yes string The applicationToken provided to you by support in order to access the service.
CredentialsHeaderName Yes string The value of "CredentialsToken" returned from the Authentication call .
Signature Yes string The signature created from the values sent in the body of the request - sample script
												 hash = CryptoJS.SHA256(pm.request.body.raw + pm.collectionVariables.get('salt'));
    signature = CryptoJS.enc.Base64.stringify(hash)
    pm.variables.set("Signature", "bytes-SHA256, " + signature).

Request Fields

Parameter Mandatory Type Description
id Yes int The ID of the Wire you are want to check the status for

Response Fields

Parameter Type Description
WireID int 2896
WireApprovalStatus string Approved
WireStatus string Pending
WireOrigin string Banking
WireCurrency string EUR
WireAmount string 2.00
WireCreateDate string 2025-03-03T16:28:59
SubStatusCode string The payout provider's own code for the current status. Free text, may be null. See "Sub Status" below.
SubStatusMsg string The payout provider's own description of the current status. Free text, may be null. See "Sub Status" below.
AccountID int 3
AccountName string null
AccountPhone string null
CustomerGroups string null
SettlementID int 0
NetAmount float 0.0
Fees float 0.0
FeeFlat float 0.0
FeePercent float 0.0
BalanceStatus string null
ConversionHistory string null
RecipientData object Contains various recipient details
RecipientID int 435
RecipientBankName string ABC Bank
RecipientBankAccountNumber string 123456789
RecipientSwiftNumber string IIIGGB22
RecipientAddress string Mrs Smith 71 Cherry Court SO53 5PD UK
IsPassedAmnetCheckResult string null
OrderID int null

Request example

Code Example
{
	"id": 2896
}

Response example

Code Example
{
    "IsSuccess": true,
    "ErrorMessage": null,
    "Wires": [
        {
            "WireID": 2896,
            "WireApprovalStatus": "Approved",
            "WireStatus": "Pending",
            "WireOrigin": "Banking",
            "WireCurrency": "EUR",
            "WireAmount": "2.00",
            "WireCreateDate": "2025-03-03T16:28:59",
            "SubStatusCode": "REJ-04",
            "SubStatusMsg": "Beneficiary account closed",
            "AccountID": 3,
            "AccountName": null,
            "AccountPhone": null,
            "CustomerGroups": null,
            "SettlementID": 0,
            "NetAmount": 0.0,
            "Fees": 0.0,
            "FeeFlat": 0.0,
            "FeePercent": 0.0,
            "BalanceStatus": null,
            "ConversionHistory": null,
            "RecipientData": {
                "RecipientID": 435,
                "RecipientBankName": "ABC Bank",
                "RecipientBankAccountNumber": "123456789",
                "RecipientSwiftNumber": "IIIGGB22",
                "RecipientAddress": "Mrs Smith 71 Cherry Court SO53 5PD UK",
                "IsPassedAmnetCheckResult": null
            },
            "OrderID": null
        }
    ]
}

Wire Status Reference

WireStatus tells you where the payout itself has reached on its way to the beneficiary. It is returned as the status name, not as a number, and it is the field your own logic should branch on.

StatusFinalMeaning
PendingNoThe payout has been created and is waiting to be picked up for processing. Nothing has been sent to the bank or to the payout provider yet, and the amount is reserved against your balance.
ReviewingNoThe payout is being reviewed before it can be released, either by our compliance team or by the payout provider.
HoldNoProcessing has been stopped for clarification, or a cancellation was requested and the provider has not confirmed it yet. The payout can still move on to Completed, Canceled or Failed.
InProgressNoThe payout provider has accepted the request and is processing it.
InProgressWaitUserActionNoThe provider accepted the request but needs an action from the payer before it can continue, typically an authorisation step. Where the provider supplies one, the URL for that action is stored on the payout.
SentNoThe funds have been dispatched to the beneficiary bank and we are waiting for confirmation of receipt. This normally becomes Completed.
CompletedYesThe beneficiary was paid. This is the successful end state.
CanceledYesThe payout was cancelled before the money left. No funds were transferred and the balance reservation is released.
FailedYesThe provider declined the payout, or it could not be completed. SubStatusCode and SubStatusMsg carry the provider reason where one was given.
InvalidBeneficiaryYesRejected because the beneficiary details were not accepted - account number, IBAN, SWIFT, name or address. Correct the beneficiary and create a new payout.
TechnicalErrorYesThe payout could not be processed consistently on our side, for example the balance movement was rejected. It is reported separately from Canceled so that a technical failure can be told apart from a deliberate cancellation. Contact support quoting the payout id.

A payout does not pass through every status. Which of them it goes through depends on the payout provider and the payment scheme, so treat a status you have not seen before as valid rather than as an error, and keep checking until the payout reaches a final status.

Approval Status

WireApprovalStatus is separate from WireStatus. It reports the internal approval a payout needs before it can be released for processing, given over two independent approval levels. A payout stays Pending while its approval status is Waiting or PartiallyApproved.

Approval statusMeaning
WaitingNeither approval level has been given yet. The payout waits for approval before it can be processed.
PartiallyApprovedOne of the two approval levels has approved the payout, the other is still outstanding.
ApprovedBoth approval levels approved the payout and it is released for processing.
RejectedAt least one approval level rejected the payout. It will not be processed.

Sub Status

SubStatusCode and SubStatusMsg carry the payout provider's own explanation of the current status, passed through exactly as we received it. They are what tells you why a payout is where it is, and they are most useful when WireStatus is Failed, InvalidBeneficiary or Hold.

  • SubStatusCode is the provider's code, for example a rejection or reply code such as "REJ-04", "R01" or "ACCOUNT_CLOSED".
  • SubStatusMsg is the accompanying text, for example "Beneficiary account closed".

Both fields are free text and provider specific. There is no fixed list of values: different providers describe the same outcome with different codes and different wording, and a provider can add to or change its codes at any time. Show them to your operators and store them for reconciliation and support, but drive your logic from WireStatus, not from the sub status.

Both fields can be null or empty. A payout that never reached a provider, one still Pending or cancelled by an operator, normally carries no sub status at all, and not every provider returns one even on a failure. Always handle the null case.

Authenitcation

Learn how to access the service
Create Beneficiary

Start by creating a Beneficiary.
Create a Payout

Learn how to create a payout request.