API - OCT (Original Credit Transaction)

OCT- Request

POST {BASE_URL}/wipay-payment-admin/oct

Generates an original credit transaction for an user

---

Headers

Name	Value
Content-Type	application/json

Body

Type	Name	Description	Condition
string	merchantId	Merchant unique identifier	Required
string	subMerchantId	Unique identifier of the sub‑merchant.	Optional
string	userId	Internal identifier of an existing user	Optional
string	tokenId	Identifier token for a previously tokenized card	Optional
string	terminalId	Unique merchant terminal identifier. If your merchant account has multiple terminals, you must specify the terminal ID to indicate which one to use. If you have only one terminal, you may omit this field—it will default to the only available terminal.	Optional
number	amount	Toal operation amount	Required
string	currency	Currency identifier code; by default = 978 . The following link contains the ISO 4217 currencies codes that are supported. Currencies	Required
string	urlOk	Merchant's OK url	Optional
string	urlKO	Merchant's KO url	Optional
string	language	Language identifier code; by default = es. The following link contains the ISO 639-1 language codes that are supported. Languages	Required
string	octData	Attribute used in order to set the specific data that is gonna be related to the OCT	Required
string	description	Description of the product to be paid	Optional
string	merchantOperationId	Optional field that you can use in order to identify operations in your system (is gonna be returned in the WebHook communication)	Optional

octData fields

Type	Field	Description	Required
string	octBusinessAppId	Business Application Identifier. Possible values: • AA – Account-to-account money transfer • PP – Person-to-person money transfer • BI – Transfer from a financial institution to a user’s account • FT – Prepaid card top-up • WT – Transfer from digital wallet	Required
string	octSenderReferenceNumber	Sender Reference Number. Identifies the reference of the transfer provided by the sender.	Required
string	octSenderAccountNumber	Sender Account Number. IBAN or account number from which the funds will be sent.	Required
string	octSenderName	Sender Name. Full name of the person sending the funds.	Required
string	octRecipientName	Recipient Name. Full name of the person receiving the funds.	Required
string	octSenderAddress	Sender Address. Physical address of the sender.	Required
string	octSenderCity	Sender City. City where the sender resides.	Required
string	octSenderProvince	Sender Province. Province code (2 characters).	Required
string	octSenderCountryCode	Sender Country Code. ISO country code of the sender (3 characters).	Required
string	octSourceOfFunds	Source of Funds. Indicates the source of the funds: • 01 = Credit account • 02 = Debit account • 03 = Prepaid account	Required
string	octSenderPostalCode	Sender Postal Code.	Required
string	octAdditionalSenderInfo	Additional Sender Information. Any complementary information about the sender.	Required

Request

Body

{
  "merchantId": "1231234",
  "terminalId": "00000203",
  "amount": 20,
  "currency": "978",
  "language": "es",
  "octData": {
    "octBusinessAppId": "PP",
    "octSenderReferenceNumber": "0000000000000001",
    "octSenderAccountNumber": "ES4869000010050100001696",
    "octSenderName": "Christian Bongardt",
    "octRecipientName": "Christian Bongardt",
    "octSenderAddress": "Calle Useras 19 2 3",
    "octSenderCity": "Castellon de la plana",
    "octSenderProvince": "CS",
    "octSenderCountryCode": "ESP",
    "octSourceOfFunds": "03",
    "octSenderPostalCode": "12006",
    "octAdditionalSenderInfo": "-"
  },
  "description": "description",
  "merchantOperationId": "12"
}

Response

200

{
  TO COMPLETE
}