latestOpenAPI 3.0.12026-08-104242199.9 KB

8df83424e244

Cash Operations (Viacash)

Request a cash operation

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.<br> 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.<br> Each person may only have one active (i.e., PENDING/CREATED) cash operation request of each type (payin/payout) at a time.<br> 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.

post/v1/persons/{person_id}/accounts/{account_id}/cash_operations

Path parameters

person_idstring required

ID of the person initiating the cash operation. The person must be authorized to perform cash operations on the specified account.

account_idstring required

ID of the Solaris account which will back the cash operation. The account must be active, must not be in close monitoring, and must have no credit or debit locks.

Request body

idempotency_keystring required

Use a randomly-generated UUID to ensure the uniqueness of the cash operation request.

referencestring

End-to-end reference for the customer.

provider'barzahlen' required

Must contain the value barzahlen.

type'PAYIN' | 'PAYOUT' required

Indicates whether the cash operation is a PAYOUT (for withdrawals) or a PAYIN (for deposits).

Response

Cash operation creation initiated successfully. The customer must confirm the change request.

change_request_idstring

ID of the change request that the customer must complete.

idstring

ID of the cash operation.