offbook/edit

This endpoint allows you to edit offbook transaction that was previously saved the VoPay platform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

int32
required

Searches for a offbook transaction transaction with the specified offbook transaction ID. If the offbook transaction ID is not found in our system, an error will be thrown.

string

3 character currency code for the currency to mark the currency that was used for the offbook transaction. If specified, the specified offbook transaction will be updated with the new value.

string

The credit amount for the offbook transaction. Only one of the CreditAmount or DebitAmount can be non-zero.

string

The debit amount for the offbook transaction. Only one of the CreditAmount or DebitAmount can be non-zero.

date

The transaction date for the offbook transaction. Should be specified in YYYY-MM-DD format. If specified, the specified offbook transaction will be updated with the new value.

string

Full name of the indivdual or business for whom the offbook transaction is being created. If specified, the specified offbook transaction will be updated with the new value.

string

The transaction status for the offbook transaction. If specified, the specified offbook transaction will be updated with the new value.

string

An optional note to associate with the offbook transaction transaction. If specified, the specified offbook transaction will be updated with the new value.

string

An optional reference number to associate with the offbook transaction transaction. If specified, the specified offbook transaction will be updated with the new value.

string

The Client Account ID that the offbook transaction belongs to. If specified, the specified offbook transaction will be updated with the new value.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json