Skip to main content

Malga API Documentation (0.5)

Download OpenAPI specification:Download

Authentication

Malga’s API services are protected through access keys. You can manage your access keys through your dashboard.

It is important to store your keys privately and safely since they have modification privileges in your account. Do not share your keys, do not leave them fixed in your code, and do not store them on your version control server. We recommend using secret environment variables to make the key available to your application.

Authentication for all API calls is done through HTTP headers, requiring you to enter your Malga client identifier and secret access key.

X-Client-ID

Unique identifier of your account on Malga. It must be sent in the header as a mandatory field in all requests made to the API.

Security Scheme Type API Key
Header parameter name X-Client-ID

X-Api-Key

Your API access key. It works in conjunction with the client-id and must be sent in the header of all requests made to the API, mandatory.

Security Scheme Type API Key
Header parameter name X-Api-Key

Example authenticated request

  curl --location --request GET 'https://api.malga.io/v1/' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>'

Client-token

You can create temporary public keys to access the API with limited scope and expiration time.

We recommend using this type of key when you need to expose the key in a client-side application. In this case, you should make a call to the /auth service from your secret key, requesting the creation of a public key with limited scope.

The created public key can be used normally as if it were your account's secret key, but with the scope restriction and being invalidated upon expiration.

Parameters’ details of the public key’s request:

scope
string
Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers"

determina o escopo de endpoints que a chave terá acesso

expires
number
Default: 0

prazo de validade da chave em segundos a partir da criação, zero para não expirar

{
}

Public key creation response

scope
string
Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers"

determina o escopo de endpoints que a chave terá acesso

expires
number

prazo de validade da chave em segundos a partir da criação, zero para não expirar

clientId
string

identificador do cliente na Malga

publicKey
string

chave pública criada

{
}

Create public key for client-side integration

Authorizations:
Request Body schema: application/json

Creat authentication token

scope
string
Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers"

determina o escopo de endpoints que a chave terá acesso

expires
number
Default: 0

prazo de validade da chave em segundos a partir da criação, zero para não expirar

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Tokens

Parameters’ details of the card token's request:

TokenCard (object) or TokenCvv (object)

The card and/or CVV can be tokenized according to the passing of the attributes

One of
cardHolderName
required
string

Cardholder Name

cardNumber
required
string

Card Number (No spaces)

cardCvv
required
string

Verification Code

cardExpirationDate
required
string

Expiration Month and Year in the format MM/YYYY

{
}

Create new token

Authorizations:
Request Body schema: application/json

Tokenize

TokenCard (object) or TokenCvv (object)

The card and/or CVV can be tokenized according to the passing of the attributes

One of
cardHolderName
required
string

Cardholder Name

cardNumber
required
string

Card Number (No spaces)

cardCvv
required
string

Verification Code

cardExpirationDate
required
string

Expiration Month and Year in the format MM/YYYY

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
{
}

Cards

Attributues of a card object

id
string

ID do cartão

expirationMonth
string

Data de expiração MM

expirationYear
string

Data de expiração YYYY

brand
string
Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners"

Bandeira

cvvChecked
boolean

Identifica se o CVV foi verificado

fingerprint
string

Hash de identificação única do cartão com base nos dados sensíveis

first6digits
string

Primeiros 6 digitos do cartão

last4digits
string

Últimos 4 digitos do cartão

status
string
Enum: "failed" "active" "pending"

Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente)

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

{
}

Create a new card from card token

Authorizations:
Request Body schema: application/json

Create credit card

tokenId
required
string

Identificador do token gerado

merchantId
string <uuid>

If you would like to validate the card via zero dollar, enter the merchantId that has at least 1 provider that supports zero dollar validation.

cvvCheck
boolean

Even informing the merchantId, it is possible to disable CVV (zero dollar) validation. Enter true to validate or false to skip validation. If you enter false, the verification will be skipped and the card will be created as pending and will need to be validated via a transaction.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

List cards

Authorizations:
query Parameters
page
string

page number

limit
string

total itens per page

Responses

Response Schema: application/json
object (MetaPagination)
itemCount
integer

number of items on the page

totalItems
integer

total number of items in the query

itemsPerPage
integer

number of items per page

totalPages
integer

total number of pages

currentPage
integer

current page

items
array (Card)

Response samples

Content type
application/json
{
}

Get card details

Authorizations:
path Parameters
id
required
string

Card ID

Responses

Response Schema: application/json
id
string

ID do cartão

expirationMonth
string

Data de expiração MM

expirationYear
string

Data de expiração YYYY

brand
string
Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners"

Bandeira

cvvChecked
boolean

Identifica se o CVV foi verificado

fingerprint
string

Hash de identificação única do cartão com base nos dados sensíveis

first6digits
string

Primeiros 6 digitos do cartão

last4digits
string

Últimos 4 digitos do cartão

status
string
Enum: "failed" "active" "pending"

Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente)

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

