PIX

Chame a API de pagamentos para solicitar saque para seu cliente.

POST /v2/payout

Chamada

curl -v --location --request POST 'https://api-uat.jumppag.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "name": "Richard Roe",
        "email": "[email protected]",
        "document": {
          "type": "CPF",
          "number": "12345678909"
        }
      },
      "country": "BRA",
      "payment_method": "pix",
      "notification_url": "http://mysite.com/api/notification",
      "transfer": {
        "value": "12345678909"
      },
      "transaction": {
        "id": "4ff7f67f-8194-4a66-903f-0600716f27e8",
        "currency": "BRL",
        "amount": 100
      }
    }'

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.currency

string (BRL or USD)

Obrigatório: sim

A moeda na qual a transação está sendo conduzida. Use códigos de moeda padrão ISO 4217 (por exemplo, BRL, USD). Padrão: BRL

transaction.amount

decimal (10,2)

Obrigatório: sim

O valor total da transação na moeda especificada. Este valor deve ser um valor numérico (use ponto em vez de vírgula) Eg: 300.10

transaction.expire

integer (11)

Obrigatório: não

O tempo em segundos até que a transação expire e não seja mais válida

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 PIX, Boleto...

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

transfer.value

string

Obrigatório: sim

Chave Pix

Resposta

{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "pix"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "PEN",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "PEN",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}