Create Client Transaction

Create Client Transaction

GET {{Environment_URL}}/v2/transactions

This route is responsible for the creation of a client transaction.

Delivery address must be registered with the correspondent client.

When creating a transaction, if the transaction amount is equal to or greater than US$ 1000 or equivalent in another currency, the delivery amount must be sent equal to 0.

When creating a transaction from R$ 10.000,00 (without adding the value of delivery), the client must be the receiver, which means that the document of both must be the same.

If no payment method is used in the creation payload, the default payment method will be TED

Transaction

Attribute	Description	Type
id	The transaction unique identifier	Integer
type	Type of the transaction	String
status	The transaction status	Status
delivery	Delivery information of transaction	Delivery
client	Client information	Client
merchant	Merchant information	Merchant
total	Total transaction amount and precision	Value
user	Transaction user information	User
invoiceId	The invoice identifier	Integer
partnerId	The partner identifier	String
cancellationReason	The cancellation reason text for invalid a transaction	String
createdAt	Transaction creation date	Date
updatedAt	Transaction update date	Date
payment	Payment Method	Payment

Status

Attribute	Description	Type
key	The transaction status	String
label	The transaction status label	String

Delivery

Attribute	Description	Type
address	Delivery address information	Address
receiver	Delivery receiver information	Receiver
date	The date to delivery	DateTime
cost	Delivery cost and precision	Value

Address

Attribute	Description	Type
city	The city of the delivery	String
zipCode	The zip code of the address	String
neighborhood	The neighborhood	String
state	The address state	String
number	The address number	Integer
complement	Any complement about the address	String
street	The street address to the delivery	String
nickname	The label that identifier the address	String
inlineAddress	The complete address informations inline	String

Receiver

Attribute	Description	Type
name	The name of the receiver	String
document	The document number of the receiver	String

Client

Attribute	Description	Type
cpf	The CPF document of the client	String
email	The email of the client	String
name	The name of the client	String

Merchant

Attribute	Description	Type
id	The merchant identifier	String
label	The merchant label description	String
correspondentId	The correspondent identifier the merchant belongs to	Integer
storeId	The store identifier the merchant belongs to	Integer

Payment

Attribute	Description	Type
method	payment method	String String

User

Attribute	Description	Type
id	The user identifier	Integer
email	The user email	String
type	The user type	String

Headers

Name	Value
Authorization	Bearer <token>
client-key	123ABCD456

Request Body

Create Client Transaction

{
    "clientCpf": "123.456.789-00",
    "delivery": {
        "address": {
            "city": "São Paulo",
            "zipCode": "01234-567",
            "state": "SP",
            "complement": "Apto 31",
            "number": 7878,
            "street": "Rua do Rocio",
            "neighborhood": "Bairro",
            "nickname": "casa"
        },
        "receiver": {
            "name": "John Doe",
            "document": "123.456.789-00"
        },
        "cost": 0,
        "date": "1970-01-01",
    "payment": {
        "method": "DYNAMIC_PIX"
      },
    },
    "quotationId": "765d6b49f517e6e923957896d7feb3ff54011628"
}

Response

201 - Success

{
  "id": 795,
  "type": "PAPERMONEY",
  "status": {
    "key": "AWAITING_PAYMENT",
    "label": "Aguardando pagamento"
  },
  "delivery": {
    "address": {
      "city": "São Paulo",
      "zipCode": "01234-567",
      "neighborhood": "Bairro",
      "state": "SP",
      "number": 7878,
      "complement": "",
      "street": "Rua do Rocio",
      "nickname": "casa",
      "inlineAddress": "Rua do Rocio 7878 - Bairro - São Paulo - CE - 01234-567"
    },
    "receiver": {
      "name": "John Doe",
      "document": "123.456.789-00"
    },
    "date": "2019-11-18",
    "cost": {
      "value": 0,
      "divisor": 100
    }
  },
  "quotation": {
    "id": "03f08b9b0e9a4986e48e7e118d3b535df57ff10c",
    "tax": {
      "iof": {
        "total": {
          "value": 4760,
          "divisor": 100
        },
        "percentage": 1.1
      }
    },
    "price": {
      "withTax": {
        "value": 43769,
        "divisor": 10000
      },
      "withoutTax": {
        "value": 43293,
        "divisor": 10000
      }
    },
    "total": {
      "withTax": {
        "value": 437690,
        "divisor": 100
      },
      "withoutTax": {
        "value": 432930,
        "divisor": 100
      }
    },
    "reverse": false,
    "currency": {
      "code": "USD",
      "name": "Dólar Americano",
      "offer": 1000,
      "offerUSD": {
        "value": 10000000,
        "divisor": 10000
      },
      "maxToSell": 10000,
      "minToSell": 200,
      "multiples": [
        20,
        50,
        100
      ],
      "parityToUSD": {
        "value": 10000,
        "divisor": 10000
      },
      "levelingRate": {
        "value": 42486,
        "divisor": 10000
      },
      "parityFromUSD": {
        "value": 10000,
        "divisor": 10000
      },
      "countryFlagUrl": "https://s3.amazonaws.com/frente-exchanges/flags/united-states.svg",
      "spreadPercentage": 1.9,
      "commercialExchangeRate": {
        "value": 41920,
        "divisor": 10000
      },
      "coverageRatePercentage": 1.35
    },
    "rounding": {
      "method": "NORMAL",
      "rounded": false
    },
    "createdAt": "2019-11-14T19:26:38.479Z",
    "expiresAt": "2019-11-14T19:36:38.000Z",
    "merchantId": "WL-FRENTE-SP",
    "timeToLive": 600,
    "purposeCode": "IR003"
  },
  "client": {
    "cpf": "123.456.789-00",
    "email": "[email protected]",
    "name": "John Doe"
  },
  "merchant": {
    "id": "WL-FRENTE-SP",
    "label": "São Paulo",
    "correspondentId": 1,
    "storeId": 1
  },
  "total": {
    "value": 437690,
    "divisor": 100
  },
  "user": {
    "id": 304,
    "email": "[email protected]",
    "type": "UserCorrespondent"
  },
  "invoiceId": 11631,
  "partnerId": null,
  "cancellationReason": null,
  "createdAt": "2019-11-14T19:30:47.342Z",
  "updatedAt": "2019-11-14T19:30:47.342Z"
}