Make External Payment
API: Ws_Banking_TransferFunds
This web service makes an external payment via the faster payment banking system where a card has an associated UK Bank Account (provided through programmes using Agency Banking). Note that the money is queued and has not necessarily entered the banking world.
Note:
-
The account is first checked to ensure that banking out is enabled.
-
The account is then checked against an issuer defined Deny list. This makes two checks: the source account is not Deny-listed; the destination account is not Deny-listed.
-
The final checks are the standard velocity/balance checks.
Record Request Description
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<WSID> |
N |
1 |
19 |
Web service ID. Must be unique for every request. For details, see the FAQs. |
Mandatory |
Mandatory |
<IssCode> |
AN |
1 |
4 |
Thredd Issuer (Program Manager) Code. Assigned by Thredd. Mandatory in the request. If only |
Mandatory |
Mandatory |
<PublicToken> |
N |
9 |
9 |
The 9 digit public token associated with the account. |
Mandatory |
Mandatory |
<Beneficiary> |
Beneficiary
|
|
|
Details of the account where the money is going to. See Beneficiary. |
Mandatory |
Mandatory |
<SEPABeneficiaryAddress> |
SEPABeneficiaryAddress |
|
|
Details of the address of the beneficiary. See SEPABeneficiaryAddress. |
Optional |
Optional |
<Reference> |
AN |
|
|
A reference for the payment. Cannot contain the following characters: (;),( ->),(CR- Carriage Return),(LF – Line Feed). |
Optional |
Optional |
<AmountOfPayment> |
N |
|
|
The amount of the payment. |
Mandatory |
Mandatory |
<AuthorisedBy> |
N |
|
|
Who initiated the payment (used for display in Smart Client |
Optional |
Optional |
<Currency> |
N |
3 |
3 |
The 3 digit ISO currency code. Currently defaults to GBP. |
Optional |
Optional |
<PaymentMethod> |
ENUM_PaymentMethod
|
|
|
How the payment is being made. Set this to FasterPaymentOut or PeerToPeerOut. See ENUM_PaymentMethod. |
Mandatory |
Mandatory |
<Direction> |
ENUM_PaymentDirection
|
|
|
The direction of the payment. This must be set to Outbound. |
Mandatory |
Mandatory |
Response
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<WSID> |
N |
1 |
19 |
Web service ID. Must be unique for every request. For details, see the FAQs. |
Mandatory |
Mandatory |
<Response> |
ENUM_TransferFundsResult
|
|
|
The response from the call. See ENUM_TransferFundsResult. |
Mandatory |
|
<TransactionID> |
N |
|
|
The unique transaction ID for the transaction, generated by Thredd. |
|
Optional |
<ErrorText> |
AN |
|
|
Human readable text of the error that occurred. Should be read in conjunction with the |
|
Optional |
<ActionCode> |
N |
3 |
3 |
The action code for the response. See Action Codes. |
|
Mandatory |
<RecipientActionCode> |
N |
3 |
3 |
The action code of attempting to apply the transfer to the Beneficiary account (See Beneficiary). If the action code is 552 a manual balance adjustment may be required. Contact your Account Manager for details. |
|
|
<RecipientTransactionID> |
N |
|
|
The unique Thredd transaction ID from applying the transaction to the recipient account. |
|
|
<BankTransactionId> |
N |
|
|
The bank transaction ID from applying the transaction to the bank transaction table. (For Thredd internal use only) |
|
|
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hyp="http://www.globalprocessing.ae/HyperionWeb">
<soapenv:Header>
<hyp:AuthSoapHeader>
<hyp:strUserName>******</hyp:strUserName>
<hyp:strPassword>******</hyp:strPassword>
</hyp:AuthSoapHeader>
</soapenv:Header>
<soapenv:Body>
<hyp:Ws_Banking_TransferFunds>
<hyp:request>
<hyp:WSID>76565675</hyp:WSID>
<hyp:IssCode>PMT</hyp:IssCode>
<hyp:PublicToken>123456789</hyp:PublicToken>
<hyp:Beneficiary>
<hyp:AccountNumber>98765432</hyp:AccountNumber>
<hyp:SortCode>333333</hyp:SortCode>
<hyp:AccountName>S Wilson</hyp:AccountName>
</hyp:Beneficiary>
<SEPABeneficiaryAddress> ;
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostTown>string</PostTown>
<PostCode>string</PostCode>
<Country>string</Country>
</SEPABeneficiaryAddress>
<hyp:Reference>test load</hyp:Reference>
<hyp:AmountOfPayment>7.00</hyp:AmountOfPayment>
<hyp:AuthorisedBy>S Wilson</hyp:AuthorisedBy>
<hyp:Currency>?</hyp:Currency>
<hyp:PaymentMethod>?</hyp:PaymentMethod>
<hyp:Direction>?</hyp:Direction> </hyp:request>
</hyp:Ws_Banking_TransferFunds>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<Ws_Banking_TransferFundsResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
<Ws_Banking_TransferFundsResult>
<WSID>76565675</WSID>
<Response>Success</Response>
<TransactionID>60199453</TransactionID>
<ErrorText></ErrorText>
<ActionCode>000</ActionCode>
<RecipientActionCode>000</ RecipientActionCode >
<RecipientTranactionID>6446546565654</RecipientTranactionID>
<BankTranactionID>5478934</BankTranactionID>
</Ws_Banking_TransferFundsResult>
</Ws_Banking_TransferFundsResponse>
</soap:Body>
</soap:Envelope>