Skip to main content
API docs by Redocly

Binco Backend Payins API (0.0.1)

Download OpenAPI specification:Download

E-mail: integrations@binco.io License: Apache 2.0

Binco Backend Payins API

Merchant

Get merchants

Retrieve a list of merchants

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a merchant

Retrieve the requested merchant

Authorizations:
B2BAuthUserAuth
path Parameters
merchantId
required
string <uuid>

The id of the merchant

Responses

Response samples

Content type
application/json
{
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "type": "SOLE_PROPRIETORSHIP_CORPORATION",
  • "merchantName": "string",
  • "phone": "string",
  • "taxIdNumber": "string",
  • "fantasyName": "string",
  • "email": "string",
  • "webSite": "string",
  • "dateOfFoundation": "2019-08-24T14:15:22Z",
  • "monthlyLoad": 0,
  • "monthlyLoadUsd": 0,
  • "monthlyTpvUsd": 0,
  • "averageTransactionUsd": 0,
  • "averageAnnualBilling": 0,
  • "status": "ONBOARDING",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "metadata": "string",
  • "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
  • "accountCurrencies": "string",
  • "transfersType": "L2L",
  • "apiKey": "string",
  • "apiSecret": "string",
  • "account": {
    }
}

Update a merchant

Update data of the requested merchant

Authorizations:
B2BAuthUserAuth
path Parameters
merchantId
required
string <uuid>

The id of the merchant

Request Body schema: application/json
required

General information data about merchant

object (Account)
merchantName
string <= 128 characters
transfersType
string (TransfersType)
Enum: "L2L" "CROSSBORDER"
email
string <= 128 characters
phone
string <= 128 characters
object (AddressRequest)
metadata
string
currencies
Array of strings (Currency)
Items Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU"
countryProcessorsId
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "merchantName": "string",
  • "transfersType": "L2L",
  • "email": "string",
  • "phone": "string",
  • "address": {
    },
  • "metadata": "string",
  • "currencies": [
    ],
  • "countryProcessorsId": [
    ]
}

Response samples

Content type
application/json
{
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "type": "SOLE_PROPRIETORSHIP_CORPORATION",
  • "merchantName": "string",
  • "phone": "string",
  • "taxIdNumber": "string",
  • "fantasyName": "string",
  • "email": "string",
  • "webSite": "string",
  • "dateOfFoundation": "2019-08-24T14:15:22Z",
  • "monthlyLoad": 0,
  • "monthlyLoadUsd": 0,
  • "monthlyTpvUsd": 0,
  • "averageTransactionUsd": 0,
  • "averageAnnualBilling": 0,
  • "status": "ONBOARDING",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "metadata": "string",
  • "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
  • "accountCurrencies": "string",
  • "transfersType": "L2L",
  • "apiKey": "string",
  • "apiSecret": "string",
  • "account": {
    }
}

Delete a merchant

Delete the requested merchant

Authorizations:
B2BAuthUserAuth
path Parameters
merchantId
required
string <uuid>

The id of the merchant

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Unauthorized",
  • "showMessage": {
    },
  • "needUpdate": false,
  • "errorId": "Auth:UNAUTHORIZED"
}

Get the payment methods

Get the payment methods related to a merchant

Authorizations:
B2BAuthUserAuth
path Parameters
merchantId
required
string <uuid>

The id of the merchant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get merchant configuration

Get merchant configuration

Authorizations:
B2BAuthUserAuth
path Parameters
merchantId
required
string <uuid>

The id of the merchant

Responses

Response samples

Content type
application/json
{
  • "merchantConfigurationId": "23a163bd-f146-44b2-af3d-6a8027cf9eb8",
  • "paymentSuccessNotification": true,
  • "paymentErrorNotification": true,
  • "notificationEmails": [
    ],
  • "shortName": "string",
  • "fastPaymentsEnabled": true,
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "merchantCountryConfigurations": [
    ]
}

