Binco Backend B2B API (0.0.1)
Download OpenAPI specification:Download
Binco Backend B2B API
Get merchant countries
Retrieve the countries where the merchant can operate, and details about the payment methods available in each country.
Authorizations:
Responses
Response samples
- 200
- 401
- 500
{- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "countries": [
- {
- "country": "ARG",
- "currencies": [
- "ARS"
], - "vat": [
- 0
], - "paymentMethods": [
- {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}
]
}
]
}Get merchant country details
Retrieve the requested country, and details about the payment methods available in it if available.
Authorizations:
path Parameters
| countryCode required | string (Country) Enum: "ARG" "BRA" "URY" The country code of the country |
Responses
Response samples
- 200
- 401
- 404
- 500
{- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "countries": [
- {
- "country": "ARG",
- "currencies": [
- "ARS"
], - "vat": [
- 0
], - "paymentMethods": [
- {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}
]
}
]
}Get merchant countries
Retrieve the countries where the merchant can operate, and details about the payment methods available in each country.
Authorizations:
path Parameters
| merchantId required | string <uuid> The id of the merchant |
Responses
Response samples
- 200
- 401
- 500
{- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "countries": [
- {
- "country": "ARG",
- "currencies": [
- "ARS"
], - "vat": [
- 0
], - "paymentMethods": [
- {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}
]
}
]
}Get merchant country details
Retrieve the requested country, and details about the payment methods available in it if available.
Authorizations:
path Parameters
| countryCode required | string (Country) Enum: "ARG" "BRA" "URY" The country code of the country |
| merchantId required | string <uuid> The id of the merchant |
Get payment intents
Returns the payment intents of the business
Authorizations:
Responses
Response samples
- 200
- 401
- 500
{- "data": [
- {
- "paymentIntentId": "581555e2-a6b3-491a-a53d-1889417293ca",
- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "type": "ECO",
- "externalReference": "externalReference123",
- "description": "Payment for order 123",
- "currency": "ARS",
- "amount": 100,
- "amountDetails": {
- "tip": 10,
- "vatAmount": 20
}, - "invoiceDetails": {
- "reference": "invoiceReference",
- "serie": "invoiceSerie",
- "number": 123
}, - "includeAllPaymentMethods": false,
- "paymentMethod": {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}, - "availablePaymentMethods": [
- {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}
], - "status": {
- "code": "PAYMENT_METHOD_PENDING",
- "description": "The payment is pending."
}, - "createdAt": "string",
- "nextAction": {
- "type": "REDIRECT",
- "redirect": {
- "reference": "1025a9bb-3d83-4fba-af77-7a03305cf798"
}
}
}
], - "pagination": {
- "currentPage": 0,
- "pageSize": 0,
- "totalItems": 0,
- "totalPages": 0
}
}Create payment intent
Create payment intent for the specified merchant.
Authorizations:
Request Body schema: application/jsonrequired
Payment intent request data
| merchantId | string <uuid> |
| type | string (PaymentIntentType) Value: "ECO" |
| externalReference | string |
| description | string |
| countryCode | string (Country) Enum: "ARG" "BRA" "URY" |
| currency | string (Currency) Enum: "ARS" "BRL" "CLP" "COP" "MXN" "PEN" "PYG" "USD" "UYU" |
| amount | number |
object | |
object | |
| includeAllPaymentMethods | boolean |
object (PaymentMethodRequestInfo) | |
| redirectUrl | string |
Responses
Request samples
- Payload
{- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "type": "ECO",
- "externalReference": "externalReference123",
- "description": "Payment for order 123",
- "countryCode": "ARG",
- "currency": "ARS",
- "amount": 100,
- "amountDetails": {
- "tip": 10,
- "vatAmount": 20
}, - "invoiceDetails": {
- "reference": "invoiceReference",
- "serie": "invoiceSerie",
- "number": 123
}, - "includeAllPaymentMethods": false,
- "paymentMethods": {
- "name": "CREDIT_CARD",
- "options": {
- "networks": [
- "VISA"
]
}
},
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "paymentIntentId": "581555e2-a6b3-491a-a53d-1889417293ca",
- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "type": "ECO",
- "externalReference": "externalReference123",
- "description": "Payment for order 123",
- "currency": "ARS",
- "amount": 100,
- "amountDetails": {
- "tip": 10,
- "vatAmount": 20
}, - "invoiceDetails": {
- "reference": "invoiceReference",
- "serie": "invoiceSerie",
- "number": 123
}, - "includeAllPaymentMethods": false,
- "paymentMethod": {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}, - "availablePaymentMethods": [
- {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}
], - "status": {
- "code": "PAYMENT_METHOD_PENDING",
- "description": "The payment is pending."
}, - "createdAt": "string",
- "nextAction": {
- "type": "REDIRECT",
- "redirect": {
- "reference": "1025a9bb-3d83-4fba-af77-7a03305cf798"
}
}
}Get payment intent details
Retrieve the requested payment intent.
Authorizations:
path Parameters
| paymentIntentId required | string <uuid> The id of the payment intent |
Responses
Response samples
- 200
- 401
- 404
- 500
{- "paymentIntentId": "581555e2-a6b3-491a-a53d-1889417293ca",
- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "type": "ECO",
- "externalReference": "externalReference123",
- "description": "Payment for order 123",
- "currency": "ARS",
- "amount": 100,
- "amountDetails": {
- "tip": 10,
- "vatAmount": 20
}, - "invoiceDetails": {
- "reference": "invoiceReference",
- "serie": "invoiceSerie",
- "number": 123
}, - "includeAllPaymentMethods": false,
- "paymentMethod": {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}, - "availablePaymentMethods": [
- {
- "name": "CREDIT_CARD",
- "currencies": [
- "ARS"
], - "options": {
- "networks": [
- "VISA"
]
}
}
], - "status": {
- "code": "PAYMENT_METHOD_PENDING",
- "description": "The payment is pending."
}, - "createdAt": "string",
- "nextAction": {
- "type": "REDIRECT",
- "redirect": {
- "reference": "1025a9bb-3d83-4fba-af77-7a03305cf798"
}
}
}