Response samples

Content type
application/json
{
}

Customers

Through the customer’s API you can create, edit, list, and delete shopper’s data for use in card tokenization services, PIX charges, Invoices (payment slips), use in anti-fraud and recurrence engine analysis.

In order to maintain data integrity, email and document (Personal registration number/National registry of legal entities) information are unique to customers on your Malga account, and no two buyers can be the same.

Create new customer

Authorizations:
Request Body schema: application/json
name
required
string

nome do usuario

email
required
string

email do usuario

phoneNumber
required
string

telefone de contato do usuario

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

Responses

Request samples

Content type
application/json
{
}

List customers

Authorizations:
query Parameters
page
string

page number

limit
string

total itens per page

sort
string
Enum: "ASC" "DESC"

ordering of items

id
string

customer identifier

document.type
string

document type

document.number
string

document number

Responses

Response Schema: application/json
object (MetaPagination)
itemCount
integer

number of items on the page

totalItems
integer

total number of items in the query

itemsPerPage
integer

number of items per page

totalPages
integer

total number of pages

currentPage
integer

current page

object (Customer)
id
string

identificador do customer

createdAt
string

data de criação

clientId
string

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

Response samples

Content type
application/json
{
}

Get customer details

Authorizations:
path Parameters
id
required
string

Customer ID

Responses

Response Schema: application/json
id
string

identificador do customer

createdAt
string

data de criação

clientId
string

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

Response samples

Content type
application/json
{
}

Delete customer

Authorizations:
path Parameters
id
required
string

Custome ID

Responses

Update customer

Authorizations:
path Parameters
id
required
string

Customer ID

Request Body schema: application/json
name
string

nome do usuario

phoneNumber
string

telefone de contato do usuario

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

Responses

Request samples

Content type
application/json
{
}

Add credit card to customers

Authorizations:
path Parameters
customer_id
required
string

Customer ID

Request Body schema: application/json
cardId
required
string

Identificador do cartão a ser associado

Responses

Request samples

Content type
application/json
{
}

List customer cards

Authorizations:
path Parameters
customer_id
required
string

Customer ID

Responses

Response Schema: application/json
object (MetaPagination)
itemCount
integer

number of items on the page

totalItems
integer

total number of items in the query

itemsPerPage
integer

number of items per page

totalPages
integer

total number of pages

currentPage
integer

current page

items
array (Card)

Response samples

Content type
application/json
{
}

Charges

To implement a charge, you must create a charge object. You can retrieve details of individual transactions, or list all the charges made at a given merchant. Charges are identified by a 'unique' id.

Basic data of an charge object

id
string

Charge ID

clientId
string

client identification on Malga

merchantId
string

merchant identification used in charge

customerId
string

customer identification

description
string

short description

amount
number

transaction amount in cents, example 100 to charge R$ 1.00

currency
string
Default: "BRL"

currency code to be used in charge, ISO 4217 format (see table of types).

statementDescriptor
string

description to be displayed on the buyer's bank statement

capture
boolean

whether the transaction should be captured automatically

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

charge status on Malga

orderId
string

Unique identification of order in your side to help future conciliation

