API Reference

Create Debit Transaction for Account

post
http://localhost:8080/v1/transactions/debit
Body Params
uuid
required

Unique identifier (UUID) of the Account

number
required

Value of the Transaction, to 2 decimal places

string

Category assigned to the Transaction

string
required
length ≥ 1

Counterpart name

string
required
length ≥ 1

Description on the Transaction

uuid
required

Unique value (UUID) used to identify this request and used to recognise any subsequent retries

string
enum

Origin source of the Transaction (only applicable if specifically used by Client). Possible values:

  • ATM_CASH
  • POS_DEBIT
  • VENUE
Allowed:
uuid

Additional identifier applied to Transaction related to origin of the request

string
enum

Initiator origin of the Transaction. Possible values:

  • CUSTOMER: Transaction initiated by a customer
  • SCHEDULED_PAYMENT: Transaction initiated by a schedule
  • HAAS_OPERATIONS: Transaction initiated by Client Operations team
  • OPERATIONS: Transaction initiated by Shaype Operations team
  • DIRECT_DEBIT: Transaction initiated by Direct Debit
Allowed:
string

Reference on the transaction (only applicable to NPP transactions), maximum 35 alphanumeric characters in length

string
enum
required

Transaction channels available for use by Shaype Clients. Possible values:

  • ACCOUNT_ADJUSTMENT
  • APPLE_REWARD
  • INTEREST_ADJUSTMENT
  • LOAN_ADJUSTMENT
  • LOAN_REPAYMENT
  • MANUAL_ADJUSTMENT
  • SERVICE_FEE
Allowed:
Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago