Create Internal Transfer

Create an internal transfer between two OpenPayd accounts held in the same currency.

post/transactions

Request

Base URL
https://sandbox.openpayd.com/api
URL
https://sandbox.openpayd.com/api/transactions
Auth
API key in header Authorization

Headers

idempotency-keystring

Optional header for retrying requests without accidentally creating the same transaction twice.

Request body

typestring required

TRANSFER

commentstring

Reference comment associated with the transfer.

Response

200

idstring

shortIdstring

accountIdstring

createdDatestring

updatedDatestring

paymentDateunknown

transactionIdstring

transactionCategorystring

typestring

paymentTypeunknown

sourcestring

destinationstring

buyAmountunknown

fxRateunknown

midMarketRateunknown

fixedSideunknown

statusstring

failureReasonunknown

commentstring

transactionReferenceunknown

referenceAmountunknown

accountHolderIdstring

originalTransactionIdunknown

Example response

{
  "id": "Y1dHaXhLNFkvbXc3TnA1Y0ltOW5OUT09",
  "shortId": "20200727-E9OUFB",
  "accountId": "V2w1cHp4KzQxUjlLQVNnZkJNTXZadz09",
  "createdDate": "2020-07-27T08:01:43.834Z",
  "updatedDate": "2020-07-27T08:01:43.834Z",
  "transactionId": "196ca5f1-a8b8-4737-b4f5-d0c1ad7b3e62",
  "transactionCategory": "OTHER",
  "type": "TRANSFER",
  "sourceInfo": {
    "type": "ACCOUNT",
    "identifier": "ZUxSUDVYVWkvVWhlTXVoVDZ1SzRhZz09",
    "internalAccountId": "EUR08561376339076"
  },
  "destinationInfo": {
    "type": "ACCOUNT",
    "identifier": "R3JMU3FJQ2hCR1ZqY0s2THFZUVhaZz09",
    "internalAccountId": "EUR98561786339896"
  },
  "source": "GBP10874129900470",
  "destination": "Webhook",
  "totalAmount": {
    "value": 50,
    "currency": "GBP"
  },
  "amount": {
    "value": 50,
    "currency": "GBP"
  },
  "fee": {
    "currency": "GBP"
  },
  "runningBalance": {
    "value": 9939,
    "currency": "GBP"
  },
  "status": "INITIATED",
  "comment": "Tranfer to another account",
  "accountHolderId": "b70af316-92d4-4621-b395-ea933cd4ac9d"
}

Changes

No recorded changes to this operation across all 1 revision of this API.