Download OpenAPI specification:Download
This method requests the creation of a cash operation barcode for the customer to present at the POS of a participating Viacash retailer. Note that this endpoint requires a change request.
Once the customer confirms the change request, Viafintech processes the request and then the Solaris API returns a payload containing an EAN-13 barcode with an expiration date and a status.
Each person may only have one active (i.e., PENDING/CREATED) cash operation request of each type (payin/payout) at a time.
Ensure that the amount of the cash operation falls within the allowed range and does not exceed any daily limits. See the Viacash documentation for more information about limits.
Cash operation creation initiated successfully. The customer must confirm the change request.
One of the following problems occurred: the person's status is invalid, the account's status is invalid, the cash operation exceeds the daily transfer limit, the customer has too many active cash operations, or the request properties have invalid values.
Unauthorized action. See the examples for various scenarios in which the API would return a 403
error for this request.
The person or account cannot be found.
You have reached a rate limit of maximum created transactions per time period.
Internal server error.
{- "idempotency_key": "8695a767-2d7b-460b-9c4c-dceb82fb6566",
- "reference": "de430446-1da7-4adf-b440-be6005b5cf9f",
- "provider": "barzahlen",
- "type": "PAYIN",
- "amount": {
- "currency": "EUR",
- "unit": "cents",
- "value": 5000
}
}
{- "change_request_id": "de430446-1da7-4adf-b440-be6005b5cf9f",
- "id": "8695a767-2d7b-460b-9c4c-dceb82fb6566"
}
Returns the cash operation specified in the request URL.
Cash operation fetched successfully.
Invalid request.
You are not authorized to perform this action.
The cash operation cannot be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/cash_operations/{cash_operation_id}'
{- "id": "b56c770a-4ed8-4542-9a51-c4b2c70c09ee",
- "barcode_ean_13": "4051234567890",
- "expires_at": "2021-10-21T14:36:58.207Z",
- "status": "PENDING",
- "reference_id": "34abaa5a-cd7a-4d1c-80e7-e3d48eb8efef",
- "person_id": "587d8a5d-20c0-4a2f-852c-361787ac2e28"
}
Cancels the cash operation specified in the request URL. You can only use this endpoint to cancel cash operations with a status of PENDING
or CREATED
. This method will trigger the CASH_OPERATION_STATUS_CHANGED
webhook.
Cancellation request accepted.
The cash operation does not have a status value of PENDING
or CREATED
and therefore cannot be canceled.
You are not authorized to perform this action.
The cash operation cannot be found.
Internal server error.
curl -i -X DELETE \ 'https://api.solaris-sandbox.de/v1/cash_operations/{cash_operation_id}'
The cash operation does not have a status value of PENDING
or CREATED
and therefore cannot be canceled.
{- "errors": [
- {
- "id": "de430446-1da7-4adf-b440-be6005b5cf9f",
- "status": 400,
- "code": "invalid_model",
- "title": "Invalid Model",
- "detail": "Cash operation status cannot be set from PAID to CANCELED."
}
]
}
This endpoint allows you to manually update the status of a cash operation. You may only use this endpoint on Sandbox. You may only use this endpoint on cash operations with a status
of CREATED
, and you may only supply the values PAID
, CANCELED
, or EXPIRED
.
Cash operation patched successfully.
The cash operation does not have a status value of CREATED
and therefore cannot be updated.
The cash operation cannot be found.
Internal server error.
{- "status": "PAID"
}
The cash operation does not have a status value of CREATED
and therefore cannot be updated.
{- "errors": [
- {
- "id": "de430446-1da7-4adf-b440-be6005b5cf9f",
- "status": 400,
- "code": "invalid_model",
- "title": "Invalid Model",
- "detail": "Not allowed new slip status CREATED."
}
]
}
Returns a paginated list of all associated with the customer account specified in the request URL.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The account cannot be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/accounts/{account_id}/cash_operations?filter%5Bstatus%5D=PENDING&page%5Bnumber%5D=1&page%5Bsize%5D=10'
[- {
- "id": "b56c770a-4ed8-4542-9a51-c4b2c70c09ee",
- "barcode_ean_13": "4051234567890",
- "expires_at": "2021-10-21T14:36:58.207Z",
- "status": "PENDING",
- "reference_id": "34abaa5a-cd7a-4d1c-80e7-e3d48eb8efef",
- "person_id": "587d8a5d-20c0-4a2f-852c-361787ac2e28"
}, - {
- "id": "1c641102-b50d-4565-9e31-fdef7246e9e8",
- "barcode_ean_13": "4051434567830",
- "expires_at": "2021-10-21T14:00:58.207Z",
- "status": "PAID",
- "reference_id": "70fa983c-6c22-49f3-b9ad-69af81668494",
- "person_id": "587d8a5d-20c0-4a2f-852c-361787ac2e28"
}
]
Returns an array containing all clearing profiles under your control.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ https://api.solaris-sandbox.de/v1/clearing_profiles \ -H 'Solaris-Partner-Id: string'
[- {
- "id": "8264234444a2a4cb1ee33666259c5513pacp",
- "iban": "DE97110101004884374432",
- "allowed_booking_types": [
- "CURRENCY_EXCHANGE_PARTNER"
], - "customer_authentication": true
}
]
Creates a credit clearing transaction on the account specified in the request URL. The funds will be sent from this account to the account defined in the clearing profile sent in the request body.
The content of the request.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "amount": {
- "value": 1000,
- "currency": "EUR",
- "unit": "cents"
}, - "booking_type": "INTERNAL_TRANSFER",
- "description": "Example clearing transaction",
- "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
- "reference": "ert123456789ert",
- "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}
{- "id": "3f4e761f500e4c11a6627b4d90daaec4",
- "status": "EXECUTED",
- "account_id": "06659ff514934b28800b5650d109cacc",
- "account_iban": "DE43110101005555555555",
- "clearing_account_iban": "DE30110101001234567890",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "description": "Example description",
- "booking_type": "SEPA_CREDIT_TRANSFER",
- "valuta_date": "2022-04-22",
- "transaction_type": "CLEARING_TRANSACTION",
- "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
- "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}
Creates a debit clearing transaction to the account specified in the request URL. Funds will be drawn from the account defined in the clearing profile to the account in the URL.
The content of the request.
The operation was successful.
Unexpected error
{- "amount": {
- "value": 1000,
- "currency": "EUR",
- "unit": "cents"
}, - "booking_type": "INTEREST_ACCRUED",
- "description": "Example clearing transaction",
- "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
- "reference": "ert123456789ert",
- "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}
{- "id": "3f4e761f500e4c11a6627b4d90daaec4",
- "status": "EXECUTED",
- "account_id": "06659ff514934b28800b5650d109cacc",
- "account_iban": "DE43110101005555555555",
- "clearing_account_iban": "DE30110101001234567890",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "description": "Example description",
- "booking_type": "SEPA_CREDIT_TRANSFER",
- "valuta_date": "2022-04-22",
- "transaction_type": "CLEARING_TRANSACTION",
- "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
- "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}
Returns the clearing transaction specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/accounts/{account_id}/clearing_transactions/{clearing_transaction_id}'
{- "id": "3f4e761f500e4c11a6627b4d90daaec4",
- "status": "EXECUTED",
- "account_id": "06659ff514934b28800b5650d109cacc",
- "account_iban": "DE43110101005555555555",
- "clearing_account_iban": "DE30110101001234567890",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "description": "Example description",
- "booking_type": "SEPA_CREDIT_TRANSFER",
- "valuta_date": "2022-04-22",
- "transaction_type": "CLEARING_TRANSACTION",
- "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
- "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}
Creates a Top-Up for the person's account specified in the request URL.
Calling this endpoint will begin the payment process with Solaris and its
acquiring partner (e.g., Stripe).
Note that you must provide the
returned client_secret
to the Acquirer's SDK (e.g., the Stripe
PaymentIntent
).
The Top-Up was successfully created.
There was an error on the client side.
You are not authorized to perform this action.
The model could not be found.
Internal server error.
{- "amount": {
- "value": 10000,
- "currency": "EUR"
}, - "payment_method_id": "string"
}
{- "id": "b76cdcc321d345618084feedc47bbb1d",
- "amount": {
- "value": 10000,
- "currency": "EUR"
}, - "acquirer_error_code": null,
- "acquirer_decline_code": null,
- "cancellation_reason": "abandoned",
- "decline_reason": null,
- "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
- "status": "ACCEPTED",
- "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}
Returns an array containing all Top-Ups for the person's account specified in the request URL.
The operation was successful.
There was an error on the client side.
You are not authorized to perform this action.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/topups?filter%5Bstatus%5D=ACCEPTED&filter%5Binstruction_id%5D=string'
[- {
- "id": "b76cdcc321d345618084feedc47bbb1d",
- "amount": {
- "value": 10000,
- "currency": "EUR"
}, - "acquirer_error_code": null,
- "acquirer_decline_code": null,
- "cancellation_reason": "abandoned",
- "decline_reason": null,
- "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
- "status": "ACCEPTED",
- "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}
]
Returns the Top-Up with the ID specified in the request URL.
The Top-Up was found.
You are not authorized to perform this action.
The model could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/topups/{topup_id}'
{- "id": "b76cdcc321d345618084feedc47bbb1d",
- "amount": {
- "value": 10000,
- "currency": "EUR"
}, - "acquirer_error_code": null,
- "acquirer_decline_code": null,
- "cancellation_reason": "abandoned",
- "decline_reason": null,
- "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
- "status": "ACCEPTED",
- "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}
Cancels the Top-Up specified in the request URL. Specify the reason for the cancellation in the request body.
The Top-Up was cancelled.
There was an error on the client side.
You are not authorized to perform this action.
The model could not be found.
Internal server error.
{- "cancellation_reason": "abandoned"
}
{- "id": "b76cdcc321d345618084feedc47bbb1d",
- "amount": {
- "value": 10000,
- "currency": "EUR"
}, - "acquirer_error_code": null,
- "acquirer_decline_code": null,
- "cancellation_reason": "abandoned",
- "decline_reason": null,
- "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
- "status": "ACCEPTED",
- "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}
Returns an array containing all payment methods that have been stored for the person specified in the request URL.
The operation was successful.
There was an error on the client side.
You are not authorized to perform this action.
The model could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/topups/payment_methods'
[- {
- "person_id": "18de883f507d49b8a074519c73cecper",
- "payment_method_id": "53165f2b3a8846bd9fd344342a6093d6",
- "card_last4": "7654",
- "card_brand": "mastercard"
}
]
Deletes the payment method with the ID specified in the request URL.
The operation was successful.
There was an error on the client side.
You are not authorized to perform this action.
The model could not be found.
Internal server error.
curl -i -X DELETE \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/topups/payment_methods/{payment_method_id}'
{- "payment_method_id": "53165f2b3a8846bd9fd344342a6093d6"
}
Initiates a transaction between the main- and sub-account of a single customer. This transaction does not require a change request. Both the account owner and any authorized person on the account may initiate this type of transaction.
This transaction already exists.
Successful result of the operation.
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "recipient_iban": "DE32110101001000000029",
- "description": "Example transaction",
- "amount": {
- "value": 1000,
- "currency": "EUR"
}
}
{- "id": "68df7a63b2ad4a16907eeac2cf484275",
- "reference": "d91eba3a-882c-4ded-a7e7-3c1dc24eaf0f",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "description": "Description",
- "recipient_iban": "DE43110101005555555555",
- "created_at": "2022-04-22T16:02:54Z"
}
Tops up a prepaid card by transferring money from an EMONEY_PREPAID_POOLING
account to an EMONEY_PREPAID
account.
This transaction already exists.
Transaction has been created
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "amount": {
- "value": 1000,
- "currency": "EUR"
}, - "recipient_iban": "DE32110101001000000029",
- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "description": "TopUp of employee account"
}
{- "id": "528ebf2616c54c25b706a425c05ad70f",
- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "recipient_iban": "DE87110101001000057123",
- "description": "string",
- "created_at": "2021-01-01T00:00:00Z"
}
Pays out money from a prepaid card by transferring money from an EMONEY_PREPAID
account to an EMONEY_PREPAID_POOLING
account.
This transaction already exists.
Transaction has been created
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "amount": {
- "value": 1000,
- "currency": "EUR"
}, - "recipient_iban": "DE32110101001000000029",
- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "description": "Removing money from employee account"
}
{- "id": "528ebf2616c54c25b706a425c05ad70f",
- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "recipient_iban": "DE87110101001000057123",
- "description": "string",
- "created_at": "2021-01-01T00:00:00Z"
}
Transfers money between an EMONEY_PREPAID_POOLING
and an EMONEY_PARKING
account.
This transaction already exists.
Transaction has been created
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "amount": {
- "value": 1000,
- "currency": "EUR"
}, - "recipient_iban": "DE32110101001000000029",
- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "description": "TopUp of Employee account"
}
{- "id": "528ebf2616c54c25b706a425c05ad70f",
- "reference": "73a46685-8ac6-4fff-9d36-55288523d879",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "recipient_iban": "DE87110101001000057123",
- "description": "string",
- "created_at": "2021-01-01T00:00:00Z"
}
Returns an array containing all partner remittances for all of your customers.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/partner_remittances?page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Baccount_id%5D=string&filter%5Bstatus%5D=string'
[- {
- "id": "2c7da6c316a34fd1915cb9fb2ccc632e",
- "receiver_first_name": "Max",
- "receiver_last_name": "Mustermann",
- "receiver_address": {
- "line_1": "Musterstrasse",
- "line_2": "string",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "receiver_account_number": "DE72110101001000014344",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "status": "string",
- "description": "string",
- "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
- "sender": {
- "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc",
- "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
- "first_name": "Peter",
- "last_name": "Testmann",
- "iban": "DE13110101014386274299"
}
}
]
Creates a partner remittance transaction for the account specified in the request URL. Note that this endpoint requires a change request.
The content of the request.
receiver_first_name | string The receiver's first name. |
receiver_last_name | string The receiver's last name. |
object The receiver's address. | |
receiver_account_number | string The receiver's bank account number. |
object The total amount to send in this remittance. | |
description | string Optional description of the remittance, which will be visible to the recipient. |
clearing_profile_id | string ID of the clearing profile to use for this transaction. |
booking_type | string (Solaris-Enums-BookingType) The type of the booking. See the booking documentation for a list of explanations for each booking type. |
reference | string A unique transaction reference |
Unexpected error
{- "receiver_first_name": "Peter",
- "receiver_last_name": "Testmann",
- "receiver_address": {
- "line_1": "Musterstrasse 64",
- "line_2": "Musterstrasse 64",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "receiver_account_number": "DE72110101001000014344",
- "amount": {
- "value": 1000,
- "currency": "EUR",
- "unit": "cents"
}, - "description": "Purpose of the transaction",
- "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
- "booking_type": "INTERNAL_TRANSFER",
- "reference": "ert123456789ert"
}
Initiates the refund process for a partner remittance. Use this endpoint if you cannot credit the recipient's account, e.g., due to the beneficiary account being closed or blocked.
When the refund is completed, you will receive a BOOKING
webhook notification for the sender's account, and the status
of the partner remittance will change to returned
.
Note that you may only use this endpoints on partner remittances with a status
of COMPLETED
.
Successful result of the operation.
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
curl -i -X PATCH \ 'https://api.solaris-sandbox.de/v1/accounts/{account_id}/partner_remittances/{partner_remittance_id}/refund'
{- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "code": "build_pagination_headers_failure",
- "title": "Failed to build pagination headers.",
- "detail": "Cannot connect to database."
}
Returns the partner remittance specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/accounts/{account_id}/partner_remittances/{partner_remittance_id}'
{- "id": "2c7da6c316a34fd1915cb9fb2ccc632e",
- "receiver_first_name": "Max",
- "receiver_last_name": "Mustermann",
- "receiver_address": {
- "line_1": "Musterstrasse",
- "line_2": "string",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "receiver_account_number": "DE72110101001000014344",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "status": "string",
- "description": "string",
- "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
- "sender": {
- "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc",
- "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
- "first_name": "Peter",
- "last_name": "Testmann",
- "iban": "DE13110101014386274299"
}
}
Initiates a payout to the person reference account specified in the request URL.
Note: Requests to this endpoint must be confirmed using the change request process.
The content of the request.
The operation was successful.
The request was accepted, and now the customer must confirm the change request.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
{- "reference": "payout_unique_ref",
- "end_to_end_id": "end_to_end_id",
- "description": "Withdrawal SPAY - DD.MM.YYYY",
- "amount": {
- "value": 100,
- "currency": "EUR",
- "unit": "cents"
}
}
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
Returns an array containing all payouts made to the particular reference account specified in the request URL.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/reference_accounts/{reference_account_id}/payouts?page%5Bnumber%5D=0&page%5Bsize%5D=0&filter%5Bstatus%5D=ACCEPTED'
[- {
- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
]
Initiates a payout from a business' wallet to the specific reference account specified in the request URL. Requests to this endpoint must be confirmed using the change request process.
The content of the request.
The operation was successful.
The request was accepted, and now the customer must confirm the change request.
Invalid request.
You are not authorized to perform this action.
(Business | Account | ReferenceAccount) with (business_id | account_id | reference_account_id) not found
Internal server error.
{- "reference": "payout_unique_ref",
- "end_to_end_id": "end_to_end_id",
- "description": "Withdrawal SPAY - DD.MM.YYYY",
- "amount": {
- "value": 100,
- "currency": "EUR",
- "unit": "cents"
}
}
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
Returns an array containing all reference account payouts for the business account specified in the request URL.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/businesses/{business_id}/accounts/{account_id}/reference_accounts/{reference_account_id}/payouts?page%5Bnumber%5D=0&page%5Bsize%5D=0&filter%5Bstatus%5D=ACCEPTED'
[- {
- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
]
Initiates a payout from a business' wallet to its associated reference account.
Note: Requests to this endpoint must be confirmed using the change request process.
The content of the request.
Successful result of the operation.
The request was accepted, and the customer must confirm the change request.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
{- "reference": "payout_unique_ref",
- "end_to_end_id": "end_to_end_id",
- "description": "Withdrawal SPAY - DD.MM.YYYY",
- "amount": {
- "value": 100,
- "currency": "EUR",
- "unit": "cents"
}
}
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
Returns an array containing all wallet payouts to the business reference account specified in the request URL.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/businesses/{business_id}/accounts/{account_id}/reference_account_payouts?page%5Bnumber%5D=string&page%5Bsize%5D=0&filter%5Bstatus%5D=ACCEPTED'
[- {
- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
]
Retrieves the business reference account payout specified in the request URL.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/businesses/{business_id}/accounts/{account_id}/reference_account_payouts/{id}'
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
Initiates a payout from a person's wallet to their reference account.
Note: Requests to this endpoint must be confirmed using the change request process.
The content of the request.
The operation was successful.
The request was accepted, and now the customer must confirm the change request.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
{- "reference": "payout_unique_ref",
- "end_to_end_id": "end_to_end_id",
- "description": "Withdrawal SPAY - DD.MM.YYYY",
- "amount": {
- "value": 100,
- "currency": "EUR",
- "unit": "cents"
}
}
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
Returns an array containing all payouts to a person's reference account.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/reference_account_payouts?page%5Bnumber%5D=0&page%5Bsize%5D=0&filter%5Bstatus%5D=ACCEPTED'
[- {
- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
]
Returns a specific reference account payout to a person based on the ID specified in the request URL.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
(Person | Account) with (person_id | account_id) not found
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/reference_account_payouts/{id}'
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}
Returns a specific payout to a specific reference account.
The operation was successful.
Invalid request.
You are not authorized to perform this action.
The requested resource could not be found.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/accounts/{account_id}/reference_accounts/{reference_account_id}/payouts/{id}'
{- "id": "4b157d71def54b5c9dac28ef1d04432c",
- "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
- "status": "ACCEPTED",
- "end_to_end_id": "end_to_end_ref",
- "description": "Payout description",
- "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
- "decline_reason": "instant_payment_rail_failure"
}