Skip to content
/
Get a send transaction

Get a send transaction

Request

Retrieve the send transaction identified by the id path parameter.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the Send transaction.

curl -i -X GET \
  'https://sandbox.weavr.io/multi/sends/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of a send transaction.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

sourceobject(InstrumentId)required

The source managed account or card from where the funds were sent.

sourceFeeobject(CurrencyAmount)

The object representing a monetary amount in a particular currency.

destinationInstrumentId (object) or BeneficiaryId (object)
One of:

The destination managed account or card to where the funds were sent.

destinationAmountobject(CurrencyAmount)required

The amount, in same currency as source and destination, that was sent from the source to the destination instrument.

destinationFeeobject(CurrencyAmount)

The object representing a monetary amount in a particular currency.

transactionAmountobject(CurrencyAmount)required

The object representing a monetary amount in a particular currency.

descriptionstring, <= 255 characters^[a-zA-Z0-9\/\-?:().$_,'+\s#=!"%&*<>;\{@\r\n]*$

The description details that are passed to the beneficiary.

statestring(SendState)required

The state of the send transaction, as follows:

  • INVALID: The send transaction has failed initial validation checks.
  • INITIALISED: The initial state of a send transaction when SCA is not required.
  • PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted.
  • PENDING: The send transaction has exceeded the destination limit and is pending treasury approval.
  • APPROVED: The send transaction that was submitted has been approved.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • REJECTED: The send transaction that was submitted was rejected.
  • FAILED: There was an issue with the send transaction, and the transaction has failed.
  • RETURNED: The send transaction has been returned to the sender.
  • SCHEDULED: The send transaction will be executed at the scheduled time.
  • CANCELLED: The scheduled send transaction has been cancelled.
Enum:"INVALID""INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""PENDING_CHALLENGE""APPROVED""RETURNED""SCHEDULED"
challengeExemptionReasonstring(ChallengeExemptionReason)

The Reason the transaction was exempted from SCA verification

Enum:"LOW_VALUE""TRUSTED_BENEFICIARY"
creationTimestampinteger, (int64)required

The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.

scheduledTimestampstring(ScheduledTimestamp)^[0-9]+$

The epoch timestamp at which the transaction is scheduled to be executed.

executionTimestampstring(ExecutionTimestamp)^[0-9]+$

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

cancellationReasonstring, <= 50 characters(TransactionCancellationReason)^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

Response
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "source": {
    "id": "string",
    "type": "managed_cards"
  },
  "sourceFee": {
    "currency": "str",
    "amount": 0
  },
  "destination": {
    "id": "string",
    "type": "managed_cards"
  },
  "destinationAmount": {
    "currency": "str",
    "amount": 0
  },
  "destinationFee": {
    "currency": "str",
    "amount": 0
  },
  "transactionAmount": {
    "currency": "str",
    "amount": 0
  },
  "description": "string",
  "state": "INVALID",
  "challengeExemptionReason": "LOW_VALUE",
  "creationTimestamp": 0,
  "scheduledTimestamp": "string",
  "executionTimestamp": "string",
  "cancellationReason": "string"
}