Create a new transaction

POST

api

transaction

{
  "status": true,
  "message": "",
  "data": {
    "uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
    "payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
    "payee_uuid": "ec82930a-b59e-4ed2-83dd-0f041bfa5baa",
    "transaction_status": "PAYOUT_COMPLETE",
    "currency": "USD",
    "amount": 57163,
    "transaction_fee": 0,
    "client_reference_id": "stageN5@123",
    "payout_delay_days": 0,
    "company_name": "a-z, A-Z, 12-'3.",
    "description": null,
    "addenda": null,
    "type": "api",
    "spped": "sameday",
    "processor_mid": "123131123",
    "capture_status": "CAPTURE_COMPLETE",
    "payout_status": "PAYOUT_COMPLETE",
    "clawback_status": null,
    "reverse_payout_status": null,
    "failure_code": null,
    "failure_reason": null,
    "cancel_reason": null,
    "payer_bank_account": {
      "uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
      "aggregator_type": "bank_link"
    },
    "payee_bank_account": {
      "uuid": "9c33090b-c0fb-42ce-9ad8-921665d15a90",
      "aggregator_type": "bank_link"
    },
    "payout_ach_return_code": "R01",
    "payout_failure_reason": "Insufficient funds",
    "trace_ids": {
      "capture_trace_id": "ach_92lhg3vbf76qxzp",
      "payout_trace_id": "ach_57ytkdw84mncxvq",
      "reverse_payout_trace_id": "",
      "refunds": [
        {
          "refund_uuid": "",
          "refund_capture_trace_id": "",
          "refund_payout_trace_id": ""
        }
      ]
    },
    "created_at": "2024-06-03 15:58:44",
    "updated_at": "2024-06-04 18:30:30"
  },
  "errors": null,
  "error_code": null
}

Authorizations

Authorization

string

header

required

Sanctum token-based authentication using the Bearer scheme.

Body

application/json

payer_uuid

string

Example:

"9c330a70-84de-46c3-a380-70b34799b1d3"

payee_uuid

string

Example:

"9c330a70-84de-46c3-a380-70b34799b1d3"

processor_mid

string

Example:

"234234234"

amount

integer

Example:

"100"

transaction_fee

integer

Example:

"1.2"

client_reference_id

string

Example:

"adsssd"

payout_delay_days_min

integer

Example:

"1"

speed

string

Example:

"samdeay"

company_name

string

Example:

"Company-1"

description

string

Example:

"lladsdf asldfs"

addenda

string

Example:

""

source_bank_account

object

destination_bank_account

object

failure_simulation

enum<integer>

Response

201

application/json

Transaction details

status

boolean

Example:

true

message

string

Example:

""

data

object

data.uuid

string

Example:

"9c330a70-84de-46c3-a380-70b34799b1d3"

data.payer_uuid

string

Example:

"7d021f9a-b5f4-4668-8d78-0f448f55f984"

data.payee_uuid

string

Example:

"ec82930a-b59e-4ed2-83dd-0f041bfa5baa"

data.transaction_status

string

Example:

"PAYOUT_COMPLETE"

data.currency

string

Example:

"USD"

data.amount

integer

Example:

57163

data.transaction_fee

integer

Example:

0

data.client_reference_id

string

Example:

"stageN5@123"

data.payout_delay_days

integer

Example:

0

data.company_name

string

Example:

"a-z, A-Z, 12-'3."

data.description

string | null

Example:

null

data.addenda

string | null

Example:

null

data.type

string

Example:

"api"

data.spped

string

Example:

"sameday"

data.processor_mid

string

Example:

"123131123"

data.capture_status

string

Example:

"CAPTURE_COMPLETE"

data.payout_status

string

Example:

"PAYOUT_COMPLETE"

data.clawback_status

string | null

Example:

null

data.reverse_payout_status

string | null

Example:

null

data.failure_code

string | null

Example:

null

data.failure_reason

string | null

Example:

null

data.cancel_reason

string | null

Example:

null

data.payer_bank_account

object

data.payee_bank_account

object

data.payout_ach_return_code

string

Example:

"R01"

data.payout_failure_reason

string

Example:

"Insufficient funds"

data.trace_ids

object

data.created_at

string

Example:

"2024-06-03 15:58:44"

data.updated_at

string

Example:

"2024-06-04 18:30:30"

errors

string

Example:

null

error_code

string

Example:

null

Cancel a transaction Get Transaction by UUID

{
  "status": true,
  "message": "",
  "data": {
    "uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
    "payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
    "payee_uuid": "ec82930a-b59e-4ed2-83dd-0f041bfa5baa",
    "transaction_status": "PAYOUT_COMPLETE",
    "currency": "USD",
    "amount": 57163,
    "transaction_fee": 0,
    "client_reference_id": "stageN5@123",
    "payout_delay_days": 0,
    "company_name": "a-z, A-Z, 12-'3.",
    "description": null,
    "addenda": null,
    "type": "api",
    "spped": "sameday",
    "processor_mid": "123131123",
    "capture_status": "CAPTURE_COMPLETE",
    "payout_status": "PAYOUT_COMPLETE",
    "clawback_status": null,
    "reverse_payout_status": null,
    "failure_code": null,
    "failure_reason": null,
    "cancel_reason": null,
    "payer_bank_account": {
      "uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
      "aggregator_type": "bank_link"
    },
    "payee_bank_account": {
      "uuid": "9c33090b-c0fb-42ce-9ad8-921665d15a90",
      "aggregator_type": "bank_link"
    },
    "payout_ach_return_code": "R01",
    "payout_failure_reason": "Insufficient funds",
    "trace_ids": {
      "capture_trace_id": "ach_92lhg3vbf76qxzp",
      "payout_trace_id": "ach_57ytkdw84mncxvq",
      "reverse_payout_trace_id": "",
      "refunds": [
        {
          "refund_uuid": "",
          "refund_capture_trace_id": "",
          "refund_payout_trace_id": ""
        }
      ]
    },
    "created_at": "2024-06-03 15:58:44",
    "updated_at": "2024-06-04 18:30:30"
  },
  "errors": null,
  "error_code": null
}

Bank Account

Business,Merchant

Billing

Payouts

Refunds

Transaction

Users

Webhook

Processor

Onboard Person

Create a new transaction

Authorizations

Body

Response