CASH IN with Quote

Chame a API de Pagamentos para solicitar pagamentos via PIX com cotação.

POST /v2/trade/payment

Chamada

curl -v --location --request POST 'https://api-uat.jumppag.com/v2/trade/payment' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "81401e09-a227-46ac-8890-03eb225a920a",
            "name": "John Doe",
            "email": "[email protected]",
            "document": {
                "type": "CPF",
                "number": "12345678909"
            },
            "phone": "[phone]"
        },
        "country": "BRA",
        "payment_method": "pix",
        "notification_url": "https://my-notification-url.site",
        "transaction": {
            "id": "9fff0686-6866-445b-a540-2e96d827b7d5",
            "quote_id": "ad0784f0-1b2f-41e8-afd2-e72cfd6437fb"
        }
    }'

Detalhes dos parâmetros

customer.id

string

Obrigatório: sim

Identificador exclusivo para o cliente em seu sistema. Este valor deve permanecer consistente em todas as transações para o mesmo cliente

customer.name

string

Obrigatório: sim

O nome completo do cliente que está fazendo o pagamento. Deve corresponder ao nome nos documentos de identificação do cliente

customer.email

string

Obrigatório: sim

O endereço de e-mail do cliente. Este será usado para enviar confirmações de pagamento e notificações

customer.phone

string (E.164)

Obrigatório: não

O número de telefone do cliente, incluindo o código do país. Este parâmetro pode ser opcional ou obrigatório dependendo do método de pagamento usado. https://www.twilio.com/docs/glossary/what-e164

customer.birthdate

string

Obrigatório: não

A data de nascimento do cliente, fornecida no formato mm-dd-yyyy. Este parâmetro pode ser necessário dependendo dos regulamentos do país ou do método de pagamento

customer.document.number

string Format: 99999999999 / 9999999999999

Obrigatório: sim

O número de identificação oficial do cliente. Normalmente é uma identidade nacional ou outro documento emitido pelo governo

customer.document.type

string (CPF or CNPJ)

Obrigatório: sim

O tipo de documento fornecido pelo cliente. Os tipos comuns incluem ID nacional ou carteira de motorista. Lista de documentos permitidos . Padrão: CPF

customer.address.addres_1

string

Obrigatório: não

O endereço principal do cliente

customer.address.addres_2

string

Obrigatório: não

Informações adicionais de endereço, como número do apartamento ou suíte

customer.address.city

string

Obrigatório: não

A cidade em que o cliente reside

customer.address.country_code

string

Obrigatório: não

O código de país ISO 3166-1 alfa-3 para o endereço do cliente.

customer.address.neightborhood

string

Obrigatório: não

O bairro ou distrito do endereço do cliente

customer.address.number

string

Obrigatório: não

O número da rua do endereço

customer.address.postal_code

string

Obrigatório: não

O código postal ou CEP do endereço do cliente

customer.address.state

string

Obrigatório: não

O estado ou região do endereço do cliente

transaction.id

string

Obrigatório: sim

Um identificador exclusivo para a transação. Este ID deve ser gerado pelo seu sistema para rastrear o processo de pagamento específico

transaction.quote_id

string (BRL or USD)

Obrigatório: sim

id da cotação recuperada em Quote

branch

string min: 1 | max: 255

Obrigatório: não

O identificador específico da agência ou local onde a transação está sendo processada, se aplicável

country

string

Obrigatório: sim

O código do país onde a transação está ocorrendo. O formato é ISO 3166-1 alpha-3 (por exemplo, BRA para o Brasil).

payment_method

string

Obrigatório: sim

O método de pagamento utilizado para a transação, como transferência bancária, cartão de crédito...

notification_url

string

Obrigatório: sim

A URL para a qual as notificações de pagamento serão enviadas. Certifique-se de que esta URL esteja acessível e configurada para lidar com o formato de notificação

Resposta

{
	"requestId": "32fd061c0204e57b3f8524fd631d39e4\/8624435106531446739;o=1",
	"data": {
		"id": "642b6be0-7f47-4a98-98f1-f074b65ec928",
		"status": "pending",
		"expires_in": 1727126892,
		"payment": {
			"method": "pix",
			"qr_code": "00020101021226790014br.gov.bcb.pix2557brcode"
		},
		"values": {
			"source_total": "12.61000000",
			"source_currency": "BRL",
			"exchanged_total": "12.61",
			"exchanged_currency": "BRL",
			"exchange": "1.00",
			"fee": "0.12610000"
		}
	}
}

Detalhes da resposta

Link: visão geral