tenant-transaction-read
or tenant-admin
OK - Returns the Customer response.
Unauthorized
{- "_links": {
- "property1": { },
- "property2": { }
}, - "status": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "financialInstruments": [
- {
- "id": "be4bc9c1-c3fb-43c8-ab1a-908a86123682",
- "type": "MANDATE:BACS_DIRECT_DEBIT",
- "status": "ACTIVE",
- "displayName": "Bacs direct debit mandate: GHXML21P",
- "createdTimestamp": 1662106155297,
- "capabilities": {
- "valueType": "VARIABLE",
- "usageType": "MULTIPLE",
- "canCredit": false,
- "canDebit": true
}
}
]
}
tenant-transaction-write
or tenant-admin
object Metadata is useful for storing additional, structured information on an object. |
Accepted.
Unauthorized
{- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
tenant-admin
ONLY
This API call will irrecoverably trash any personally identifiable data about a customer in accordance with GDPR.
Success
Unauthorized
tenant-transaction-read
or tenant-admin
OK - Returns the financial instrument response.
Unauthorized
{- "id": "be4bc9c1-c3fb-43c8-ab1a-908a86123682",
- "attempt": 1,
- "type": "VISA",
- "createdDate": 1662106112679,
- "orderRef": "Testing_2",
- "instructionRef": "PAYMENT-01",
- "amount": 10,
- "currency": "EUR"
}
tenant-transaction-read
or tenant-admin
OK - Returns the transaction response.
Unauthorized
Forbidden
Transaction not found
{- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "be4bc9c1-c3fb-43c8-ab1a-908a86123682",
- "type": "STRIPE",
- "createdTimestamp": 1662106112679,
- "settlementDate": "2023-12-15",
- "lastUpdatedTimestamp": 1662106112679,
- "status": "COMPLETED",
- "app": {
- "appId": "STRIPE",
- "appTransactionId": "pi_3LdUv5Hm8hoYQJyN1zEjvXpY",
- "appBatchId": null,
- "supportDetails": {
- "property1": "paymentDescriptorField",
- "property2": "paymentDescriptorField"
}
}, - "orderRef": "Testing_2",
- "instructionRef": "PAYMENT-01",
- "amount": 10,
- "currency": "EUR",
- "failedErrorCode": null,
- "failedReason": null,
- "netAmount": 10,
- "capabilities": {
- "isRefundable": true
}, - "refunds": [
- {
- "refundId": "3324897f-393a-4bf6-b3af-0b999cbc2521",
- "createdTimestamp": 1662106155297,
- "lastUpdatedTimestamp": 1662106162568,
- "status": "Failed",
- "amount": 1.5
}
], - "chargebacks": [
- {
- "id": "e8febe3c-cc7d-49b1-8f54-cbde4341676c",
- "network": "STRIPE",
- "status": "FAILED",
- "amount": 10,
- "claimed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z"
}
]
}
tenant-transaction-write
or tenant-admin
Create an International Bank Account financial instrument.
Created.
Bad Request
Unauthorized
Forbidden
{- "name": "John Doe",
- "iban": "GB09KDUX86642922629868",
- "bic": "CGDITLD3"
}
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "id": "string"
}
tenant-transaction-write
or tenant-admin
Create a UK Bank Account financial instrument.
Created.
Bad Request
Unauthorized
Forbidden
{- "accountHolderName": "JOHN DOE",
- "accountNumber": "99999911",
- "sortCode": "111211"
}
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "id": "string"
}
tenant-transaction-read
or tenant-admin
OK - Returns the created refund response.
Bad Request
Unauthorized
Forbidden
{- "amount": 0,
- "reason": "string"
}
{- "refundId": "3324897f-393a-4bf6-b3af-0b999cbc2521",
- "status": "string"
}
tenant-transaction-read
or tenant-admin
The Refund object.
Unauthorized
Forbidden
Refund not found
{- "refundId": "1ae4fddd-4cf6-493d-b171-2dbcfd93ec08",
- "status": "COMPLETED",
- "amount": 12.34,
- "currency": "EUR",
- "refundedTransactionId": "26fc43b3-88a5-426f-bfca-d030a4ba3be6",
- "reason": "Customer returned purchased item nr 123.",
- "createdTimestamp": "1636123359241",
- "lastUpdatedTimestamp": "1636123360",
- "app": {
- "appId": "IMBURSE_TESTING_V2",
- "appTransactionId": "26fc43b3-88a5-426f-bfca-d030a4ba3be6",
- "supportDetails": { }
}, - "failedResponse": null
}