Malga API Documentation (0.5)
Download OpenAPI specification:Download
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.
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 |
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 |
curl --location --request GET 'https://api.malga.io/v1/' \
--header 'X-Client-Id: <YOUR_CLIENT_ID>' \
--header 'X-Api-Key: <YOUR_SECRET_KEY>'
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 |
{- "scope": "customers",
- "expires": 0
}
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 |
{- "scope": "customers",
- "expires": 0,
- "clientId": "string",
- "publicKey": "string"
}
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
- Payload
{- "scope": [
- "tokens"
], - "expires": 31104000
}
Response samples
- 201
- 400
- 500
{- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "publicKey": "<YOUR_PUBLIC_KEY>",
- "scope": [
- "tokens"
], - "expires": 31104000,
- "createdAt": "20200110 00:00:00"
}
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": "JOSE DAS NEVES",
- "cardNumber": "4019598346009339",
- "cardCvv": "123",
- "cardExpirationDate": "12/2026"
}
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
|
Responses
Request samples
- Payload
- Python
{- "cardHolderName": "JOSE DAS NEVES",
- "cardNumber": "4019598346009339",
- "cardCvv": "123",
- "cardExpirationDate": "12/2026"
}
Response samples
- 201
- 400
- 500
{- "tokenId": "cc0b1e41-2936-45c5-947f-93995ffcdc00"
}
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",
- "expirationMonth": "string",
- "expirationYear": "string",
- "brand": "American Express",
- "cvvChecked": true,
- "fingerprint": "string",
- "first6digits": "string",
- "last4digits": "string",
- "status": "failed",
- "createdAt": "string",
- "updatedAt": "string",
- "customer": {
- "id": "string",
- "createdAt": "string",
- "clientId": "string",
- "name": "string",
- "email": "string",
- "phoneNumber": "string",
- "document": {
- "type": "string",
- "number": "string",
- "country": "AL"
}, - "address": {
- "street": "string",
- "streetNumber": "string",
- "complement": "string",
- "zipCode": "string",
- "country": "AL",
- "state": "string",
- "city": "string",
- "district": "string"
}
}
}
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
- Payload
- Python
{- "tokenId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "merchantId": "cc4945bc-85f4-495e-adc6-3b281c9d957a",
- "cvvCheck": true
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "status": "active",
- "statusReason": null,
- "createdAt": "2012-08-11T19:02:56.713Z",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "brand": "Visa",
- "cardHolderName": "JOAO DA SILVA",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "expirationMonth": "12",
- "expirationYear": "2026",
- "transactionRequests": [
- {
- "id": "edd0d86a-76d0-4c2c-b924-1528510a5a32",
- "createdAt": "2023-09-25T18:09:59.001Z",
- "providerId": "5ce68ed3-2213-423b-8eaf-9d8c4b40df2b",
- "providerType": "SANDBOX",
- "requestStatus": "success",
- "requestType": "zero_dollar",
- "responseTs": "32ms"
}
]
}
List cards
Authorizations:
query Parameters
page | string page number |
limit | string total itens per page |
Responses
Response Schema: application/json
object (MetaPagination) | |||||||||||
| |||||||||||
items | array (Card) |
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "expirationMonth": "12",
- "expirationYear": "2026",
- "brand": "Visa",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "status": "active"
}
]
}
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 | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "status": "active",
- "statusReason": null,
- "createdAt": "2012-08-11T19:02:56.713Z",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "brand": "Visa",
- "cardHolderName": "JOAO DA SILVA",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "expirationMonth": "12",
- "expirationYear": "2026",
- "transactionRequests": [
- {
- "id": "edd0d86a-76d0-4c2c-b924-1528510a5a32",
- "createdAt": "2023-09-25T18:09:59.001Z",
- "providerId": "5ce68ed3-2213-423b-8eaf-9d8c4b40df2b",
- "providerType": "SANDBOX",
- "requestStatus": "success",
- "requestType": "zero_dollar",
- "responseTs": "32ms"
}
]
}
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 | ||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "name": "Customer test",
- "email": "jose2@gmail.com",
- "phoneNumber": "21 98889999099",
- "document": {
- "number": "97055503019",
- "type": "cpf",
- "country": "BR"
}, - "address": {
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon",
- "zipCode": "25650011",
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203"
}
}
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) | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object (Customer) | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "name": "Customer test",
- "email": "jose2@gmail.com",
- "phoneNumber": "21 98889999099",
- "document": {
- "number": "97055503019",
- "type": "cpf",
- "country": "BR"
}, - "address": {
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon",
- "zipCode": "25650011",
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203"
}
}
]
}
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 | ||||||||||||||||
string email do usuario | |||||||||||||||||
phoneNumber | string telefones de contato do usuario | ||||||||||||||||
object | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "id": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "name": "Customer test",
- "email": "jose2@gmail.com",
- "document": {
- "number": "97055503019",
- "type": "cpf",
- "country": "BR"
}, - "phoneNumber": "21 98889999099",
- "address": {
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon",
- "zipCode": "25650011",
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203"
}
}
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 | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "name": "string",
- "phoneNumber": "string",
- "address": {
- "street": "string",
- "streetNumber": "string",
- "complement": "string",
- "zipCode": "string",
- "country": "AL",
- "state": "string",
- "city": "string",
- "district": "string"
}
}
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
- Payload
{- "cardId": "82aba896-9e37-45b6-aa90-d510c9050596"
}
List customer cards
Authorizations:
path Parameters
customer_id required | string Customer ID |
Responses
Response Schema: application/json
object (MetaPagination) | |||||||||||
| |||||||||||
items | array (Card) |
Response samples
- 200
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "expirationMonth": "12",
- "expirationYear": "2026",
- "brand": "Visa",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "status": "active"
}
]
}
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Created date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Updated date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for fraud analysis | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) or SourceTypeCardCvv (object) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for fraud analysis, required by provider's anti-fraud | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SplitRules) [ items ] Additional parameters for transacting with Split | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional fields for use in conditionals of smart flows | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
threeDSecure2 | object Additional parameters for transacting with 3D Secure 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Information about charge traceability | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}, - "merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
- "amount": 150,
- "currency": "BRL",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
List charges
Authorizations:
query Parameters
page | string page number |
limit | string total itens per page |
Responses
Response Schema: application/json
object (MetaPaginationCache) | |||||||||||
| |||||||||||
items | array (Charge) |
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
]
}
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Created date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Updated date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for fraud analysis | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Created date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Updated date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for fraud analysis | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "status": "charged_back"
}
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Created date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Updated date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for fraud analysis | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "status": "approved"
}
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
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
- Payload
{- "amount": 150
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
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
- Payload
{- "amount": 150
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
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.
- Create a
session
informing the minimum required data - Using the
publicKey
returned by the creation or got by the details endpoint onX-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
| |||||||||||
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
| |||||||||||
createdAt | string Created date | ||||||||||
updatedAt | string Updated date | ||||||||||
publicKey | string Access key with limited scope, must be used to pay the session |
{- "id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "name": "Nome da sessão",
- "status": "created",
- "isActive": true,
- "clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "orderId": null,
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
- "dueDate": "2022-10-25T09:28:45.000Z",
- "description": "Promoção Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "paymentMethods": [
- {
- "paymentType": "credit",
- "installments": 1
}
], - "items": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "name": "Item 1",
- "description": "Descrição do item",
- "unitPrice": 10000,
- "quantity": 1,
- "tangible": false
}
], - "createdAt": "2022-10-25T09:28:45.000Z",
- "updatedAt": "2022-10-25T09:28:45.000Z",
- "publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1"
}
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
| |||||||||||
required | Array of objects (SessionItemObject) [ items ] Order items | ||||||||||
Array
|
Responses
Request samples
- Payload
{- "amount": 100,
- "isActive": true,
- "createLink": true,
- "capture": true,
- "merchantId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "dueDate": "2022-10-25T09:28:45.000Z",
- "description": "Promoção Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
]
}
Response samples
- 201
{- "id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
- "name": "Pedido 1",
- "status": "created",
- "isActive": true,
- "clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
- "orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
- "dueDate": "2022-10-26T19:32:08.000Z",
- "description": "Pedido Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
], - "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "createdAt": "2022-10-25T22:49:06.588Z",
- "updatedAt": "2022-10-25T22:49:06.588Z",
- "publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}
Response samples
- 201
{- "id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
- "name": "Pedido 1",
- "status": "created",
- "isActive": true,
- "clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
- "orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
- "dueDate": "2022-10-26T19:32:08.000Z",
- "description": "Pedido Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
], - "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "createdAt": "2022-10-25T22:49:06.588Z",
- "updatedAt": "2022-10-25T22:49:06.588Z",
- "publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for fraud analysis, required by provider's anti-fraud | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional parameters for transacting with Split | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}
}
Response samples
- 201
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "description": "Descrição longa da cobrança",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "originalAmount": 150,
- "currency": "BRL",
- "statementDescriptor": "LOJA JOAO",
- "status": "pending",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
]
}
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 | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
required | object | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
required | object | ||||||||||||||||||||||||||||||||||||||||||||||
|
{- "merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
- "owner": {
- "name": "Seller test",
- "email": "seller@gmail.com",
- "phoneNumber": "21 98889999099",
- "birthdate": "27-01-1995",
- "document": {
- "type": "cpf",
- "number": "36243319067",
- "country": "BR"
}, - "address": {
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203",
- "zipCode": "25650011",
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon"
}
}, - "business": {
- "name": "Seller business test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "27-01-1995",
- "address": {
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "country": "BR",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "type": "cnpj",
- "number": "94938591000196",
- "country": "BR"
}
}, - "mcc": 4040,
- "bankAccount": {
- "holderName": "Seller Name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "12",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "transferDay": 5,
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}
}
Create new seller
Authorizations:
Request Body schema: application/json
merchantId | string Merchant identification | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
mcc | string Merchant segment code at the acquirer | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
metaData | any | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
- "owner": {
- "name": "Seller test",
- "email": "seller@gmail.com",
- "phoneNumber": "21 98889999099",
- "birthdate": "27-01-1995",
- "document": {
- "type": "cpf",
- "number": "36243319067",
- "country": "BR"
}, - "address": {
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203",
- "zipCode": "25650011",
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon"
}
}, - "business": {
- "name": "Seller business test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "27-01-1995",
- "address": {
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "country": "BR",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "type": "cnpj",
- "number": "94938591000196",
- "country": "BR"
}
}, - "mcc": 4040,
- "bankAccount": {
- "holderName": "Seller Name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "12",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "transferDay": 5,
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}
}
Response samples
- 201
- 400
- 500
{- "id": "19d05a45-0e92-478e-8366-955231bcf3d6",
- "providers": {
- "providerType": "SANDBOX",
- "externalId": "1966811",
- "externalStatus": "active",
- "externalStatusReason": "ok",
- "status": "pending",
- "createdAt": "2022-12-21T23:10:13.498Z",
- "updatedAt": "2022-12-21T20:10:13.951Z"
}, - "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "clientid": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
- "metadata": null,
- "owner": {
- "id": "8231ba21-3758-4bd7-b664-5b5fdeda37a0",
- "updatedAt": "2023-07-11T23:02:51.581Z",
- "createdAt": "2023-07-11T23:02:51.581Z",
- "name": "Seller",
- "email": "seller@email.com",
- "phoneNumber": "85988350264",
- "birthdate": "1995-01-27T02:00:00.000Z",
- "address": {
- "country": "BR",
- "id": "883631f0-fea0-4682-ae1a-f4ac6349e0d9",
- "updatedAt": "2023-07-11T23:02:51.585Z",
- "createdAt": "2023-07-11T23:02:51.585Z",
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "casa 4",
- "zipCode": "61000-320",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "country": "BR",
- "id": "32543bbe-42c1-4000-9b68-d01a2735708e",
- "updatedAt": "2023-07-11T23:02:51.588Z",
- "createdAt": "2023-07-11T23:02:51.588Z",
- "type": "cpf",
- "number": "36243319067"
}
}, - "business": {
- "id": "607bb56a-974a-4d1d-9f56-cda865dfafbd",
- "updatedAt": "2023-07-11T23:02:51.571Z",
- "createdAt": "2023-07-11T23:02:51.571Z",
- "name": "Seller business",
- "phoneNumber": "85988350264",
- "email": "seller@email.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "1995-01-27",
- "address": {
- "country": "BR",
- "id": "b681dd2e-ebdb-4fad-8c8b-e703a17825ce",
- "updatedAt": "2023-07-11T23:02:51.574Z",
- "createdAt": "2023-07-11T23:02:51.574Z",
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "country": "BR",
- "id": "b9380f2c-a657-4f47-a7da-21f3bf08182c",
- "updatedAt": "2023-07-11T23:02:51.578Z",
- "createdAt": "2023-07-11T23:02:51.578Z",
- "type": "cnpj",
- "number": "94938591000196"
}
}, - "bankAccount": {
- "id": "f7ac3221-8f69-4276-b88b-34ddbe5ec24a",
- "updatedAt": "2023-07-11T23:02:51.563Z",
- "createdAt": "2023-07-11T23:02:51.563Z",
- "holderName": "Seller name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "22",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "id": "a04bca24-f7d1-4cb5-acce-41f12680e5bf",
- "updatedAt": "2023-07-11T23:02:51.567Z",
- "createdAt": "2023-07-11T23:02:51.567Z",
- "transferDay": "5",
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}, - "mcc": 4040,
- "status": "active"
}
Querying a recipient by ID
Authorizations:
path Parameters
id required | string <uuid> Seller identifier |
Responses
Response Schema: application/json
merchantId | string Merchant identification | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
mcc | string Merchant segment code at the acquirer | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
metaData | any | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
{- "id": "19d05a45-0e92-478e-8366-955231bcf3d6",
- "providers": {
- "providerType": "SANDBOX",
- "externalId": "1966811",
- "externalStatus": "active",
- "externalStatusReason": "ok",
- "status": "pending",
- "createdAt": "2022-12-21T23:10:13.498Z",
- "updatedAt": "2022-12-21T20:10:13.951Z"
}, - "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "clientid": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
- "metadata": null,
- "owner": {
- "id": "8231ba21-3758-4bd7-b664-5b5fdeda37a0",
- "updatedAt": "2023-07-11T23:02:51.581Z",
- "createdAt": "2023-07-11T23:02:51.581Z",
- "name": "Seller",
- "email": "seller@email.com",
- "phoneNumber": "85988350264",
- "birthdate": "1995-01-27T02:00:00.000Z",
- "address": {
- "country": "BR",
- "id": "883631f0-fea0-4682-ae1a-f4ac6349e0d9",
- "updatedAt": "2023-07-11T23:02:51.585Z",
- "createdAt": "2023-07-11T23:02:51.585Z",
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "casa 4",
- "zipCode": "61000-320",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "country": "BR",
- "id": "32543bbe-42c1-4000-9b68-d01a2735708e",
- "updatedAt": "2023-07-11T23:02:51.588Z",
- "createdAt": "2023-07-11T23:02:51.588Z",
- "type": "cpf",
- "number": "36243319067"
}
}, - "business": {
- "id": "607bb56a-974a-4d1d-9f56-cda865dfafbd",
- "updatedAt": "2023-07-11T23:02:51.571Z",
- "createdAt": "2023-07-11T23:02:51.571Z",
- "name": "Seller business",
- "phoneNumber": "85988350264",
- "email": "seller@email.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "1995-01-27",
- "address": {
- "country": "BR",
- "id": "b681dd2e-ebdb-4fad-8c8b-e703a17825ce",
- "updatedAt": "2023-07-11T23:02:51.574Z",
- "createdAt": "2023-07-11T23:02:51.574Z",
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "country": "BR",
- "id": "b9380f2c-a657-4f47-a7da-21f3bf08182c",
- "updatedAt": "2023-07-11T23:02:51.578Z",
- "createdAt": "2023-07-11T23:02:51.578Z",
- "type": "cnpj",
- "number": "94938591000196"
}
}, - "bankAccount": {
- "id": "f7ac3221-8f69-4276-b88b-34ddbe5ec24a",
- "updatedAt": "2023-07-11T23:02:51.563Z",
- "createdAt": "2023-07-11T23:02:51.563Z",
- "holderName": "Seller name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "22",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "id": "a04bca24-f7d1-4cb5-acce-41f12680e5bf",
- "updatedAt": "2023-07-11T23:02:51.567Z",
- "createdAt": "2023-07-11T23:02:51.567Z",
- "transferDay": "5",
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}, - "mcc": 4040,
- "status": "active"
}
Consulting a receiver through paginated listing
Authorizations:
query Parameters
id | string <uuid> Seller identifier |
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 | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
|