A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
originalReferencestringRequired
A PSP reference of the original fund transfer.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK
The request has succeeded.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
merchantReferencestring
The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
messagestring
The message of the response.
originalReferencestring
A PSP reference of the original fund transfer.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
merchantReferencestring
The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
messagestring
The message of the response.
originalReferencestring
A PSP reference of the original fund transfer.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.