Transaction Requests
Make payments using Transaction Requests.
Transaction Requests
In OBP, payments are made via Transaction Requests. A Transaction Request is an instruction to move money from one account to another. It goes through a lifecycle of validation, optional challenge (e.g. OTP), and completion before a Transaction is created.
How It Works
- Create a Transaction Request — specify the from account, to account, amount, and payment type
- Challenge (optional) — if the amount exceeds a threshold or policy requires it, the user must answer a challenge (e.g. enter an OTP)
- Answer the Challenge — submit the challenge response to authorise the payment
- Transaction Created — once authorised, the system creates the actual Transaction
Transaction Request Types
OBP supports several payment types. The type determines what fields are required and how the payment is routed:
| Type | Description |
|---|---|
SANDBOX_TAN | Transfer between accounts on the same OBP sandbox instance. Good for testing. |
ACCOUNT | Transfer to another account identified by bank_id and account_id. |
ACCOUNT_OTP | Same as ACCOUNT but always requires an OTP challenge. |
COUNTERPARTY | Transfer to a pre-registered counterparty. |
SEPA | SEPA credit transfer using an IBAN. |
FREE_FORM | Flexible format for custom payment types. |
SIMPLE | Simple transfer with minimal required fields. |
Creating a Transaction Request
First, check which transaction request types are supported for your account:
GET /obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-typesThen create a Transaction Request. Here is an example using the ACCOUNT type(see full schema in API Explorer):
POST /obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT/transaction-requestsRequest body:
{
"to": {
"bank_id": "TARGET_BANK_ID",
"account_id": "TARGET_ACCOUNT_ID"
},
"value": {
"currency": "EUR",
"amount": "10.00"
},
"description": "Payment for invoice #123"
}Example with curl:
curl -X POST "https://YOUR_OBP_HOST/obp/v6.0.0/banks/my-bank/accounts/my-account/owner/transaction-request-types/ACCOUNT/transaction-requests" \
-H "Content-Type: application/json" \
-H "Authorization: DirectLogin token=YOUR_TOKEN" \
-d '{
"to": {
"bank_id": "target-bank",
"account_id": "target-account"
},
"value": {
"currency": "EUR",
"amount": "10.00"
},
"description": "Test payment"
}'Handling Challenges
If the response includes a challenge object with a challenge_type and id, the payment requires authorisation:
{
"id": "txn-req-123",
"type": "ACCOUNT",
"status": "INITIATED",
"challenge": {
"id": "challenge-456",
"challenge_type": "OBP_TRANSACTION_REQUEST_CHALLENGE",
"allowed_attempts": 3
}
}Answer the challenge(see full schema in API Explorer):
POST /obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT/transaction-requests/TXN_REQ_ID/challenge{
"id": "challenge-456",
"answer": "123456"
}SEPA Payments
For SEPA transfers, use the SEPA type with an IBAN:
{
"to": {
"iban": "DE89370400440532013000"
},
"value": {
"currency": "EUR",
"amount": "25.00"
},
"description": "SEPA payment",
"charge_policy": "SHARED"
}Counterparty Payments
To pay a pre-registered counterparty, reference it by ID(see full schema in API Explorer):
{
"to": {
"counterparty_id": "cpty-789"
},
"value": {
"currency": "EUR",
"amount": "50.00"
},
"description": "Payment to supplier"
}Transaction Request Status
You can check the status of your transaction requests:
GET /obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requestsPossible statuses:
- INITIATED — created, awaiting challenge response
- COMPLETED — payment executed, transaction created
- FAILED — payment failed (insufficient funds, validation error, etc.)
Required Entitlements
To create transaction requests, the user typically needs to be the account owner or have access via a View that permits payments. No special entitlements are required for the account owner to make payments from their own accounts.
Related
- OBP Concepts — understand accounts, views, and the data model
- Consents — Variable Recurring Payments (VRP) using consents
- All Transaction Request endpoints in the API Explorer