Create transaction

curl --request POST \ --url https://plugin-pix-direct.api.lerian.net/v1/transactions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081", "amount": 150.5, "description": "Urgent payment", "priority": 1, "key": "recipient@example.com", "txId": "TXN-HIGH-001", "payee": { "bankId": "12345678", "document": "98765432100", "name": "Maria Santos", "branch": "0001", "accountType": 0, "accountNumber": "123456", "accountDigit": "7" } } '

{ "id": "019c96a0-0a98-7287-9a31-786e0809c769", "jdpiRequestId": "JD-REQ-20250926120001", "endToEndId": "E12345678202501011200000001", "status": "EXECUTED", "amount": 10, "description": "Internal transfer between accounts", "payer": { "bankId": "12345678", "document": "12345678901", "name": "João da Silva", "branch": "0001", "accountType": 0, "accountNumber": "123456", "accountDigit": "7", "accountId": "019c96a0-0a98-7287-9a31-786e0809c769", "bankAccountType": 0, "key": "+5511987654321", "keyType": 3 }, "payee": { "bankId": "12345678", "document": "12345678901", "name": "João da Silva", "branch": "0001", "accountType": 0, "accountNumber": "123456", "accountDigit": "7", "accountId": "019c96a0-0a98-7287-9a31-786e0809c769", "bankAccountType": 0, "key": "+5511987654321", "keyType": 3 }, "flow": 1, "type": 1, "priority": 1, "createdAt": "2025-01-15T10:30:00.000Z", "updatedAt": "2025-01-15T10:30:00.000Z" }

Authorizations

Authorization

string

header

required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Headers

Idempotency-Key

string

Optional idempotency key for safe retries (IETF standard). Use a UUID v4 or unique business identifier. If the same key is sent again and the original request was already processed, the cached response is returned.

See Retries and idempotency for details.

Body

application/json

accountId

string<uuid>

required

Account identifier from which the transaction will be made.

Example:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

amount

number<double>

required

Transaction amount.

Example:

10

description

string

required

Transaction description.

Example:

"Internal transfer between accounts"

payee

object

required

Bank account information.

Show child attributes

priority

enum<integer>

required

Transaction priority level. Numeric code indicating the processing priority for the transaction.

Valid values:

1 = PRIMARY (High priority - processed first)
2 = SECONDARY (Normal priority - standard processing queue)

Available options:

1,

2

Example:

1

key

string

required

Pix key of the recipient (payee).

Example:

"recipient@example.com"

txId

string

required

Unique transaction identifier (endToEndId).

Example:

"TXN-ABC-123"

Response

Transaction created

string<uuid>

required

Unique transaction identifier.

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

jdpiRequestId

string

required

Upstream request identifier.

Example:

"JD-REQ-20250926120001"

endToEndId

string

required

End-to-end transaction identifier.

Example:

"E12345678202501011200000001"

status

enum<string>

required

Transaction processing status. String values indicating the current state of a Pix transaction.

Valid values:

PENDING = Transaction has been initiated and is awaiting processing by the payment system
PENDING_CONFIRM = Transaction is awaiting final confirmation
EXECUTED = Transaction successfully completed and funds transferred
REVERSAL = Transaction was reversed (refunded)
REPROVED = Transaction was rejected or failed validation
SCHEDULE = Transaction is scheduled for future execution
CANCELLED = Transaction was cancelled by the user before execution
ERROR = A processing error occurred during transaction execution

Available options:

PENDING,

PENDING_CONFIRM,

EXECUTED,

REVERSAL,

REPROVED,

SCHEDULE,

CANCELLED,

ERROR

Example:

"EXECUTED"

amount

number<double>

required

Transaction amount.

Example:

10

description

string

required

Transaction description.

Example:

"Internal transfer between accounts"

payer

object

required

Bank account information.

Show child attributes

payee

object

required

Bank account information.

Show child attributes

flow

enum<integer>

required

Transaction flow direction. Numeric code indicating whether money is coming in, going out, or being transferred internally.

Valid values:

1 = CASH_IN (Receiving payment - money coming into the account)
2 = CASH_OUT (Sending payment - money going out of the account)
3 = INTRA_PSP (Internal transfer within the same Payment Service Provider)

Available options:

1,

2,

3

Example:

1

type

enum<integer>

required

Transaction type identifier. Numeric code specifying the type of payment transaction.

Valid values:

1 = Pix (Instant payment via Brazilian Pix system)

Available options:

1

Example:

1

priority

enum<integer>

required

Transaction priority level. Numeric code indicating the processing priority for the transaction.

Valid values:

1 = PRIMARY (High priority - processed first)
2 = SECONDARY (Normal priority - standard processing queue)

Available options:

1,

2

Example:

1

createdAt

string<date-time>

required

Transaction creation timestamp.

Example:

"2025-01-15T10:30:00.000Z"

updatedAt

string<date-time>

required

Transaction last update timestamp.

Example:

"2025-01-15T10:30:00.000Z"