Create or update configuration for a merchant

Create or update configuration for a merchant

Authorizations:
B2BAuthUserAuth
path Parameters
merchantId
required
string <uuid>

The id of the merchant

Request Body schema: application/json
required
shortName
string
notificationEmails
Array of strings
paymentSuccessNotification
boolean
paymentErrorNotification
boolean
fastPaymentsEnabled
boolean
Array of objects (MerchantCountryConfigurationsRequest)

Responses

Request samples

Content type
application/json
{
  • "shortName": "string",
  • "notificationEmails": [
    ],
  • "paymentSuccessNotification": true,
  • "paymentErrorNotification": true,
  • "fastPaymentsEnabled": true,
  • "merchantCountryConfigurations": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error updating merchant configuration",
  • "showMessage": {
    },
  • "needUpdate": false,
  • "errorId": "Payins:ERROR_IN_UPDATE_MERCHANT_CONFIGURATION"
}

Get country processor

Get country processors related to a merchant

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Merchant country processors

Create a relationship between a merchant and a payment processors in a country

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json
required

MerchantCountryProcessors data

countryProcessorsId
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "countryProcessorsId": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the available payment methods

Get the available payment methods

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get merchant public data by short name

Get merchant public data by short name

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
{
  • "fantasyName": "string"
}

Payer

Get payers

Retrieve a list of payers

Authorizations:
B2BAuthUserAuth
query Parameters
searchTerm
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a payer

Create a payer (is the one who will make the payment)

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json

General information data about payer

firstName
string <= 128 characters
lastName
string <= 128 characters
documentType
string (DocumentType)
Enum: "PASSPORT" "IDENTITY_DOCUMENT" "DNI"
document
string <= 128 characters
email
string <= 128 characters
merchantId
string <uuid>
object (AddressRequest)
phone
string <= 128 characters
country
string (CountryCode)
Enum: "URY" "ARG"

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "documentType": "PASSPORT",
  • "document": "string",
  • "email": "string",
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "address": {
    },
  • "phone": "string",
  • "country": "URY"
}

Response samples

Content type
application/json
{
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "firstName": "string",
  • "lastName": "string",
  • "documentType": "PASSPORT",
  • "documentNumber": "string",
  • "email": "string",
  • "phone": "string",
  • "address": {
    },
  • "businessId": "string",
  • "merchantId": "string"
}

Get a payer

Retrieve the requested payer

Authorizations:
B2BAuthUserAuth
path Parameters
payerId
required
string <uuid>

The id of the payer

Responses

Response samples

Content type
application/json
{
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "firstName": "string",
  • "lastName": "string",
  • "documentType": "PASSPORT",
  • "documentNumber": "string",
  • "email": "string",
  • "phone": "string",
  • "address": {
    },
  • "businessId": "string",
  • "merchantId": "string"
}

Update a payer

Update data of the requested payer

Authorizations:
B2BAuthUserAuth
path Parameters
payerId
required
string <uuid>

The id of the payer

Request Body schema: application/json
required

General information data about payer

merchantExternalId
string <uuid>
email
string <= 128 characters
object (AddressRequest)
phone
string <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "merchantExternalId": "12af4bd4-95fd-4a43-96a6-3bc3b636add9",
  • "email": "string",
  • "address": {
    },
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "firstName": "string",
  • "lastName": "string",
  • "documentType": "PASSPORT",
  • "documentNumber": "string",
  • "email": "string",
  • "phone": "string",
  • "address": {
    },
  • "businessId": "string",
  • "merchantId": "string"
}

Delete a payer

Delete the requested payer

Authorizations:
B2BAuthUserAuth
path Parameters
payerId
required
string <uuid>

The id of the payer

Responses

Response samples

Content type
application/json
{
  • "message": "Error deleting payer",
  • "showMessage": {
    },
  • "needUpdate": false,
  • "errorId": "Payins:ERROR_IN_DELETE_PAYER"
}

