Skip to main content
POST
/
v1
/
payin
/
payments
/
credit-card
Create Charge
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v1/payin/payments/credit-card \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callbackUrl": "<string>",
  "customNumber": "<string>",
  "clientId": {},
  "title": {
    "title.expireDate": "<string>",
    "title.amountInCents": 123,
    "title.instructions": "<string>"
  },
  "buyer": {
    "buyer.name": "<string>",
    "buyer.document": {
      "buyer.document.number": "<string>",
      "buyer.document.type": "<string>"
    },
    "buyer.address": {
      "buyer.address.street": "<string>",
      "buyer.address.number": "<string>",
      "buyer.address.complement": "<string>",
      "buyer.address.zipCode": "<string>",
      "buyer.address.city": "<string>",
      "buyer.address.district": "<string>",
      "buyer.address.stateCode": "<string>"
    }
  },
  "refundMode": "<string>",
  "sender": {
    "sender.name": "<string>",
    "sender.document": "<string>",
    "sender.helpdesk": "<string>"
  },
  "checkout": {
    "checkout.token": "<string>",
    "checkout.card_id": 123,
    "checkout.installments": 123,
    "checkout.payment_method_id": "<string>",
    "checkout.payer_name": "<string>",
    "checkout.payer_phone": "<string>",
    "checkout.payer_document": "<string>",
    "checkout.payer_address": {
      "checkout.payer_address.zip_code": "<string>",
      "checkout.payer_address.street_name": "<string>",
      "checkout.payer_address.street_number": "<string>"
    },
    "checkout.payer_email": "<string>",
    "checkout.save_card": 123
  },
  "statement_descriptor": "<string>",
  "product_info": {},
  "use_3ds": {}
}
'
{
  "id": "28018",
  "key": "e1ebf9d914174902a76a5af436f091d09cca0b1e9ad8984b5dcdfeead67ce6b8",
  "clientId": 1,
  "clientName": "Your company",
  "senderName": null,
  "senderHelpdesk": null,
  "buyerName": "Maria da Silva",
  "buyerDocument": "34960826312",
  "buyerEmail": "buyer-email@wepayments.com.br",
  "customNumber": "YOUR-CODE1234",
  "ourNumber": null,
  "digitableLine": null,
  "barCodeNumber": null,
  "status": {
    "id": 1,
    "name": "awaiting approval"
  },
  "sender": {
    "name": null,
    "document": null,
    "helpdesk": null
  },
  "typePayin": "credit-card",
  "instructions": "Esse Pagamento é referente ao pedido 123 na loja abcd",
  "amountCents": 8652,
  "paidAmountCents": null,
  "paidAt": null,
  "expiresAt": "2024-12-31 23:59:59",
  "createdAt": "2024-02-21T19:15:00.000000Z",
  "fine": null,
  "discount": null,
  "statusHistory": [
    {
      "status": {
        "id": 1,
        "name": "Created"
      }
    },
    {
      "status": {
        "id": 6,
        "name": "awaiting approval"
      },
      "id": 48859,
      "updatedAt": "2024-02-21T19:15:04.000000Z"
    }
  ],
  "refundMode": "FULL_REFUND_CLIENT",
  "refundAmountCents": 0,
  "payinRefunds": [],
  "payin_substatus": null,
  "kyc": null,
  "installments": [],
  "hasAdvancement": true,
  "use3ds": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Request Body

​
callbackUrl
string
required
The url where we will submit the callbacks.
​
customNumber
string
required
Your identification number, it must be unique on our database.
​
clientId
integer or null
The use of clientID to create payments. Is mandatory if there is more than one account under the same clientId.
​
title
object
required
Payment instructions.
​
buyer
object
required
The person that you are charging object.
​
refundMode
string
Default: FULL_REFUND_CLIENTEnum: FULL_REFUND_CLIENT, FULL_REFUND_RECIPIENT, REFUND_BY_SPLITEnum of some refund options.
​
sender
object
required
REQUIRED FOR CREDIT-CARD CHARGES.Use this object to inform the legal name of the final beneficiary, it could be your company’s name or the company you are proving a service for.Final Beneficiary is a person or a company that will receive the amount paid trough the boleto.
​
checkout
object
Payer informations for transparent checkout. Use token for new card payment or card_id for saved card payment.
​
statement_descriptor
string
Short description shown at the credit-card bill.
​
product_info
array of objects
Array with product metadata.
​
use_3ds
integer or null
Default: nullEnum: 0, 1, nullFlag to inform that the charge must validate through three d secure mode

​
Response

​
id
string
Charge ID
​
key
string
Unique key for payment page access
​
clientId
integer
Client ID
​
clientName
string
Client name
​
senderName
string or null
Sender name
​
senderHelpdesk
string or null
Sender helpdesk
​
buyerName
string
Buyer name
​
buyerDocument
string
Buyer document
​
buyerEmail
string
Buyer email
​
customNumber
string
Your custom number
​
ourNumber
string or null
Our internal number
​
digitableLine
string or null
Digitable line (for boleto)
​
barCodeNumber
string or null
Bar code number (for boleto)
​
status
object
Current status
​
sender
object
Sender information
​
typePayin
string
Type of payment (e.g., “credit-card”)
​
instructions
string
Payment instructions
​
amountCents
integer
Amount in cents
​
paidAmountCents
integer or null
Paid amount in cents
​
paidAt
string or null
Payment date
​
expiresAt
string
Expiration date
​
createdAt
string
Creation date
​
fine
object or null
Fine information
​
discount
object or null
Discount information
​
statusHistory
array
Status change history
​
refundMode
string
Refund mode
​
refundAmountCents
integer
Refunded amount in cents
​
payinRefunds
array
Refund records
​
payin_substatus
string or null
Sub-status
​
kyc
object or null
KYC information
​
installments
array
Installment information
​
hasAdvancement
boolean
Has advancement flag
​
use3ds
boolean
3D Secure flag
{
  "id": "28018",
  "key": "e1ebf9d914174902a76a5af436f091d09cca0b1e9ad8984b5dcdfeead67ce6b8",
  "clientId": 1,
  "clientName": "Your company",
  "senderName": null,
  "senderHelpdesk": null,
  "buyerName": "Maria da Silva",
  "buyerDocument": "34960826312",
  "buyerEmail": "buyer-email@wepayments.com.br",
  "customNumber": "YOUR-CODE1234",
  "ourNumber": null,
  "digitableLine": null,
  "barCodeNumber": null,
  "status": {
    "id": 1,
    "name": "awaiting approval"
  },
  "sender": {
    "name": null,
    "document": null,
    "helpdesk": null
  },
  "typePayin": "credit-card",
  "instructions": "Esse Pagamento é referente ao pedido 123 na loja abcd",
  "amountCents": 8652,
  "paidAmountCents": null,
  "paidAt": null,
  "expiresAt": "2024-12-31 23:59:59",
  "createdAt": "2024-02-21T19:15:00.000000Z",
  "fine": null,
  "discount": null,
  "statusHistory": [
    {
      "status": {
        "id": 1,
        "name": "Created"
      }
    },
    {
      "status": {
        "id": 6,
        "name": "awaiting approval"
      },
      "id": 48859,
      "updatedAt": "2024-02-21T19:15:04.000000Z"
    }
  ],
  "refundMode": "FULL_REFUND_CLIENT",
  "refundAmountCents": 0,
  "payinRefunds": [],
  "payin_substatus": null,
  "kyc": null,
  "installments": [],
  "hasAdvancement": true,
  "use3ds": false
}