---
agentTools:
projectIndex: https://ultrapayments.readme.io/llms.txt
---
# Criar Pagamento
Esse é o endpoint destinado a solicitação de criação de **pré-autorização** ou **autorização** de um arranjo de pagamento.
Entretanto, você pode realizar diferentes tipos de fluxos de autorização de pagamento como [Criação de Pagamentos com Cofre de Cartão](https://ultrapayments.readme.io/reference/payments-use-cases#section-criar-pagamento-com-cofre-de-cartao), [Criação de Pagamento com Split](https://ultrapayments.readme.io/reference/payments-use-cases#section-criar-pagamento-com-split), [Criação de Pagamento com Split Tardio](https://ultrapayments.readme.io/reference/payments-use-cases#section-criacao-de-pagamento-com-split-tardio), [Criação de Pagamento Pré-Autorizado](https://ultrapayments.readme.io/reference/payments-use-cases#section-criacao-de-pagamento-pre-autorizado) e [Criação de Pagamento Autorizado](https://ultrapayments.readme.io/reference/payments-use-cases#section-criacao-de-pagamento-autorizado).
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "PAGAMENTOS",
"version": "1.0"
},
"servers": [
{
"url": "https://api-kosmos.ultrapayments.com.br/"
}
],
"security": [
{}
],
"paths": {
"/payments/api/sales": {
"post": {
"summary": "Criar Pagamento",
"description": "",
"operationId": "create-payments",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Chave de integração única gerado pela [Autenticação de Pagamento (PayAuth)](authentication-introduction) para o estabelecimento.
Formato
Bearer ``",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"amount",
"payment",
"customer"
],
"properties": {
"amount": {
"type": "integer",
"description": "Valor do pagamento em centavos sem vírgula e ponto.",
"format": "int32"
},
"order_id": {
"type": "string",
"description": "Seu número de identificação da compra/Número do pedido."
},
"online_id": {
"type": "string",
"description": "Seu número de identificação adicional da compra/Número do pedido."
},
"payment": {
"type": "object",
"description": "Informações do pagamento, modelo de autorização e fluxo a ser executado.",
"required": [
"type",
"installments"
],
"properties": {
"type": {
"type": "string",
"description": "Tipo do pagamento. Valores possíveis:
- `credit`"
},
"installments": {
"type": "integer",
"description": "Número de parcelas.",
"format": "int32"
},
"capture": {
"type": "boolean",
"description": "Indica se o pagamento deve ser autorizado no momento da criação. Valores possíveis:
Autorização - `true`
Pré-Autorização - `false`",
"default": false
},
"has_interest": {
"type": "boolean",
"description": "Indica se o pagamento possui juros.",
"default": false
},
"delayed_split": {
"type": "boolean",
"description": "Indica se o pagamento terá um split tardio. Valores possíveis:
Fluxo Normal - `false`
Split Tardio do Pagamento - `true`",
"default": false
},
"authenticate": {
"type": "boolean",
"description": "Indica se o comprador será direcionado ao Banco emissor para autenticação do cartão. Valores possíveis:
Fluxo Normal - `false`
Autenticação 3ds - `true`",
"default": false
},
"softdescriptor": {
"type": "string",
"description": "Texto exibido na fatura do cartão do comprador. Caso não informado, será enviado o cadastrado na plataforma."
},
"currency_code": {
"type": "string",
"description": "Moeda na qual o pagamento será processado. Valores possíveis:
`BRL`",
"default": "BRL"
},
"card": {
"type": "object",
"description": "Informações do Cartão a qual processará o pagamento.",
"required": [
"brand"
],
"properties": {
"holder": {
"type": "string",
"description": "Nome do comprador impresso no cartão. Obrigatório caso o pagamento não seja tokenizado."
},
"number": {
"type": "string",
"description": "Número do cartão do comprador. Obrigatório caso o pagamento não seja tokenizado."
},
"expiry_month": {
"type": "string",
"description": "Mês de expiração do cartão com dois dígitos. Obrigatório caso o pagamento não seja tokenizado."
},
"expiry_year": {
"type": "string",
"description": "Ano de expiração do cartão com quatro dígitos. Obrigatório caso o pagamento não seja tokenizado."
},
"brand": {
"type": "string",
"description": "Bandeira do cartão. Valores possíveis:
`Visa`
`Mastercard`
`Amex`
`Elo`
`Hipercard`"
},
"cvv": {
"type": "string",
"description": "Código de segurança impresso no cartão. Obrigatório caso o pagamento não seja tokenizado."
},
"vault": {
"type": "string",
"description": "Identificador do cartão no cofre. Obrigatório caso o pagamento seja tokenizado."
}
}
}
}
},
"customer": {
"type": "object",
"description": "Informações relacionados ao cliente vinculado ao pagamento.",
"required": [
"name",
"document"
],
"properties": {
"name": {
"type": "string",
"description": "Nome do comprador."
},
"document": {
"type": "string",
"description": "Número do documento (CPF) do comprador."
},
"email": {
"type": "string",
"description": "E-mail do comprador."
},
"phone": {
"type": "string",
"description": "Telefone do comprador."
},
"birthdate": {
"type": "string",
"description": "Data de nascimento do comprador."
},
"ip": {
"type": "string",
"description": "Endereço IP do dispositivo do comprador."
},
"billing_address": {
"type": "object",
"properties": {}
}
}
},
"metadata": {
"type": "array",
"description": "O parâmetro metadata permite que os usuários anexem informações adicionais a uma transação. Isso pode incluir qualquer par de chave-valor que forneça contexto ou detalhes adicionais sobre a transação. O metadata não é utilizado pela API para processar a transação, mas pode ser útil para o registro do usuário ou para a integração com outros sistemas.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"examples": {
"Exemplo de Requisição": {
"value": {
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"delayed_split": false,
"softdescriptor": "PAG*TESTE",
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiry_month": "09",
"expiry_year": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "example@test.com",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Sucesso": {
"value": "{\n \"status\": 3,\n \"returnCode\": \"0\",\n \"returnMessage\": \"Sucesso\",\n \"message\": \"SUCESSO\",\n \"paymentId\": \"010000003811041456460000064215020000000000\",\n \"authorizationCode\": \"007019\",\n \"orderNumber\": \"6183f4ac7ad8d\",\n \"onlineId\": \"HROJSF\",\n \"type\": \"credit\",\n \"delayed_split\": false,\n \"installments\": 1,\n \"brand\": \"mastercard\",\n \"amount\": 3990,\n \"fees\": 260,\n \"liquid\": 3730,\n \"acquirer\": \"adiq\",\n \"metadata\": [\n {\n \"metadata_key\": \"key\",\n \"metadata_value\": \"value\"\n },\n {\n \"metadata_key\": \"key2\",\n \"metadata_value\": \"value2\"\n }\n ],\n \"createdAt\": \"2021-11-04 11:56:50\",\n \"expireAt\": \"2021-11-11 11:56:50\",\n \"first4Digits\": \"5201\",\n \"last4Digits\": \"5011\",\n \"nsu\": \"61a7d95711f57\",\n \"customer\": {\n \"name\": \"Comprador Teste\",\n \"document\": \"99999999999\",\n \"email\": \"example@test.com\",\n \"phone\": \"11999999999\",\n \"birthDate\": \"1969-12-31\",\n \"billingAddress\": {\n \"street\": \"Rua teste\",\n \"number\": \"1\",\n \"district\": \"Bairro teste\",\n \"complement\": \"Complemento teste\",\n \"zipcode\": \"99999999\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BRA\"\n }\n }\n}\n"
}
},
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 3,
"default": 0
},
"returnCode": {
"type": "string",
"example": "0"
},
"returnMessage": {
"type": "string",
"example": "Sucesso"
},
"message": {
"type": "string",
"example": "SUCESSO"
},
"paymentId": {
"type": "string",
"example": "010000003811041456460000064215020000000000"
},
"authorizationCode": {
"type": "string",
"example": "007019"
},
"orderNumber": {
"type": "string",
"example": "6183f4ac7ad8d"
},
"onlineId": {
"type": "string",
"example": "HROJSF"
},
"type": {
"type": "string",
"example": "credit"
},
"delayed_split": {
"type": "boolean",
"example": false,
"default": true
},
"installments": {
"type": "integer",
"example": 1,
"default": 0
},
"brand": {
"type": "string",
"example": "mastercard"
},
"amount": {
"type": "integer",
"example": 3990,
"default": 0
},
"fees": {
"type": "integer",
"example": 260,
"default": 0
},
"liquid": {
"type": "integer",
"example": 3730,
"default": 0
},
"acquirer": {
"type": "string",
"example": "adiq"
},
"metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata_key": {
"type": "string",
"example": "key"
},
"metadata_value": {
"type": "string",
"example": "value"
}
}
}
},
"createdAt": {
"type": "string",
"example": "2021-11-04 11:56:50"
},
"expireAt": {
"type": "string",
"example": "2021-11-11 11:56:50"
},
"first4Digits": {
"type": "string",
"example": "5201"
},
"last4Digits": {
"type": "string",
"example": "5011"
},
"nsu": {
"type": "string",
"example": "61a7d95711f57"
},
"customer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Comprador Teste"
},
"document": {
"type": "string",
"example": "99999999999"
},
"email": {
"type": "string",
"example": "example@test.com"
},
"phone": {
"type": "string",
"example": "11999999999"
},
"birthDate": {
"type": "string",
"example": "1969-12-31"
},
"billingAddress": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "Rua teste"
},
"number": {
"type": "string",
"example": "1"
},
"district": {
"type": "string",
"example": "Bairro teste"
},
"complement": {
"type": "string",
"example": "Complemento teste"
},
"zipcode": {
"type": "string",
"example": "99999999"
},
"city": {
"type": "string",
"example": "São Paulo"
},
"state": {
"type": "string",
"example": "SP"
},
"country": {
"type": "string",
"example": "BRA"
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Falha na Requisição": {
"value": "{\n \"code\": \"string\",\n \"message\": \"string\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "string"
},
"message": {
"type": "string",
"example": "string"
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Não Autorizado": {
"value": "{\n \"message\": \"Token not provided, authorization denied\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Token not provided, authorization denied"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Requisição Inválida": {
"value": "{\n \"amount\": [\n \"The amount field is required.\"\n ],\n \"payment.type\": [\n \"The payment.type field is required.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"amount": {
"type": "array",
"items": {
"type": "string",
"example": "The amount field is required."
}
},
"payment.type": {
"type": "array",
"items": {
"type": "string",
"example": "The payment.type field is required."
}
}
}
}
}
}
}
},
"deprecated": false,
"security": []
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": false,
"proxy-enabled": true
},
"x-readme-fauxas": true,
"_id": "65bbf54ef65af3004d960226:65c5001aa144b9006b268475"
}
```