Criar uma Transação

Para fazer uma cobrança você deve utilizar essa rota e criar a sua transação.

É possível utilizar um card_id ou todos os dados do cartão diretamente. A primeira opção é a mais indicada, por fatores de segurança.

POST/v1/transactions

Parâmetros

Atributo	Obrigatório	Tipo
amount	sim	int32
installments	sim	string
item_id	sim	string
card_holder_name	sim	string
card_number	sim	string
card_expiration_date	sim	string
card_cvv	sim	string
card_id	sim	string
customer	sim	object
customer[external_id]	sim	string
customer[name]	sim	string
customer[document_number]	sim	string
customer[email]	sim	string
customer[phone_number]	sim	string
customer[address]	sim	object
customer[address][country]	sim	string
customer[address][state]	sim	string
customer[address][city]	sim	string
customer[address][neighborhood]	sim	string
customer[address][street]	sim	string
customer[address][zipcode]	sim	string
soft_descriptor	sim	string
postback_url	não	string

Importante

O valor em amount deve ser passado em centavos.
Ex: USD 10.00 = 1000. Deve ser no mínimo 1 dólar (100)

tip

Toda vez que você fizer uma transação com o USEND PAY, a nossa API já cria automaticamente um hash de card_id, assim você já pode salvar esses dados para o seu cliente usar nas próximas transações. Exemplo de utilização: one-click buy.

Request

HEADERS

Content-Type

application/json

api_key

api_key_value

Deve ser passado no HEADER da requisição.

BODY

amount

int32

Valor a ser cobrado. Deve ser passado em centavos. Ex: USD 1.000,00 = 100000.

installments

string

Número de parcelas da transação, sendo mínimo: 1 e Máximo: 12.

item_id

string

ID da transação na sua plataforma.

card_holder_name

string

Nome do portador do cartão.

card_number

string

Número do cartão.

card_expiration_date

string

Data de validade do cartão. Somente números no formato MMAA.

card_cvv

string

Código verificador do cartão.

card_id

string

Ao realizar uma transação, retornamos o card_id do cartão, para que nas próximas transações ele possa ser utilizado como forma de identificar os dados de pagamento. Caso inclua os dados do cartão, esse campo torna-se dispensável.

customer

object

customer[external_id]

string

Identificador do cliente em sua plataforma.

customer[name]

string

Nome do cliente.

customer[document_number]

string

Número do documento do cliente.

IMPORTANTE: Se o comprador for de nacionalidade Brasileira (customer.address.country == 'br'), deve ser passado o CPF do mesmo. Caso o cliente seja estrangeiro, deve ser passado o número identificador (NIN) - national identification number.

customer[email]

string

E-mail do cliente

customer[phone_number]

string

Número de telefone do cliente.

IMPORTANTE: Se o comprador for de nacionalidade Brasileira (customer.address.country == 'br'), deve ser passado no formato +55DD9XXXXXXXX. Caso o cliente seja estrangeiro, deve ser passado no padrão regex /^+(?:[0-9] ?){6,14}[0-9]$/]].

customer[address]

object

customer[address][country]

string

Nacionalidade do cliente, no formato sigla do país. Só serão aceitos o formato ISO 3166-1 alfa-2 (duas-letras) Ex: br, us, uy...

customer[address][state]

string

Estado do atual endereço do cliente, no formato sigla do estado. Ex: SP, RJ, MG...

customer[address][city]

string

Cidade do endereço do cliente.

customer[address][neighborhood]

string

Bairro do endereço do cliente.

customer[address][street]

string

Nome da Rua do endereço do cliente.
(Não é necessário passar número nem complemento).

customer[address][zipcode]

string

CEP do cliente.

soft_descriptor

string

Descrição que aparecerá na fatura do seu cliente. Máximo de 13 caracteres, sendo alfanuméricos e espaços.

postback_url

string

Endpoint do seu sistema que receberá informações a cada atualização da transação.

Exemplos

200 | OK

Request

  curl POST https://usendpay.marlim.co/v1/transactions
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{
    "item_id": "1",
    "amount": 1000,
    "installments": "3",
    "card_id": "card_chewbacca1234JabbaTheHutt",
    "customer[external_id]": "12345678900",
    "customer[name]": "Luke Skywalker",
    "customer[email]": "luke@jedimaster.sw",
    "customer[document_number]": "12345678900",
    "customer[address][country]": "us",
    "customer[address][state]": "CA",
    "customer[address][city]": "Modesto",
    "customer[address][neighborhood]": "East Modesto",
    "customer[address][street]": "713 Sunset Ave",
    "customer[address][zipcode]": "95351",
    "customer[phone_number]": "+18007770133",
    "soft_descriptor": "Star Wars"
  }

Response

{
  "status": "paid",
  "authorization_code": "123456",
  "nsu": 11122233,
  "date_created": "1977-05-25T00:00:00.000Z",
  "paid_amount": 5000,
  "id": 11122233,
  "card_last_digits": "4444",
  "card_holder_name": "Luke Skywalker",
  "card_id": "card_chewbacca1234JabbaTheHutt"
}