Get payer's payment instruments

Retrieve a list of payer's payment instruments

Authorizations:
B2BAuthUserAuth
path Parameters
payerId
required
string <uuid>

The id of the payer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payment intent

Create a payment intent

Create a payment intent with an option to create a payment instrument and charge it automatically

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json
required

General information data about payment intent, if paymentInstrumentData is sent and paymentInstrumentId is not, tries to create paymentInstrument and after charge it

Any of
currency
required
string (Currency)
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU"
amount
required
number
payinType
required
string (PayinType)
Enum: "DEFAULT" "TRANSFER"
merchantId
string <uuid>
externalReference
required
string <= 128 characters
paymentInstrumentId
string <uuid>
object (PaymentInstrumentExpressCheckoutRequest)
confirm
boolean
payerId
required
string <uuid>
object (PayerRequest)
setupFutureUsage
boolean
offSession
required
boolean
object (PaymentIntentMetadata)
invoiceNumber
required
number
description
string
tipAmount
number
country
required
string (CountryCode)
Enum: "URY" "ARG"
vatPercentage
number

Responses

Request samples

Content type
application/json
{
  • "currency": "ARS",
  • "amount": 0,
  • "payinType": "DEFAULT",
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "externalReference": "string",
  • "paymentInstrumentId": "3b4a1779-70a8-48c5-b92b-066d36bc41a3",
  • "paymentInstrumentData": {
    },
  • "confirm": true,
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "payerData": {
    },
  • "setupFutureUsage": true,
  • "offSession": true,
  • "metadata": {
    },
  • "invoiceNumber": 0,
  • "description": "string",
  • "tipAmount": 0,
  • "country": "URY",
  • "vatPercentage": 0
}

Response samples

Content type
application/json
{
  • "paymentIntent": {
    },
  • "confirmationMethod": "MANUAL",
  • "status": "REQUIRES_PAYMENT_INSTRUMENT",
  • "nextAction": "string"
}

Create a fast payment intent

Create a fast payment intent using the default vatPercentage configured to the country

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json
required

General information data about payment intent

amount
number
currency
string (Currency)
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU"
comment
string
paymentInstrumentTypeName
string (PaymentInstrumentType)
Enum: "CREDIT_CARD" "DEBIT_CARD" "PREPAID_CARD" "CASH" "BANK_TRANSFER" "A2A" "PIX" "WALLETS" "CRYPTO"
paymentMethodName
string (PaymentMethod)
Enum: "VISA" "MASTER_CARD" "AMERICAN_EXPRESS" "OCA" "SANTANDER" "HSBC" "BBVA" "ITAU" "SCOTIABANK" "BROU" "PIX" "APPLE_PAY" "GOOGLE_WALLET" "MERCADO_PAGO"
merchantShortName
string
countryCode
string (CountryCode)
Enum: "URY" "ARG"
object (PaymentIntentAdditionalInfo)

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "currency": "ARS",
  • "comment": "string",
  • "paymentInstrumentTypeName": "CREDIT_CARD",
  • "paymentMethodName": "VISA",
  • "merchantShortName": "string",
  • "countryCode": "URY",
  • "paymentIntentAdditionalInfo": {
    }
}

Response samples

Content type
application/json
{
  • "paymentIntent": {
    },
  • "confirmationMethod": "MANUAL",
  • "status": "REQUIRES_PAYMENT_INSTRUMENT",
  • "nextAction": "string"
}

Get payment intent

Retrieve a payment intent

Authorizations:
B2BAuthUserAuth
path Parameters
paymentIntentId
required
string <uuid>

The id of the paymentIntent

Responses

Response samples

