Transfer

Retrieve a transfer associated with the specified id-in-client.

GET /omni-omni/v1/transfers/{id-in-client}

🌱 Retrieve a transfer associated with the specified id-in-client

cURL

curl --request GET \
  --url https://backend.sandbox.ecrop.de/ecrop-command/omni-omni/v1/transfers/{id-in-client} \
  --header 'Authorization: Bearer <token>'

200

{
  "idInClient": "<string>",
  "amount": 123,
  "assetName": "<string>",
  "clientWebhook": "<string>",
  "currency": "<string>",
  "errorMessage": "<string>",
  "quantity": 123,
  "recipientPartyEmail": "<string>",
  "recipientPayoutIdentifier": "<string>",
  "senderPartyEmail": "<string>",
  "senderPayoutIdentifier": "<string>",
  "transferDateTime": "2023-11-07T05:31:56Z",
  "transferDocument": {
    "description": "<string>",
    "title": "<string>",
    "id": 123,
    "url": "<string>"
  },
  "webhookResult": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id-in-client · string · required

Response

200

application/json

Transfer retrieved successfully

idInClient · string · required

Pattern: [\w-]+

amount · number

assetName · string

bankType · enum<string>

Available options: PRIVATE_BANK, CROSS_BORDER, STATE_BANK

clientWebhook · string

currency · string

errorMessage · string · read-only

paymentType · enum<string>

Available options: CASH, CRYPTO_CURRENCY, CHECKS, DIGITAL_WALLETS, CREDIT_DEBIT_CARD, LETTER_OF_CREDIT, WIRED_TRANSFER, ELECTRONIC_FUNC_TRANSFER

quantity · number

recipientPartyEmail · string

recipientPayoutIdentifier · string

senderPartyEmail · string

senderPayoutIdentifier · string

state · enum<string> · read-only

Available options: WAITING_FOR_SIGNATURES, PROCESSING, FAILED, DONE

transferDateTime · string<date-time>

transferDocument · object

Show child attributes

webhookResult · string · read-only