cURL

curl --request POST \
  --url http://localhost:3000/connect/v1/transactions/payment-transactions/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "<string>",
  "destination": "<string>",
  "id": "<string>",
  "premium_details": {
    "name": "<string>",
    "id": "<string>",
    "options": [
      {
        "name": "<string>",
        "amount": 123,
        "id": "<string>",
        "is_active": true,
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "category": "PAYOUT",
    "type": "PER_TRANSACTION",
    "amount": 123,
    "included": true,
    "dependant_on_card": true,
    "applicable_activity": "BUY",
    "calculation_type": "NORMAL",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>",
    "owner": "<string>"
  },
  "currency_details": {
    "name": "<string>",
    "id": "<string>",
    "code": "<string>"
  },
  "currency": "<string>",
  "number": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "date": "2023-11-07T05:31:56Z",
  "invoice_number": "<string>",
  "verification_latitude": 123,
  "verification_longitude": 123,
  "method": "CARD",
  "payment_type": "TRANSACTION",
  "amount": 123,
  "selected_option": "<string>",
  "creator": "<string>",
  "updater": "<string>",
  "card": "<string>",
  "premium": "<string>",
  "transaction": "<string>",
  "submissions": [
    "<string>"
  ]
}
'

{
  "source": "<string>",
  "destination": "<string>",
  "id": "<string>",
  "premium_details": {
    "name": "<string>",
    "id": "<string>",
    "options": [
      {
        "name": "<string>",
        "amount": 123,
        "id": "<string>",
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "is_active": true,
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "category": "PAYOUT",
    "type": "PER_TRANSACTION",
    "amount": 123,
    "included": true,
    "dependant_on_card": true,
    "applicable_activity": "BUY",
    "calculation_type": "NORMAL",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>",
    "owner": "<string>"
  },
  "currency_details": {
    "name": "<string>",
    "id": "<string>",
    "code": "<string>"
  },
  "type": "<string>",
  "currency": "<string>",
  "updated_on": "2023-11-07T05:31:56Z",
  "number": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "date": "2023-11-07T05:31:56Z",
  "invoice": "<string>",
  "invoice_number": "<string>",
  "verification_latitude": 123,
  "verification_longitude": 123,
  "method": "CARD",
  "payment_type": "TRANSACTION",
  "amount": 123,
  "selected_option": "<string>",
  "creator": "<string>",
  "updater": "<string>",
  "card": "<string>",
  "premium": "<string>",
  "transaction": "<string>",
  "submissions": [
    "<string>"
  ]
}

Payment Transactions

Create Payment Transaction Endpoint

The Create Payment Transaction endpoint enables the creation of a new payment transaction. The request should include details such as transaction ID, premium details, currency details, payment amount, and other relevant information. Upon successful creation, the API responds with the newly created payment transaction details, including the transaction ID, premium details, currency details, transaction type, amount, and other associated information.

POST

transactions

payment-transactions

cURL

curl --request POST \
  --url http://localhost:3000/connect/v1/transactions/payment-transactions/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "<string>",
  "destination": "<string>",
  "id": "<string>",
  "premium_details": {
    "name": "<string>",
    "id": "<string>",
    "options": [
      {
        "name": "<string>",
        "amount": 123,
        "id": "<string>",
        "is_active": true,
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "category": "PAYOUT",
    "type": "PER_TRANSACTION",
    "amount": 123,
    "included": true,
    "dependant_on_card": true,
    "applicable_activity": "BUY",
    "calculation_type": "NORMAL",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>",
    "owner": "<string>"
  },
  "currency_details": {
    "name": "<string>",
    "id": "<string>",
    "code": "<string>"
  },
  "currency": "<string>",
  "number": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "date": "2023-11-07T05:31:56Z",
  "invoice_number": "<string>",
  "verification_latitude": 123,
  "verification_longitude": 123,
  "method": "CARD",
  "payment_type": "TRANSACTION",
  "amount": 123,
  "selected_option": "<string>",
  "creator": "<string>",
  "updater": "<string>",
  "card": "<string>",
  "premium": "<string>",
  "transaction": "<string>",
  "submissions": [
    "<string>"
  ]
}
'

{
  "source": "<string>",
  "destination": "<string>",
  "id": "<string>",
  "premium_details": {
    "name": "<string>",
    "id": "<string>",
    "options": [
      {
        "name": "<string>",
        "amount": 123,
        "id": "<string>",
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "is_active": true,
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "category": "PAYOUT",
    "type": "PER_TRANSACTION",
    "amount": 123,
    "included": true,
    "dependant_on_card": true,
    "applicable_activity": "BUY",
    "calculation_type": "NORMAL",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>",
    "owner": "<string>"
  },
  "currency_details": {
    "name": "<string>",
    "id": "<string>",
    "code": "<string>"
  },
  "type": "<string>",
  "currency": "<string>",
  "updated_on": "2023-11-07T05:31:56Z",
  "number": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "date": "2023-11-07T05:31:56Z",
  "invoice": "<string>",
  "invoice_number": "<string>",
  "verification_latitude": 123,
  "verification_longitude": 123,
  "method": "CARD",
  "payment_type": "TRANSACTION",
  "amount": 123,
  "selected_option": "<string>",
  "creator": "<string>",
  "updater": "<string>",
  "card": "<string>",
  "premium": "<string>",
  "transaction": "<string>",
  "submissions": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Body

application/json

source

string

required

destination

string

required

string

premium_details

object

Show child attributes

premium_details.name

string

required

Required string length: 1 - 100

premium_details.id

string

premium_details.options

object[]

Show child attributes

premium_details.options.name

string

required

Required string length: 1 - 25

premium_details.options.amount

number

required

premium_details.options.id

string

premium_details.options.is_active

boolean

premium_details.options.creator

string

premium_details.options.updater

string

premium_details.category

enum<string>

Available options:

PAYOUT,

TRANSACTION

premium_details.type

enum<string>

Available options:

PER_TRANSACTION,

PER_KG,

PER_UNIT_CURRENCY,

PER_FARMER

premium_details.amount

number | null

premium_details.included

boolean

premium_details.dependant_on_card

boolean

premium_details.applicable_activity

enum<string>

Available options:

BUY,

SELL

premium_details.calculation_type

enum<string>

Available options:

NORMAL,

MANUAL,

OPTIONS

premium_details.is_active

boolean

premium_details.creator

string

premium_details.updater

string

premium_details.owner

string

currency_details

object

Show child attributes

currency_details.name

string

required

Required string length: 1 - 1000

currency_details.id

string

currency_details.code

string | null

Maximum string length: 100

currency

string

Minimum string length: 1

number

string | null

Maximum string length: 10

created_on

string<date-time>

date

string<date-time>

invoice_number

string | null

Maximum string length: 100

verification_latitude

number

verification_longitude

number

method

enum<string> | null

Available options:

CARD,

INVOICE,

NONE

payment_type

enum<string>

Available options:

TRANSACTION,

PREMIUM,

TRANSACTION_PREMIUM

amount

number

selected_option

string | null

Maximum string length: 100

creator

string

updater

string

card

string

premium

string

transaction

string

submissions

string[]

Response

201 - application/json

source

string

required

destination

string

required

string

premium_details

object

Show child attributes

premium_details.name

string

required

Required string length: 1 - 100

premium_details.id

string

premium_details.options

object[]

Show child attributes

premium_details.options.name

string

required

Required string length: 1 - 25

premium_details.options.amount

number

required

premium_details.options.id

string

premium_details.options.updated_on

string<date-time>

premium_details.options.created_on

string<date-time>

premium_details.options.is_active

boolean

premium_details.options.creator

string

premium_details.options.updater

string

premium_details.updated_on

string<date-time>

premium_details.created_on

string<date-time>

premium_details.category

enum<string>

Available options:

PAYOUT,

TRANSACTION

premium_details.type

enum<string>

Available options:

PER_TRANSACTION,

PER_KG,

PER_UNIT_CURRENCY,

PER_FARMER

premium_details.amount

number | null

premium_details.included

boolean

premium_details.dependant_on_card

boolean

premium_details.applicable_activity

enum<string>

Available options:

BUY,

SELL

premium_details.calculation_type

enum<string>

Available options:

NORMAL,

MANUAL,

OPTIONS

premium_details.is_active

boolean

premium_details.creator

string

premium_details.updater

string

premium_details.owner

string

currency_details

object

Show child attributes

currency_details.name

string

required

Required string length: 1 - 1000

currency_details.id

string

currency_details.code

string | null

Maximum string length: 100

type

string

currency

string

Minimum string length: 1

updated_on

string<date-time>

number

string | null

Maximum string length: 10

created_on

string<date-time>

date

string<date-time>

invoice

string<uri> | null

invoice_number

string | null

Maximum string length: 100

verification_latitude

number

verification_longitude

number

method

enum<string> | null

Available options:

CARD,

INVOICE,

NONE

payment_type

enum<string>

Available options:

TRANSACTION,

PREMIUM,

TRANSACTION_PREMIUM

amount

number

selected_option

string | null

Maximum string length: 100

creator

string

updater

string

card

string

premium

string

transaction

string

submissions

string[]

Attach Product Invoice Retrieve a Payment Transaction

⌘I

Trace Connect APIs

Authorizations

Body

Response