Content type
application/json
{
  • "paymentIntentId": "8a86594b-ac91-4146-aa27-ff5b5bb4a688",
  • "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "paymentInstrumentId": "3b4a1779-70a8-48c5-b92b-066d36bc41a3",
  • "payinType": "DEFAULT",
  • "paymentIntentStatus": "REQUIRES_PAYMENT_INSTRUMENT",
  • "lastPaymentError": "string",
  • "externalReference": "string",
  • "externalChargeId": "string",
  • "externalInvoiceId": "string",
  • "invoiceEmail": "string",
  • "description": "string",
  • "currency": "ARS",
  • "subtotalAmount": 0,
  • "taxAmount": 0,
  • "tipAmount": 0,
  • "totalAmount": 0,
  • "receivedAmount": 0,
  • "confirmationInstrument": 0,
  • "nextAction": 0,
  • "statementDescriptor": 0,
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "receiptEmail": "string",
  • "setupFutureUsage": "string",
  • "metadata": "string",
  • "linkId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "exchangeRate": 0
}

Get the payment methods of a payment intent

Retrieve the payment methods of a payment intent

Authorizations:
B2BAuthUserAuth
path Parameters
paymentIntentId
required
string <uuid>

The id of the paymentIntent

Responses

Response samples

Content type
application/json
{
  • "paymentIntentAvailablePaymentMethods": [
    ],
  • "paymentData": {
    }
}

Initialize payment b2b with the provided payment method

Initialize payment b2b with the provided payment method

Authorizations:
B2BAuthUserAuth
path Parameters
paymentIntentId
required
string <uuid>

The id of the paymentIntent

Request Body schema: application/json
required

Request to initialize a payment intent B2B

countryProcessorId
string <uuid>
object (PaymentIntentAdditionalInfo)

Responses

Request samples

Content type
application/json
{
  • "countryProcessorId": "685ca12c-ce55-492d-b3e4-072897260dd6",
  • "paymentIntentAdditionalInfo": {
    }
}

Response samples

Content type
application/json
{
  • "paymentIntent": {
    },
  • "gatewayReferenceId": "string",
  • "gatewayUrl": "string"
}

Refund a payment intent

Refund a payment intent

Authorizations:
B2BAuthUserAuth
path Parameters
paymentIntentId
required
string <uuid>

The id of the paymentIntent

Request Body schema: application/json
required

Request to refund the payment intent, if empty the refund will be total

requestedRefundAmount
number

Responses

Request samples

Content type
application/json
{
  • "requestedRefundAmount": 0
}

Response samples

Content type
application/json
Example
{
  • "message": "Unauthorized",
  • "showMessage": {
    },
  • "needUpdate": false,
  • "errorId": "Auth:UNAUTHORIZED"
}

Refund a payment intent (manual refund)

Refund a payment intent (manual refund)

Authorizations:
B2BAuthUserAuth
path Parameters
paymentIntentId
required
string <uuid>

The id of the paymentIntent

Request Body schema: application/json
required

Request to refund the payment intent

requestedRefundAmount
number
status
string
Enum: "MANUAL_REFUND_PENDING" "MANUAL_REFUND_CONFIRMED"

Responses

Request samples

Content type
application/json
{
  • "requestedRefundAmount": 0,
  • "status": "MANUAL_REFUND_PENDING"
}

Response samples

Content type
application/json
{
  • "paymentIntentId": "8a86594b-ac91-4146-aa27-ff5b5bb4a688",
  • "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "paymentInstrumentId": "3b4a1779-70a8-48c5-b92b-066d36bc41a3",
  • "payinType": "DEFAULT",
  • "paymentIntentStatus": "REQUIRES_PAYMENT_INSTRUMENT",
  • "lastPaymentError": "string",
  • "externalReference": "string",
  • "externalChargeId": "string",
  • "externalInvoiceId": "string",
  • "invoiceEmail": "string",
  • "description": "string",
  • "currency": "ARS",
  • "subtotalAmount": 0,
  • "taxAmount": 0,
  • "tipAmount": 0,
  • "totalAmount": 0,
  • "receivedAmount": 0,
  • "confirmationInstrument": 0,
  • "nextAction": 0,
  • "statementDescriptor": 0,
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "receiptEmail": "string",
  • "setupFutureUsage": "string",
  • "metadata": "string",
  • "linkId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "exchangeRate": 0
}

