tenant-transaction-read
or tenant-admin
Gets an Order Instruction by the orderRef
and instructionRef
.
OK - Returns the Instruction response.
Unauthorized
Forbidden
Instruction not found
{- "_links": { },
- "created": 1662105575226,
- "lastUpdated": 1662105912747,
- "direction": "DEBIT",
- "status": "COMPLETED",
- "customerRef": "Some_Ref",
- "amount": 10,
- "currency": "EUR",
- "country": "AT",
- "settledByDate": "2023-12-15",
- "forecastedSettlementDate": null,
- "actualSettlementDate": null,
- "executionTimestamp": null,
- "financialInstrument": {
- "financialInstrumentId": "41045ebe-7c67-4393-855e-f65d1dd0ae07",
- "source": "NONE",
- "canUpdate": true
}, - "scheme": {
- "schemeId": "EEAB9BBF6F8FA16D711798D14B65E066",
- "source": "MANUALLY_SET",
- "canUpdate": true
}, - "metadata": {
- "key1": "payment/1",
- "key2": "payment/2"
}, - "transaction": {
- "transactionId": "a16699d2-454d-6bec-785d-0823cb79e86a",
- "financialInstrumentId": "a16349d2-454d-6bec-785d-0823cb79e86a",
- "createdTimestamp": 1662543264053,
- "lastUpdatedTimestamp": 1662543264006,
- "amount": 12.34,
- "netAmount": 10,
- "status": "PROCESSING",
- "additionalInformation": "Test",
- "app": {
- "appId": "STRIPE",
- "appTransactionId": "pi_3LfKdwHm8hoYQJyN0lk60ru7",
- "appBatchId": null,
- "supportDetails": {
- "customerId": "cus_MH3lMCEjrZ4O0Q"
}
}, - "refunds": [
- {
- "refundId": "07924e91-3470-442d-8c8a-81282b41b74e",
- "createdTimestamp": 1662543387150,
- "lastUpdatedTimestamp": 1662543388793,
- "status": "COMPLETED",
- "amount": 2.34
}
], - "chargebacks": [
- {
- "id": "cf223726-7ac8-4294-bb4b-75748b619268",
- "network": "STRIPE",
- "status": "PENDING",
- "amount": 0,
- "claimed": "0001-01-01",
- "created": "0001-01-01T00:00:00Z"
}
]
}, - "failed": {
- "failedTimestamp": 0,
- "errorCode": null,
- "reason": null
}, - "cancelled": {
- "cancelledTimestamp": 0,
- "identity": null,
- "reason": null
}
}
tenant-transaction-write
or tenant-admin
Updates a new Instruction by orderRef
and instructionRef
.
No Content.
Unauthorized
{- "financialInstrumentId": "string",
- "amount": "string",
- "currency": "string",
- "country": "string",
- "settledByDate": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}
tenant-transaction-write
or tenant-admin
Create a new Order Instruction for the specified orderRef
.
No Content.
Unauthorized
{- "instructionRef": "string",
- "customerRef": "string",
- "direction": "string",
- "financialInstrumentId": "string",
- "amount": "string",
- "currency": "string",
- "country": "string",
- "settledByDate": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}
tenant-transaction-write
or tenant-admin
Cancels an Instruction.
No Content.
Unauthorized
{- "reason": "string"
}
tenant-transaction-read
or tenant-admin
Gets an Order by the orderRef
.
OK - Returns the Order response.
Unauthorized
{- "_links": { },
- "created": 0,
- "instructionRefs": [
- "string",
- "string",
- "string"
], - "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}, - "customerDefaults": {
- "customerRef1": {
- "financialInstrument": {
- "financialInstrumentId": "41045ebe-7c67-4393-855e-f65d1dd0ae07",
- "source": "string"
}, - "scheme": {
- "schemeId": "string",
- "source": "string"
}, - "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}, - "customerRef2": {
- "financialInstrument": {
- "financialInstrumentId": "6c157f58-ac08-44e9-b116-5eae465f4244",
- "source": "string"
}, - "scheme": {
- "schemeId": "string",
- "source": "string"
}, - "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}, - "customerRef3": {
- "financialInstrument": {
- "financialInstrumentId": "9aba1ffd-7e14-4ab7-852e-8c7e0bd59fed",
- "source": "string"
}, - "scheme": {
- "schemeId": "string",
- "source": "string"
}, - "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}
}
}
tenant-transaction-write
or tenant-admin
Create a new Order.
If you create the Order without any instructions
then the response will be 201 - Created
.
If you create the Order with instructions
then the response will be 202 - Accepted
.
Created.
Accepted.
Unauthorized
{- "orderRef": "string",
- "instructions": [
- {
- "instructionRef": "string",
- "customerRef": "string",
- "direction": "string",
- "financialInstrumentId": "string",
- "amount": "string",
- "currency": "string",
- "country": "string",
- "settledByDate": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}, - {
- "instructionRef": "string",
- "customerRef": "string",
- "direction": "string",
- "financialInstrumentId": "string",
- "amount": "string",
- "currency": "string",
- "country": "string",
- "settledByDate": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}, - {
- "instructionRef": "string",
- "customerRef": "string",
- "direction": "string",
- "financialInstrumentId": "string",
- "amount": "string",
- "currency": "string",
- "country": "string",
- "settledByDate": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}
], - "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}, - "customerDefaults": {
- "customerRef1": {
- "financialInstrumentId": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}, - "customerRef2": {
- "financialInstrumentId": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}, - "customerRef3": {
- "financialInstrumentId": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}
}
}
tenant-transaction-write
or tenant-admin
Updates the Orders metadata
by orderRef
.
No Content.
Unauthorized
{- "key1": "string",
- "key2": "string",
- "key3": "string"
}
tenant-transaction-write
or tenant-admin
Updates the customerDefaults
for the given customerRef
on the Order specified by orderRef
.
Note - This request allows you to update all the properties at once for the specified customerRef
.
You can also call specific endpoints for updating Metadata (see Update Metadata for Customer Default), Scheme Id (see Update Scheme Id for Customer Default), Financial Instrument Id (see Update Financial Instrument Id for Customer Default).
No Content.
Unauthorized
{- "financialInstrumentId": "string",
- "schemeId": "string",
- "metadata": {
- "key1": "string",
- "key2": "string",
- "key3": "string"
}
}
tenant-transaction-write
or tenant-admin
Deletes the customerDefaults
for the given customerRef
on the Order specified by orderRef
.
No Content.
Unauthorized
tenant-transaction-write
or tenant-admin
Updates the financialInstrumentId
in customerDefaults
for the given customerRef
on the Order specified by orderRef
.
No Content.
Unauthorized
{- "financialInstrumentId": "string"
}
tenant-transaction-write
or tenant-admin
Updates the schemeId
in customerDefaults
for the given customerRef
on the Order specified by orderRef
.
No Content.
Unauthorized
{- "schemeId": "string"
}
tenant-transaction-write
or tenant-admin
Updates the metadata
in customerDefaults
for the given customerRef
on the Order specified by orderRef
.
No Content.
Unauthorized
{- "key1": "string",
- "key2": "string",
- "key3": "string"
}
tenant-transaction-write
or tenant-admin
Claims a Reward by the customerRef
and instructionRef
.
The response location
header value will contain the URL to call while the reward is claimed by the reward provider.
The time taken to claim a reward can vary so we give you a TransactionId to check against while we process the claim in the background.
See Get a Reward by Transaction Id for more information.
Accepted - Returns a link in the location
header response.
Unauthorized
{- "rewardId": "string"
}