Skip to main content
GET
/
v1
/
payments
/
{id}
Obter cobranca
curl --request GET \
  --url https://api.payle.digital/v1/payments/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "pay_01j8td7x9q3vv1n1exr8d4m2se",
  "object": "payment",
  "amount": 12500,
  "originalAmount": 12500,
  "currency": "BRL",
  "status": "confirmed",
  "paymentMethod": "creditCard",
  "installments": 1,
  "fee": 375,
  "netAmount": 12125,
  "createdAt": "2025-10-24T18:02:11.000Z",
  "updatedAt": "2025-10-24T18:05:43.000Z",
  "confirmedAt": "2025-10-24T18:03:02.000Z",
  "acquirerPaymentId": "CI1234567890",
  "authorizationCode": "123456",
  "nsu": "987654",
  "failureReason": null,
  "failureMessage": null,
  "failureDetails": null,
  "paymentLinkId": null,
  "creditCard": {
    "brand": "visa",
    "cardNumber": "411111******1111",
    "expMonth": "12",
    "expYear": "2028",
    "holderName": "Maria Souza"
  },
  "nextAction": null,
  "customer": {
    "id": "cus_01hr8m2aym6rd0sx2xv5hek0nv",
    "object": "customer",
    "createdAt": "2025-10-21T13:55:21.000Z",
    "updatedAt": "2025-10-21T13:55:21.000Z",
    "name": "Maria Souza",
    "email": "[email protected]",
    "phone": "+55 11 99999-0000",
    "document": "12345678901"
  }
}

​
Quando usar

Chame esta rota para consultar os detalhes completos de uma cobranca ja criada. Use o parametro include para trazer o cliente relacionado quando precisar exibir os dados no mesmo payload.

​
Cabecalhos obrigatorios

  • x-api-key: <sua-chave>.
  • Accept: application/json.

​
Parametros de rota

ParametroTipoDescricao
idstringIdentificador da cobranca (pay_...).

​
Parametros de consulta

ParametroTipoDescricao
includestringLista de relacionamentos a incluir. Use include=customer para embutir o cliente vinculado. Suporta multiplos valores separados por virgula, mas atualmente apenas customer e aceito.

​
Exemplo de chamada

curl "https://api.payle.digital/v1/payments/pay_01j8td7x9q3vv1n1exr8d4m2se?include=customer" \
  -H "x-api-key: pk_test_123"

​
Resposta bem-sucedida

  • Status: 200 OK
  • Corpo segue o esquema Payment. Quando include=customer e informado, a resposta adiciona o objeto customer.
{
  "id": "pay_01j8td7x9q3vv1n1exr8d4m2se",
  "object": "payment",
  "amount": 12500,
  "originalAmount": 12500,
  "currency": "BRL",
  "status": "confirmed",
  "paymentMethod": "creditCard",
  "installments": 1,
  "fee": 375,
  "netAmount": 12125,
  "createdAt": "2025-10-24T18:02:11.000Z",
  "updatedAt": "2025-10-24T18:05:43.000Z",
  "confirmedAt": "2025-10-24T18:03:02.000Z",
  "acquirerPaymentId": "CI1234567890",
  "authorizationCode": "123456",
  "nsu": "987654",
  "failureReason": null,
  "failureMessage": null,
  "failureDetails": null,
  "paymentLinkId": null,
  "creditCard": {
    "brand": "visa",
    "cardNumber": "411111******1111",
    "expMonth": "12",
    "expYear": "2028",
    "holderName": "Maria Souza"
  },
  "nextAction": null,
  "customer": {
    "id": "cus_01hr8m2aym6rd0sx2xv5hek0nv",
    "object": "customer",
    "createdAt": "2025-10-21T13:55:21.000Z",
    "updatedAt": "2025-10-21T13:55:21.000Z",
    "name": "Maria Souza",
    "email": "[email protected]",
    "phone": "+55 11 99999-0000",
    "document": "12345678901"
  }
}

​
Tratamento de erros

  • 400 Bad Request: parametro include com valor nao suportado.
  • 401 Unauthorized: cabecalhos de autenticacao ausentes ou invalidos.
  • 403 Forbidden: conta autenticada sem permissao para consultar cobrancas.
  • 404 Not Found: cobranca inexistente para o id informado.
  • 429 Too Many Requests: limite de requisicoes excedido.

Authorizations

​
x-api-key
string
header
required

Chave gerada no dashboard Payle.

Path Parameters

​
id
string
required

Identificador da cobranca (prefixo pay_).

Example:

"pay_01j8td7x9q3vv1n1exr8d4m2se"

Query Parameters

​
include
enum<string>

Relacionamentos opcionais a incluir. Use include=customer para anexar o cliente.

Available options:
customer

Response

Cobranca retornada com sucesso.

​
id
string
required

Identificador unico da cobranca.

Example:

"pay_01j8td7x9q3vv1n1exr8d4m2se"

​
object
enum<string>
required

Tipo do recurso.

Available options:
payment
Example:

"payment"

​
amount
integer
required

Valor capturado em centavos.

Example:

12500

​
originalAmount
integer
required

Valor original solicitado em centavos.

Example:

12500

​
currency
string
required

Codigo da moeda no formato ISO 4217.

Example:

"BRL"

​
status
string
required

Status atual da cobranca.

Example:

"confirmed"

​
paymentMethod
string
required

Metodo de pagamento utilizado.

Example:

"creditCard"

​
installments
integer
required

Numero de parcelas aplicadas.

Example:

1

​
fee
integer
required

Taxas cobradas em centavos.

Example:

375

​
netAmount
integer
required

Valor liquido em centavos apos taxas.

Example:

12125

​
createdAt
string<date-time>
required

Data de criacao da cobranca.

Example:

"2025-10-24T18:02:11.000Z"

​
updatedAt
string<date-time>
required

Ultima atualizacao do registro.

Example:

"2025-10-24T18:05:43.000Z"

​
confirmedAt
string<date-time> | null

Data de confirmacao quando houver.

Example:

"2025-10-24T18:03:02.000Z"

​
acquirerPaymentId
string | null

Identificador do pagamento no adquirente.

Example:

"CI1234567890"

​
authorizationCode
string | null

Codigo de autorizacao retornado pela adquirente.

Example:

"123456"

​
nsu
string | null

NSU retornado pela adquirente.

Example:

"987654"

​
failureReason
string | null

Codigo padrao do motivo de falha quando aplicavel.

Example:

null

​
failureMessage
string | null

Mensagem descritiva da falha.

Example:

null

​
failureDetails
object | null

Detalhes adicionais sobre a falha.

​
paymentLinkId
string | null

Identificador do link de pagamento associado quando existir.

Example:

null

​
creditCard
object | null

Informacoes mascaradas do cartao.

​
nextAction
object | null

Proximo passo necessario para concluir o pagamento.

​
customer
object

Cliente associado retornado quando include=customer.