Payment instrument

Get payer's payment instruments

Retrieve a list of payer's payment instruments

Authorizations:
B2BAuthUserAuth
path Parameters
payerId
required
string <uuid>

The id of the payer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get payment instruments

Retrieve a list of payment instruments

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create payment instrument

Create payment instrument (it is possible to use existing or create one in this step)

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json
required

Payment instrument data

Any of
payerId
required
string <uuid>
object (PayerRequest)
paymentMethodName
required
string (PaymentMethod)
Enum: "VISA" "MASTER_CARD" "AMERICAN_EXPRESS" "OCA" "SANTANDER" "HSBC" "BBVA" "ITAU" "SCOTIABANK" "BROU" "PIX" "APPLE_PAY" "GOOGLE_WALLET" "MERCADO_PAGO"
countries
Array of strings
metadata
object
country
required
string (CountryCode)
Enum: "URY" "ARG"

Responses

Request samples

Content type
application/json
{
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "payerData": {
    },
  • "paymentMethodName": "VISA",
  • "countries": [
    ],
  • "metadata": { },
  • "country": "URY"
}

Response samples

Content type
application/json
{
  • "paymentInstrumentId": "3b4a1779-70a8-48c5-b92b-066d36bc41a3",
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "paymentInstrumentStatus": "string",
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "externalId": "string",
  • "active": true,
  • "validated": true,
  • "countries": "string",
  • "metadata": { },
  • "nextAction": "string"
}

Get payment instrument

Retrieve the requested payment instrument

Authorizations:
B2BAuthUserAuth
path Parameters
paymentInstrumentId
required
string <uuid>

The id of the payment instrument

Responses

Response samples

Content type
application/json
{
  • "paymentInstrumentId": "3b4a1779-70a8-48c5-b92b-066d36bc41a3",
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "payerId": "f612112b-802d-496d-9650-880c09cb2f34",
  • "paymentInstrumentStatus": "string",
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "externalId": "string",
  • "active": true,
  • "validated": true,
  • "countries": "string",
  • "metadata": { },
  • "nextAction": "string"
}

Get Links

Get Links

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Link

Create Link

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json
required

Create link data

amount
required
number <float>
vatPercentage
required
number
description
string
reference
string
currency
required
string (Currency)
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU"
merchantCountryProcessors
required
Array of strings <uuid> [ items <uuid > ]
country
required
string (CountryCode)
Enum: "URY" "ARG"
expirationDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "vatPercentage": 0,
  • "description": "string",
  • "reference": "string",
  • "currency": "ARS",
  • "merchantCountryProcessors": [
    ],
  • "country": "URY",
  • "expirationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
  • "description": "string",
  • "currency": "ARS",
  • "amount": 0,
  • "vatPercentage": 0,
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "used": true,
  • "paymentIntentId": "8a86594b-ac91-4146-aa27-ff5b5bb4a688",
  • "usedAt": "2019-08-24T14:15:22Z",
  • "linkCountryProcessors": [
    ]
}

Update Link

Update Link

Authorizations:
B2BAuthUserAuth
Request Body schema: application/json
required

Update link data

amount
number <float>
vatPercentage
number
description
string
reference
string
currency
string (Currency)
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU"
merchantCountryProcessors
Array of strings <uuid> [ items <uuid > ]
expirationDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "vatPercentage": 0,
  • "description": "string",
  • "reference": "string",
  • "currency": "ARS",
  • "merchantCountryProcessors": [
    ],
  • "expirationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
  • "description": "string",
  • "currency": "ARS",
  • "amount": 0,
  • "vatPercentage": 0,
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "used": true,
  • "paymentIntentId": "8a86594b-ac91-4146-aa27-ff5b5bb4a688",
  • "usedAt": "2019-08-24T14:15:22Z",
  • "linkCountryProcessors": [
    ]
}

Validate Link

Validate Link

Authorizations:
B2BAuthUserAuth
path Parameters
linkId
required
string

The id of the link

Responses

Response samples

Content type
application/json
{
  • "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
  • "description": "string",
  • "currency": "ARS",
  • "amount": 0,
  • "vatPercentage": 0,
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "used": true,
  • "paymentIntentId": "8a86594b-ac91-4146-aa27-ff5b5bb4a688",
  • "usedAt": "2019-08-24T14:15:22Z",
  • "linkCountryProcessors": [
    ]
}

Get Link

Get Link

Authorizations:
B2BAuthUserAuth
path Parameters
linkId
required
string

The id of the link

Responses

Response samples

Content type
application/json
{
  • "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
  • "description": "string",
  • "currency": "ARS",
  • "amount": 0,
  • "vatPercentage": 0,
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "used": true,
  • "paymentIntentId": "8a86594b-ac91-4146-aa27-ff5b5bb4a688",
  • "usedAt": "2019-08-24T14:15:22Z",
  • "linkCountryProcessors": [
    ]
}

Share Link

Share Link

Authorizations:
B2BAuthUserAuth
path Parameters
linkId
required
string

The id of the link

Request Body schema: application/json
required

Share link data

receiverEmail
required
string
receiverName
required
string

Responses

Request samples

Content type
application/json
{
  • "receiverEmail": "string",
  • "receiverName": "string"
}

Response samples

Content type
application/json
Example
{
  • "message": "Unauthorized",
  • "showMessage": {
    },
  • "needUpdate": false,
  • "errorId": "Auth:UNAUTHORIZED"
}

Delete a link

Delete the requested link

Authorizations:
B2BAuthUserAuth
path Parameters
linkId
required
string

The id of the link

Responses

Response samples

Content type
application/json
{
  • "message": "Error deleting link",
  • "showMessage": {
    },
  • "needUpdate": false,
  • "errorId": "Payins:ERROR_DELETING_LINK"
}

Payin

Get Payins

Retrieve a list of payins

Authorizations:
B2BAuthUserAuth
query Parameters
status
string (TransactionStatus)
Enum: "PENDING" "SCHEDULED" "APPROVED" "CANCELLED" "REJECTED" "EXPIRED"
currency
string (Currency)
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU"
minAmount
number
maxAmount
number
dateFrom
Date
dateUntil
Date
merchantId
string <uuid>
order
string (OrderBy)
Enum: "ASC" "DESC"
sort
string (SortBy)
Enum: "AMOUNT" "DATE" "STATUS"
page
number
limit
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Status Summary

get a summary of transactions

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
{
  • "pending": 0,
  • "successful": 0,
  • "failed": 0
}

Merchant country processors

Update merchant country processors

Update merchant country processors, it is possible to update the status of the relationship and the country processor

Authorizations:
B2BAuthUserAuth
path Parameters
merchantCountryProcessorId
required
string

The merchant country processor id

Request Body schema: application/json
required

Data to update the merchant country processor

countryProcessorId
string <uuid>
active
boolean

Responses

Request samples

Content type
application/json
{
  • "countryProcessorId": "685ca12c-ce55-492d-b3e4-072897260dd6",
  • "active": true
}

Response samples

Content type
application/json
{
  • "merchantCountryProcessorId": "eb691bb6-463d-43c9-ad41-f929ea22650f",
  • "countryProcessor": {
    },
  • "merchant": {
    },
  • "onboardingStatus": "ONBOARDING"
}

Business

Get business country processors

Get country processors related to a business

Authorizations:
B2BAuthUserAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]