Create a kypay sell

POST 
https://apidev.olkypay.com//kypay/sell

Create a kypay sell

Request

application/json

Body

Sell request

AccountId stringrequired

Account Id

Amount integerrequired

Transaction amount in euro cents (10000 = 100Ôé¼)

IBAN stringrequired

Withdrawal IBAN

PaymentType stringrequired

SEPA Transfer type (SCT|INSTANT PAYMENT)

RefTransaction stringrequired

Ref of Transaction

Responses

200

The sell transaction details

application/json

Schema

Schema

Type stringrequired

Possible values: [Purchasing, Transfer, Sale]

Type

Date object nullable

Date of the transaction

oneOf

MOD1

string

MOD2

string

Amount integerrequired

Transaction amount in euro cents (10000 = 100Ôé¼)

FlowCredit stringnullable

Possible values: [C, F]

Type of transaction ref

Counterparty stringnullable

Identity of counter party

RefTransaction stringrequired

Uniq ref to the transaction

ModalTransac stringrequired

Possible values: [10, 11, 20, 21, 30]

Terms of the transaction

Description stringnullable

Transaction description

BankStatementDetail object nullable

oneOf

BankStatementDetailDto

Id stringrequired

Bank statement identifier

TransferType stringnullable

Possible values: [INSTANT, STANDARD]

Transfer type

IbanSender stringnullable

Sender IBAN

IbanBeneficiary stringnullable

Beneficiary IBAN

Name stringnullable

Name of counterparty

Reference stringnullable

Bank reference

Example (from schema)

{
  "Type": "Purchasing",
  "Date": "2024-11-28T17:04:28.235Z",
  "Amount": "10000",
  "FlowCredit": "C",
  "Counterparty": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "RefTransaction": "o9ikJBpATcWuA375tmcC7tlUBHPAD6CgbJHjkcgX324jeQNsrLg5hjLbTB5M7dTHGyzg4qtqy3Gyiyqh",
  "ModalTransac": "10",
  "Description": "5.00 Ôé¼ KYPAY Deposit To Mr Peter Investor",
  "BankStatementDetail": {}
}

401

Unauthorized

application/json

Schema

Schema

code integer
message string

Example (from schema)

{
  "code": "401",
  "message": "JWT Token not found"
}

4XX|5XX

An error occured

application/json

Schema

Schema

success boolean
code integer
internal_code integer
message string

Example (from schema)

{
  "success": "false",
  "code": "400",
  "internal_code": "3001",
  "message": "Incorect data"
}

Authorization: authorization

name: authorizationtype: httpdescription: Your Json Web Tokenin: headerscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://apidev.olkypay.com/kypay/sell' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "AccountId": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "Amount": "10000",
  "IBAN": "FR7630006000011234567890189",
  "PaymentType": "INSTANT PAYMENT",
  "RefTransaction": "o9ikJBpATcWuA375tmcC7tlUBHPAD6CgbJHjkcgX324jeQNsrLg5hjLbTB5M7dTHGyzg4qtqy3Gyiyqh"
}'

Request Collapse all

Base URL

https://apidev.olkypay.com

Auth

Bearer Token

Body

{
  "AccountId": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "Amount": "10000",
  "IBAN": "FR7630006000011234567890189",
  "PaymentType": "INSTANT PAYMENT",
  "RefTransaction": "o9ikJBpATcWuA375tmcC7tlUBHPAD6CgbJHjkcgX324jeQNsrLg5hjLbTB5M7dTHGyzg4qtqy3Gyiyqh"
}

ResponseClear

Click the Send API Request button above and see the response here!