Get Brazil payout data by id

GET

/order/v1/payout/brazil/{id}

• Sandbox

NOTE: Please, to authenticate use the scope: “api://app-order-hml”

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string

Responses

200

The resource was returned successfully

object

id

required

Payout id, unique identification

string

idempotencyKey

required

Payout idempotency key

string

description

required

Payout description

string

amount

required

Payout amout

string

status

required

Payout status

string

Allowed values: INITIAL PENDING PAID EXPIRED ANALYSIS REFUNDED PARTIAL_REFUNDED PARTIALLY_PAID CANCELED ERROR

errorMessage

required

Payout error message

string

createdAt

required

Payout creation date

string

crypto

required

The crypto

object

address

required

The crypto wallet address

string

memo

required

The memo

string

batch

Batch information when this payout was split into a batch

object

id

required

Id of the batch

string

transactionsCount

required

Total number of child transactions in the batch

number

paidCount

required

Number of child transactions already paid

number

failedCount

required

Number of child transactions that failed

number

pendingCount

required

Number of child transactions still pending

number

paidAmount

required

Amount already paid across all child transactions

string

pendingAmount

required

Amount still pending across all child transactions

string

transactions

required

Child transactions the batch was split into

Array<object>

object

id

required

Id of this child transaction

string

idempotencyKey

required

Idempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it

string

sequence

required

Ordering position of this child transaction within the batch

number

amount

required

Amount of this child transaction

string

status

required

Status of this child transaction

string

Allowed values: INITIAL PENDING PAID EXPIRED ANALYSIS REFUNDED PARTIAL_REFUNDED PARTIALLY_PAID CANCELED ERROR

endToEndId

End-to-end id of this child transaction

string

paidAt

Date this child transaction was paid

string

errorMessage

Error message when this child transaction failed

string

paymentMethod

required

Payout payment method

string

Allowed values: PIX TED TETHER

bank

required

Payout bank information

object

pix

required

Pix information data

object

type

required

The type of pix

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

key

required

The key of pix

string

account

required

Bank account information data

object

ispb

required

The ispb number

string

bankNumber

required

The bank number

string

branchNumber

required

The bank branch number

string

accountNumber

required

The bank account number

string

customer

required

Payout Customer data

object

fullName

required

Customer fullName

string

email

Customer email

string

phone

Customer phone

string

birth

The date of birth or foundation, in ISO-8601 YYYY-MM-DD format.

string

document

required

Document

object

type

required

The document type

string

Allowed values: CPF CNPJ

number

required

The document number

string

owner

The owner information.
PS: This field is optional, not all payment methods have this information.

object

name

The name of the owner.

string

document

The document of the owner.

string

bank

The bank information of owner.

object

name

The bank name.

string

ispb

The bank ISPB code.

string

code

The bank code, like COMPE.

string

account

The account number.

string

branch

The branch account number.

string

pix

The pix.

object

type

required

The type of pix

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

key

required

The key of pix

string

endToEndId

required

The payout E2E ID

string

receiver

required

The Receiver

object

name

required

The receiver name.

string

document

required

The document of the receiver.

object

type

required

Document type

string

Allowed values: CPF CNPJ

number

required

Document number

string

bank

required

Account bank data

object

name

required

The bank name

string

code

required

The bank code

string

ispb

required

The bank ispb

string

pix

required

The pix key

object

type

required

The type of pix

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

key

required

The key of pix

string

account

required

The bank account

object

type

required

The type of pix

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

key

required

The key of pix

string

fee

Fee

object

fixed

required

Fixed fee amount

object

variable

required

Variable fee amount

object

additional

required

Addictional fee amount

object

400

The request is not valid

Array<string>

403

Unauthorized Request

Array<string>

404

Resource not found

Array<string>

500

An unexpected error occurred inside the server

Array<string>