PaymentMethodCardResponse (object) or PaymentMethodPixResponse (object) or PaymentMethodBoletoResponse (object) or PaymentMethodDripResponse (object) or PaymentMethodVoucherResponse (object) or PaymentMethodNuPayResponse (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string

Identificador do cartão quando source tipo card

cardCvv
string

Verification code without tokenization, must be sent whenever the buyer is present at the time of purchase (optional)

createdAt
string

Created date

updatedAt
string

Updated date

object

Additional parameters for fraud analysis

sla
number

Value in Minutes of Maximum SLA of Request Analysis, if any

object

customer (payeer) data

name
string

customer name

email
string

customer email

phone
string

customer phone number

identityType
string

document type, see table of types

identity
string

document number

registrationDate
string

customer registration date

object

Delivery address

object

Billing address

object

Cart of products details

Array of objects[ items ]
Array
name
string

Product/event name

quantity
integer

Items of product purchased

sku
string

Unique product identification on store

unitPrice
integer

Unit price of product in cents

risk
enum

Product risk of fraud

description
string

Product/event description

categoryId
string

Category which product/event belongs to

locality
string

Location definition, in case of an event

date
string

Date setting, in case of an event

type
number

Type definition, in case of an event

genre
string

Gender definition, in case of an event

object

Information related to tickets, in case of an event

object

Address setting, in case of an event

Array of objects (TransactionRequest) [ items ]
Array
id
string

unique identification of request on the provider

providerId
string

provider identification related to your merchant id

providerType
string

provider code, see table of supported providers

idempotencyKey
string

unique identification automatically created by Malga for each request, used to assure idempotency and avoid duplicity, could be used to get transactions in the provider's API or dashboard.

authorizationNsu
string
Deprecated

authorization number retunred by provider

transactionId
string

unique identification of transaction on provider, could be used to get transaction in the provider's API.

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

type of request performed on provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status of request processing

amount
number

transaction request amount sent to provider, for partial capture/refund the amount could be different from original transaction amount

responseTs
string

total spent time in request processing

object

transaction requet error details

object

additional data returned by provider

createdAt
string

Created date of request

updatedAt
string

Updated date of request

{
}

Create new charge

Authorizations:
Request Body schema: application/json
merchantId
required
string

merchant identification to be used in transaction and define the routing rule.

amount
required
number

transaction amount in cents, example 100 to charge R$ 1.00

currency
string
Default: "BRL"

currency code to be used in charge, ISO 4217 format (see table of types).

statementDescriptor
string

description to be displayed on the buyer's bank statement

capture
boolean

whether the transaction should be captured automatically

orderId
string

Unique identification of order in your side to help future conciliation

description
string

Short description to help future conciliation

customerId
string

Customer identification to help future conciliation

required
PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaymentMethodNuPay (object) or PaymentMethodVoucher (object) or PaymentMethodDrip (object)

Payment method to be used

One of
paymentType
required
string
Enum: "credit" "debit" "voucher"

Card Credit/Debit/Voucher payment method

installments
number

Installments quantity to the credit charges

required
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) or SourceTypeCardCvv (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string

Identificador do cartão quando source tipo card

cardCvv
string

Verification code without tokenization, must be sent whenever the buyer is present at the time of purchase (optional)

object

Additional parameters for fraud analysis, required by provider's anti-fraud

sla
number

Value in Minutes of Maximum SLA of Request Analysis, if any

object

customer (payeer) data

name
string

customer name

email
string

customer email

phone
string

customer phone number

identityType
string

document type, see table of types

identity
string

document number

registrationDate
string

customer registration date

object

Delivery customer address

object

Billing customer address

object

information about customer browser

object

Cart of products details

Array of objects[ items ]
Array
name
string

Product/event name

quantity
integer

Items of product purchased

sku
string

Unique product identification on store

unitPrice
integer

Unit price of product in cents

risk
enum

Product risk of fraud

description
string

Product/event description

categoryId
string

Category which product/event belongs to

locality
string

Location definition, in case of an event

date
string

Date setting, in case of an event

type
number

Type definition, in case of an event

genre
string

Gender definition, in case of an event

object

Information related to tickets, in case of an event

object

Address setting, in case of an event

object

Customer device details

object
model
string

Device model

ramCapacity
integer

Device ram capacity

diskCapacity
integer

Device disk capacity

freeDiskSpace
integer

Device disk space still free

resolution
integer

Device resolution

Array of objects[ items ]
object

Device attributes by vendor

Array of objects (SplitRules) [ items ]

Additional parameters for transacting with Split

Array
sellerId
string <uuid>

seller id

percentage
number

percentage of the transaction amount that will be sent to the receiver

amount
number

amount that will be sent to the receiver

processingFee
boolean

indicates whether the recipient linked to the rule will be charged transaction fees

liable
boolean

indicates whether the linked recipient will assume the chargeback risks of the transaction

object (SplitRulesFaresSchema)

Informações sobre as taxas que serão cobradas do recebedor - Apenas para sellers com provedor Braspag

object

Additional fields for use in conditionals of smart flows

metadata
required
object

Additional transaction fields sent upon its creation

threeDSecure2
object

Additional parameters for transacting with 3D Secure 2

object

Information about charge traceability

object

Product transaction information (checkout-sdk, vtex, magento, etc.)

integrator
string

Partner name who implemented the integration

name
required
string

Product name

version
required
string

Product version

object

Device information (iOS, android, windows, linux)

name
required
string

Operating system name

version
required
string

Operating system version

object

Merchant's proprietary capture system information

name
required
string

Company and/or platform name

version
required
string

Platform software version

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

List charges

Authorizations:
query Parameters
page
string

page number

limit
string

total itens per page

Responses

Response Schema: application/json
object (MetaPaginationCache)
itemCount
integer

number of items on the page

totalItems
integer

total number of items in the query (this value has a 5 minute cache to improve the performance of the api)

itemsPerPage
integer

number of items per page

totalPages
integer

total number of pages

currentPage
integer

current page

items
array (Charge)

Response samples

Content type
application/json
{
}

Get charge details

Authorizations:
path Parameters
id
required
string

Charge ID

Responses

Response Schema: application/json
id
string

Charge ID

clientId
string

client identification on Malga

merchantId
string

merchant identification used in charge

customerId
string

customer identification

description
string

short description

amount
number

transaction amount in cents, example 100 to charge R$ 1.00

currency
string
Default: "BRL"

currency code to be used in charge, ISO 4217 format (see table of types).

statementDescriptor
string

description to be displayed on the buyer's bank statement

capture
boolean

whether the transaction should be captured automatically

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

charge status on Malga

orderId
string

Unique identification of order in your side to help future conciliation

PaymentMethodCardResponse (object) or PaymentMethodPixResponse (object) or PaymentMethodBoletoResponse (object) or PaymentMethodDripResponse (object) or PaymentMethodVoucherResponse (object) or PaymentMethodNuPayResponse (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string

Identificador do cartão quando source tipo card

cardCvv
string

Verification code without tokenization, must be sent whenever the buyer is present at the time of purchase (optional)

createdAt
string

Created date

updatedAt
string

Updated date

object

Additional parameters for fraud analysis

sla
number

Value in Minutes of Maximum SLA of Request Analysis, if any

object

customer (payeer) data

name
string

customer name

email
string

customer email

phone
string

customer phone number

identityType
string

document type, see table of types

identity
string

document number

registrationDate
string

customer registration date

object

Delivery address

object

Billing address

object

Cart of products details

Array of objects[ items ]
Array
name
string

Product/event name

quantity
integer

Items of product purchased

sku
string

Unique product identification on store

unitPrice
integer

Unit price of product in cents

risk
enum

Product risk of fraud

description
string

Product/event description

categoryId
string

Category which product/event belongs to

locality
string

Location definition, in case of an event

date
string

Date setting, in case of an event

type
number

Type definition, in case of an event

genre
string

Gender definition, in case of an event

object

Information related to tickets, in case of an event

object

Address setting, in case of an event

Array of objects (TransactionRequest) [ items ]
Array
id
string

unique identification of request on the provider

providerId
string

provider identification related to your merchant id

providerType
string

provider code, see table of supported providers

idempotencyKey
string

unique identification automatically created by Malga for each request, used to assure idempotency and avoid duplicity, could be used to get transactions in the provider's API or dashboard.

authorizationNsu
string
Deprecated

authorization number retunred by provider

transactionId
string

unique identification of transaction on provider, could be used to get transaction in the provider's API.

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

type of request performed on provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status of request processing

amount
number

transaction request amount sent to provider, for partial capture/refund the amount could be different from original transaction amount

responseTs
string

total spent time in request processing

object

transaction requet error details

object

additional data returned by provider

createdAt
string

Created date of request

updatedAt
string

Updated date of request

Response samples

Content type
application/json
{
}

Change the status of a charge in the sandbox environment

Authorizations:
path Parameters
id
required
string <uuid>

id of the charge you want to change in the sandbox

Request Body schema: application/json
status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "created" "processed" "capture_pending" "refund_pending"

transaction status

Responses

Response Schema: application/json
id
string

Charge ID

clientId
string

client identification on Malga

merchantId
string

merchant identification used in charge

customerId
string

customer identification

description
string

short description

amount
number

transaction amount in cents, example 100 to charge R$ 1.00

currency
string
Default: "BRL"

currency code to be used in charge, ISO 4217 format (see table of types).

statementDescriptor
string

description to be displayed on the buyer's bank statement

capture
boolean

whether the transaction should be captured automatically

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

charge status on Malga

orderId
string

Unique identification of order in your side to help future conciliation

PaymentMethodCardResponse (object) or PaymentMethodPixResponse (object) or PaymentMethodBoletoResponse (object) or PaymentMethodDripResponse (object) or PaymentMethodVoucherResponse (object) or PaymentMethodNuPayResponse (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string

Identificador do cartão quando source tipo card

cardCvv
string

Verification code without tokenization, must be sent whenever the buyer is present at the time of purchase (optional)

createdAt
string

Created date

updatedAt
string

Updated date

object

Additional parameters for fraud analysis

sla
number

Value in Minutes of Maximum SLA of Request Analysis, if any

object

customer (payeer) data

name
string

customer name

email
string

customer email

phone
string

customer phone number

identityType
string

document type, see table of types

identity
string

document number

registrationDate
string

customer registration date

object

Delivery address

object

Billing address

object

Cart of products details

Array of objects[ items ]
Array
name
string

Product/event name

quantity
integer

Items of product purchased

sku
string

Unique product identification on store

unitPrice
integer

Unit price of product in cents

risk
enum

Product risk of fraud

description
string

Product/event description

categoryId
string

Category which product/event belongs to

locality
string

Location definition, in case of an event

date
string

Date setting, in case of an event

type
number

Type definition, in case of an event

genre
string

Gender definition, in case of an event

object

Information related to tickets, in case of an event

object

Address setting, in case of an event

Array of objects (TransactionRequest) [ items ]
Array
id
string

unique identification of request on the provider

providerId
string

provider identification related to your merchant id

providerType
string

provider code, see table of supported providers

idempotencyKey
string

unique identification automatically created by Malga for each request, used to assure idempotency and avoid duplicity, could be used to get transactions in the provider's API or dashboard.

authorizationNsu
string
Deprecated

authorization number retunred by provider

transactionId
string

unique identification of transaction on provider, could be used to get transaction in the provider's API.

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

type of request performed on provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status of request processing

amount
number

transaction request amount sent to provider, for partial capture/refund the amount could be different from original transaction amount

responseTs
string

total spent time in request processing

object

transaction requet error details

object

additional data returned by provider

createdAt
string

Created date of request

updatedAt
string

Updated date of request

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Change the status of a antifraud in the sandbox environment

Authorizations:
path Parameters
id
required
string <uuid>

id of the charge you want to change in the sandbox

Request Body schema: application/json
status
string
Enum: "approved" "reproved" "failed"

antifraud status

Responses

Response Schema: application/json
id
string

Charge ID

clientId
string

client identification on Malga

merchantId
string

merchant identification used in charge

customerId
string

customer identification

description
string

short description

amount
number

transaction amount in cents, example 100 to charge R$ 1.00

currency
string
Default: "BRL"

currency code to be used in charge, ISO 4217 format (see table of types).

statementDescriptor
string

description to be displayed on the buyer's bank statement

capture
boolean

whether the transaction should be captured automatically

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

charge status on Malga

orderId
string

Unique identification of order in your side to help future conciliation

PaymentMethodCardResponse (object) or PaymentMethodPixResponse (object) or PaymentMethodBoletoResponse (object) or PaymentMethodDripResponse (object) or PaymentMethodVoucherResponse (object) or PaymentMethodNuPayResponse (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string

Identificador do cartão quando source tipo card

cardCvv
string

Verification code without tokenization, must be sent whenever the buyer is present at the time of purchase (optional)

createdAt
string

Created date

updatedAt
string

Updated date

object

Additional parameters for fraud analysis

sla
number

Value in Minutes of Maximum SLA of Request Analysis, if any

object

customer (payeer) data

name
string

customer name

email
string

customer email

phone
string

customer phone number

identityType
string

document type, see table of types

identity
string

document number

registrationDate
string

customer registration date

object

Delivery address

object

Billing address

object

Cart of products details

Array of objects[ items ]
Array
name
string

Product/event name

quantity
integer

Items of product purchased

sku
string

Unique product identification on store

unitPrice
integer

Unit price of product in cents

risk
enum

Product risk of fraud

description
string

Product/event description

categoryId
string

Category which product/event belongs to

locality
string

Location definition, in case of an event

date
string

Date setting, in case of an event

type
number

Type definition, in case of an event

genre
string

Gender definition, in case of an event

object

Information related to tickets, in case of an event

object

Address setting, in case of an event

Array of objects (TransactionRequest) [ items ]
Array
id
string

unique identification of request on the provider

providerId
string

provider identification related to your merchant id

providerType
string

provider code, see table of supported providers

idempotencyKey
string

unique identification automatically created by Malga for each request, used to assure idempotency and avoid duplicity, could be used to get transactions in the provider's API or dashboard.

authorizationNsu
string
Deprecated

authorization number retunred by provider

transactionId
string

unique identification of transaction on provider, could be used to get transaction in the provider's API.

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

type of request performed on provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status of request processing

amount
number

transaction request amount sent to provider, for partial capture/refund the amount could be different from original transaction amount

responseTs
string

total spent time in request processing

object

transaction requet error details

object

additional data returned by provider

createdAt
string

Created date of request

updatedAt
string

Updated date of request

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Capture pre-authorized charge

Authorizations:
path Parameters
id
required
string

pre-authorized Charge ID

Request Body schema: application/json
amount
number

the value to be captured in cents cannot be greater than the transaction value, example 100 to charge R$ 1.00

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Refund authorized charge

Authorizations:
path Parameters
id
required
string

Charge ID

Request Body schema: application/json
amount
number

the value to be refunded in cents cannot be greater than the transaction value, example 100 to charge R$ 1.00

delayToCompose
number

number of days to compose the refunded value. It is only used in NuPay integrations.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Sessions

Using sessions API it's possible to create an order, with items, payment methods and more, that can be payed through an endpoint or integrated to MalgaCheckout.

Creating and paying a session

  • Create a session informing the minimum required data
  • Using the publicKey returned by the creation or got by the details endpoint on X-Api-Key to authorize the payment

Basic data of a session object

id
string

Session ID

name
string

Session name

status
string
Enum: "created" "paid" "canceled" "voided"

Session status

isActive
boolean

Whether the session is active

clientId
string

Client identification on Malga

orderId
string

Unique identification of order in your side to help future conciliation

amount
number

Transaction amount in cents, example 100 to charge R$ 1.00

currency
string

Currency code to be used in charge, ISO 4217 format (see table of types)

capture
boolean

Whether the transaction should be captured automatically

merchantId
string

Merchant identification used in charge

dueDate
string

Session expiration date

description
string

Session description

statementDescriptor
string

Description to be displayed on the buyer's bank statement

Array of objects (SessionItemObject) [ items ]

Order items

Array
name
string

Session item name

description
string

Session item description

unitPrice
number

Item unit amount in cents, example 100 to charge R$ 1.00

quantity
number

Item quantity

tangible
boolean

Whether the item is tangible

paymentLink
string

Link to access Payment Link of this session

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodDripObject (object) or PaymentMethodNupayObject (object)

Payment methods available on this session

Any of
paymentType
required
string
Enum: "credit" "debit"

Credit/Debit card charge method

installments
number

Installments quantity for credit payments

createdAt
string

Created date

updatedAt
string

Updated date

publicKey
string

Access key with limited scope, must be used to pay the session

{
}

Create new session

Authorizations:
Request Body schema: application/json
orderId
string

Unique identification of order in your side to help future conciliation

amount
required
number

Transaction amount in cents, example 100 to charge R$ 1.00

currency
string
Default: "BRL"

Currency code to be used in charge, ISO 4217 format (see table of types)

isActive
boolean

Whether the session is active

capture
boolean

Whether the transaction should be captured automatically

merchantId
required
string

Merchant identification used in charge

dueDate
required
string

Session expiration date

name
required
string

Session name

description
string

Session description

statementDescriptor
string

Description to be displayed on the buyer's bank statement

createLink
boolean

Whether the session has a Payment Link

required
PaymentMethodCardObject (object) or PaymentMethodPixObjectRequest (object) or PaymentMethodBoletoObjectRequest (object) or PaymentMethodDripObjectRequest (object) or PaymentMethodNupayObjectRequest (object)

Payment methods available on this session

Any of
paymentType
required
string
Enum: "credit" "debit"

Credit/Debit card charge method

installments
number

Installments quantity for credit payments

required
Array of objects (SessionItemObject) [ items ]

Order items

Array
name
string

Session item name

description
string

Session item description

unitPrice
number

Item unit amount in cents, example 100 to charge R$ 1.00

quantity
number

Item quantity

tangible
boolean

Whether the item is tangible

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get session details

Authorizations:
path Parameters
id
required
string <uuid>

Session ID

Responses

Response samples

Content type
application/json
{
}

Update session status

Authorizations:
path Parameters
id
required
string <uuid>

Session ID

Responses

Response samples

Content type
application/json
{
}

Pay session

Authorizations:
path Parameters
id
required
string <uuid>

Session ID

Request Body schema: application/json
customerId
string <uuid>

Customer identification

required
PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaySessionPaymentMethodDripObjectRequest (object) or PaymentSessionNuPay (object)

Payment method to be used

One of
paymentType
required
string
Enum: "credit" "debit" "voucher"

Card Credit/Debit/Voucher payment method

installments
number

Installments quantity to the credit charges

required
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string

Identificador do cartão quando source tipo card

cardCvv
string

Verification code without tokenization, must be sent whenever the buyer is present at the time of purchase (optional)

object

Additional parameters for fraud analysis, required by provider's anti-fraud

sla
number

Value in Minutes of Maximum SLA of Request Analysis, if any

object

customer (payeer) data

name
string

customer name

email
string

customer email

phone
string

customer phone number

identityType
string

document type, see table of types

identity
string

document number

registrationDate
string

customer registration date

object

Delivery customer address

object

Billing customer address

object

information about customer browser

object

Cart of products details

Array of objects[ items ]
Array
name
string

Product/event name

quantity
integer

Items of product purchased

sku
string

Unique product identification on store

unitPrice
integer

Unit price of product in cents

risk
enum

Product risk of fraud

description
string

Product/event description

categoryId
string

Category which product/event belongs to

locality
string

Location definition, in case of an event

date
string

Date setting, in case of an event

type
number

Type definition, in case of an event

genre
string

Gender definition, in case of an event

object

Information related to tickets, in case of an event

object

Address setting, in case of an event

object

Customer device details

object
model
string

Device model

ramCapacity
integer

Device ram capacity

diskCapacity
integer

Device disk capacity

freeDiskSpace
integer

Device disk space still free

resolution
integer

Device resolution

Array of objects[ items ]
object

Device attributes by vendor

object

Additional parameters for transacting with Split

sellerId
string <uuid>

seller id

percentage
number

percentage of the transaction amount that will be sent to the receiver

amount
number

amount that will be sent to the receiver

processingFee
boolean

indicates whether the recipient linked to the rule will be charged transaction fees

liable
boolean

indicates whether the linked recipient will assume the chargeback risks of the transaction

object (SplitRulesFaresSchema)

Informações sobre as taxas que serão cobradas do recebedor - Apenas para sellers com provedor Braspag

mdr
number

Indicates the percentage to be deducted from the value of a transaction, defined by product (credit/debit/ticket), brand and installment range

fee
number

Indicates amount in cents to be charged per captured transaction. It is deducted at the time of “setting up” the financial agenda

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

Cancel session

Authorizations:
path Parameters
id
required
string <uuid>

Session ID

Responses

Response samples

Content type
application/json
{
}

Recover session history

Authorizations:
path Parameters
id
required
string <uuid>

Session ID

Responses

Response samples

Content type
application/json
{ }

Recover session with company settings

Authorizations:
path Parameters
id
required
string <uuid>

Session ID

Responses

Response samples

Content type
application/json
{ }

Sellers

To perform a Split payment, it is necessary to create a seller first. Sellers are identified by a unique ID.

Through the seller APIs, you can create and configure receivers who will benefit from a Split payment. A receiver, or a seller, is an individual or legal entity registered to whom you are interested in automatically transferring values from a specific payment.

Note that the owner and business fields are optional. However, if the provider is Zoop and the business field is sent, the owner field becomes mandatory.

merchantId
required
string

Merchant ID identification to be used

mcc
required
number

Merchant segment code in the acquirer, please request it from your provider if you don't know your Merchant Category Code

object
name
required
string

Recipient establishment name

phoneNumber
required
string

Recipient establishment contact phone

email
required
string

Recipient establishment email

website
string

Recipient establishment website

description
required
string

Recipient establishment description

facebook
string

Recipient establishment Facebook

twitter
string

Recipient establishment Twitter

openingDate
required
string

Recipient establishment opening date in ISO-Date format, e.g., 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

object
name
required
string

Recipient's name

email
required
string

Recipient's email

phoneNumber
required
string

Recipient's contact phone

birthdate
required
string

Recipient's date of birth in ISO-Date format, e.g., 1996-01-31

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

required
object
holderName
required
string

Bank account holder's name

holderDocument
required
string

Bank account holder's document

bank
required
string

Bank code

branchNumber
required
string

Branch number

branchCheckDigit
string

Branch verifier code

accountNumber
required
string

Bank account number

accountCheckDigit
string

Bank account verifier number

type
required
string
Enum: "conta_corrente" "conta_poupanca" "conta_corrente_conjunta" "conta_poupanca_conjunta"

Account type

required
object
transferDay
required
string

Day when the partner will be paid. It depends on the transfer_interval - if it's daily, send 1. If it's weekly, it can be from 1 (Monday) to 5 (Friday). If it's monthly, it can be from 1 to 31. Additionally, if it's daily and the provider is Pagarme, the value is 0

transferEnabled
required
boolean

Determines whether transfers are authorized to occur or not

transferInterval
required
string
Enum: "daily" "weekly" "monthly"

Interval between transfers

automaticAnticipationEnabled
boolean

Indicates whether the receiver will receive automatic advances

anticipatableVolumePercentage
string

Indicates the percentage of the volume eligible for advancement to the receiver

automaticAnticipationType
string

Indicates the type of automatic advancement that will be configured for the receiver's account

automaticAnticipationDays
string

Indicates the number of days for automatic advancement

automaticAnticipation1025Delay
string

Indicates the number of days that will be disregarded in the calculation of the eligible advancement amount. The counting of days is done backwards from the day of advancement

{
}

Create new seller

Authorizations:
Request Body schema: application/json
merchantId
string

Merchant identification

object
name
required
string

Recipient's name

email
required
string

Recipient's email

phoneNumber
required
string

Recipient's contact phone

birthdate
required
string

Recipient's date of birth in ISO-Date format, e.g., 1996-01-31

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

object
name
required
string

Recipient establishment name

phoneNumber
required
string

Recipient establishment contact phone

email
required
string

Recipient establishment email

website
string

Recipient establishment website

description
required
string

Recipient establishment description

facebook
string

Recipient establishment Facebook

twitter
string

Recipient establishment Twitter

openingDate
required
string

Recipient establishment opening date in ISO-Date format, e.g., 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

mcc
string

Merchant segment code at the acquirer

object
holderName
required
string

Bank account holder's name

holderDocument
required
string

Bank account holder's document

bank
required
string

Bank code

branchNumber
required
string

Branch number

branchCheckDigit
string

Branch verifier code

accountNumber
required
string

Bank account number

accountCheckDigit
string

Bank account verifier number

type
required
string
Enum: "conta_corrente" "conta_poupanca" "conta_corrente_conjunta" "conta_poupanca_conjunta"

Account type

metaData
any
object
transferDay
required
string

Day when the partner will be paid. It depends on the transfer_interval - if it's daily, send 1. If it's weekly, it can be from 1 (Monday) to 5 (Friday). If it's monthly, it can be from 1 to 31. Additionally, if it's daily and the provider is Pagarme, the value is 0

transferEnabled
required
boolean

Determines whether transfers are authorized to occur or not

transferInterval
required
string
Enum: "daily" "weekly" "monthly"

Interval between transfers

automaticAnticipationEnabled
boolean

Indicates whether the receiver will receive automatic advances

anticipatableVolumePercentage
string

Indicates the percentage of the volume eligible for advancement to the receiver

automaticAnticipationType
string

Indicates the type of automatic advancement that will be configured for the receiver's account

automaticAnticipationDays
string

Indicates the number of days for automatic advancement

automaticAnticipation1025Delay
string

Indicates the number of days that will be disregarded in the calculation of the eligible advancement amount. The counting of days is done backwards from the day of advancement

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

Querying a recipient by ID

Authorizations:
path Parameters
id
required
string <uuid>

Seller identifier

Responses

Response Schema: application/json
merchantId
string

Merchant identification

object
name
required
string

Recipient's name

email
required
string

Recipient's email

phoneNumber
required
string

Recipient's contact phone

birthdate
required
string

Recipient's date of birth in ISO-Date format, e.g., 1996-01-31

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

object
name
required
string

Recipient establishment name

phoneNumber
required
string

Recipient establishment contact phone

email
required
string

Recipient establishment email

website
string

Recipient establishment website

description
required
string

Recipient establishment description

facebook
string

Recipient establishment Facebook

twitter
string

Recipient establishment Twitter

openingDate
required
string

Recipient establishment opening date in ISO-Date format, e.g., 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

mcc
string

Merchant segment code at the acquirer

object
holderName
required
string

Bank account holder's name

holderDocument
required
string

Bank account holder's document

bank
required
string

Bank code

branchNumber
required
string

Branch number

branchCheckDigit
string

Branch verifier code

accountNumber
required
string

Bank account number

accountCheckDigit
string

Bank account verifier number

type
required
string
Enum: "conta_corrente" "conta_poupanca" "conta_corrente_conjunta" "conta_poupanca_conjunta"

Account type

metaData
any
object
transferDay
required
string

Day when the partner will be paid. It depends on the transfer_interval - if it's daily, send 1. If it's weekly, it can be from 1 (Monday) to 5 (Friday). If it's monthly, it can be from 1 to 31. Additionally, if it's daily and the provider is Pagarme, the value is 0

transferEnabled
required
boolean

Determines whether transfers are authorized to occur or not

transferInterval
required
string
Enum: "daily" "weekly" "monthly"

Interval between transfers

automaticAnticipationEnabled
boolean

Indicates whether the receiver will receive automatic advances

anticipatableVolumePercentage
string

Indicates the percentage of the volume eligible for advancement to the receiver

automaticAnticipationType
string

Indicates the type of automatic advancement that will be configured for the receiver's account

automaticAnticipationDays
string

Indicates the number of days for automatic advancement

automaticAnticipation1025Delay
string

Indicates the number of days that will be disregarded in the calculation of the eligible advancement amount. The counting of days is done backwards from the day of advancement

Response samples

Content type
application/json
Example
{
}

Consulting a receiver through paginated listing

Authorizations:
query Parameters
id
string <uuid>

Seller identifier

email
string

Seller's email

status
string

Seller status

limit
number

Limit of items returned in the query

page
number

Query pages

Responses

Response Schema: application/json
merchantId
string

Merchant identification

object
name
required
string

Recipient's name

email
required
string

Recipient's email

phoneNumber
required
string

Recipient's contact phone

birthdate
required
string

Recipient's date of birth in ISO-Date format, e.g., 1996-01-31

required
object
type
required
string

Type of document, consult supported types table

number
required
string

Document number formatted according to the selected type

country
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Issuing country of the document, ISO 3166-1 alpha-2 standard, consult supported types table

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Number where the address is located

complement
string

Complement where the address is located, if applicable

zipCode
required
string

Postal code ZIP code

country
required
string
Default: "BR"
Enum: "AL" "AD" "AR" "AT" "AU" "BA" "BZ" "BE" "BG" "BR" "BY" "CA" "CU" "CY" "CZ" "CH" "CL" "CN" "CO" "CR" "DE" "DK" "DO" "EC" "EE" "SV" "GT" "FI" "FR" "GB" "GR" "HR" "HK" "HU" "IS" "ID" "IE" "IN" "IL" "IT" "LI" "LT" "LU" "LV" "MK" "MC" "MD" "MT" "MU" "JP" "KR" "MX" "ME" "MY" "NL" "NZ" "NO" "PY" "PE" "PK" "PL" "PT" "RU" "RO" "SM" "RS" "SE" "SG" "TH" "TW" "TR" "SI" "SK" "ES" "UY" "UA" "US" "VE" "VN" "ZA"

Country where the address is located - ISO 3166-1 alpha-2 standard

state
required
string

State where the address is located

city
required
string

City where the address is located

district
required
string

Neighborhood where the address is located

object
name
required
string

Recipient establishment name

phoneNumber
required
string

Recipient establishment contact phone

email
required
string

Recipient establishment email

website
string

Recipient establishment website

description
required
string

Recipient establishment description

facebook
string

Recipient establishment Facebook

twitter
string

Recipient establishment Twitter

openingDate
required
string

Recipient establishment opening date in ISO-Date format, e.g., 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa